module ActionMailer::MailHelper - actionmailer-3.2.22 Documentation

# module ActionMailer::MailHelper

### Public Instance Methods

attachments() click to toggle source

Access the message attachments list.

    # File lib/action_mailer/mail_helper.rb, line 28
    def attachments
      @_message.attachments
    end

block_format(text) click to toggle source

Uses Text::Format to take the text and format it, indented two spaces for each line, and wrapped at 72 columns.

    # File lib/action_mailer/mail_helper.rb, line 5
    def block_format(text)
      formatted = text.split(/\n\r\n/).collect { |paragraph|
        format_paragraph(paragraph)
      }.join("\n")

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

      formatted
    end

format_paragraph(text, len = 72, indent = 2) click to toggle source

Returns `text` wrapped at `len` columns and indented `indent` spaces.

### Examples¶ ↑

    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"

    # File lib/action_mailer/mail_helper.rb, line 40
    def format_paragraph(text, len = 72, indent = 2)
      sentences = [[]]

      text.split.each do |word|
        if (sentences.last + [word]).join(' ').length > len
          sentences << [word]
        else
          sentences.last << word
        end
      end

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

mailer() click to toggle source

Access the mailer instance.

    # File lib/action_mailer/mail_helper.rb, line 18
    def mailer
      @_controller
    end

message() click to toggle source

Access the message instance.

    # File lib/action_mailer/mail_helper.rb, line 23
    def message
      @_message
    end