Module: ActionMailer::MailHelper

Defined in:
actionmailer/lib/action_mailer/mail_helper.rb

Overview

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

Instance Method Summary collapse

Instance Method Details

#attachments ⇒ Object

Access the message attachments list.



43
44
45
 
# File 'actionmailer/lib/action_mailer/mail_helper.rb', line 43

def attachments
  mailer.attachments
end

#block_format(text) ⇒ Object

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"



20
21
22
23
24
25
26
27
28
29
30
 
# File 'actionmailer/lib/action_mailer/mail_helper.rb', line 20

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) ⇒ Object

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"



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'actionmailer/lib/action_mailer/mail_helper.rb', line 55

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 ⇒ Object

Access the mailer instance.



33
34
35
 
# File 'actionmailer/lib/action_mailer/mail_helper.rb', line 33

def mailer
  @_controller
end

#message ⇒ Object

Access the message instance.



38
39
40
 
# File 'actionmailer/lib/action_mailer/mail_helper.rb', line 38

def message
  @_message
end