Skip to Content Skip to Search

module ActionMailer::MailHelper

Action Mailer MailHelper

Provides helper methods for ActionMailer::Base that can be used for easily formatting messages, accessing mailer or message instances, and the attachments list.

Public instance methods

attachments()

Permalink

Access the message attachments list.

Source code GitHub 
# File actionmailer/lib/action_mailer/mail_helper.rb, line 45
def attachments
  mailer.attachments
end

block_format(text)

Permalink

Take the text and format it, indented two spaces for each line, and wrapped at 72 columns:

text = <<-TEXT
  This is
  the      paragraph.

  * item1 * item2
TEXT

block_format text
# => "  This is the paragraph.\n\n  * item1\n  * item2\n"
Source code GitHub 
# File actionmailer/lib/action_mailer/mail_helper.rb, line 22
def block_format(text)
  formatted = text.split(/\n\r?\n/).collect { |paragraph|
    format_paragraph(paragraph)
  }.join("\n\n")

  # Make list points stand on their own line
  formatted.gsub!(/[ ]*([*]+) ([^*]*)/) { "  #{$1} #{$2.strip}\n" }
  formatted.gsub!(/[ ]*([#]+) ([^#]*)/) { "  #{$1} #{$2.strip}\n" }

  formatted
end

format_paragraph(text, len = 72, indent = 2)

Permalink

Returns text wrapped at len columns and indented indent spaces. By default column length len equals 72 characters and indent indent equal two spaces.

my_text = 'Here is a sample text with more than 40 characters'

format_paragraph(my_text, 25, 4)
# => "    Here is a sample text with\n    more than 40 characters"
Source code GitHub 
# File actionmailer/lib/action_mailer/mail_helper.rb, line 57
def format_paragraph(text, len = 72, indent = 2)
  sentences = [[]]

  text.split.each do |word|
    if sentences.first.present? && (sentences.last + [word]).join(" ").length > len
      sentences << [word]
    else
      sentences.last << word
    end
  end

  indentation = " " * indent
  sentences.map! { |sentence|
    "#{indentation}#{sentence.join(' ')}"
  }.join "\n"
end

mailer()

Permalink

Access the mailer instance.

Source code GitHub 
# File actionmailer/lib/action_mailer/mail_helper.rb, line 35
def mailer
  @_controller
end

message()

Permalink

Access the message instance.

Source code GitHub 
# File actionmailer/lib/action_mailer/mail_helper.rb, line 40
def message
  @_message
end

Definition files