Parent

Included Modules

Files

ActionMailer::Base

Action Mailer allows you to send email from your application using a mailer model and views.

Mailer Models

To use Action Mailer, you need to create a mailer model.

  $ rails generate mailer Notifier

The generated model inherits from ActionMailer::Base. Emails are defined by creating methods within the model which are then used to set variables to be used in the mail template, to change options on the mail, or to add attachments.

Examples:

 class Notifier < ActionMailer::Base
   default :from => 'no-reply@example.com',
           :return_path => 'system@example.com'

   def welcome(recipient)
     @account = recipient
     mail(:to => recipient.email_address_with_name,
          :bcc => ["bcc@example.com", "Order Watcher <watcher@example.com>"])
     end
   end

Within the mailer method, you have access to the following methods:

The hash passed to the mail method allows you to specify any header that a Mail::Message will accept (any valid Email header including optional fields).

The mail method, if not passed a block, will inspect your views and send all the views with the same name as the method, so the above action would send the welcome.text.plain.erb view file as well as the welcome.text.html.erb view file in a multipart/alternative email.

If you want to explicitly render only certain templates, pass a block:

  mail(:to => user.email) do |format|
    format.text
    format.html
  end

The block syntax is also useful in providing information specific to a part:

  mail(:to => user.email) do |format|
    format.text(:content_transfer_encoding => "base64")
    format.html
  end

Or even to render a special view:

  mail(:to => user.email) do |format|
    format.text
    format.html { render "some_other_template" }
  end

Mailer views

Like Action Controller, each mailer class has a corresponding view directory in which each method of the class looks for a template with its name.

To define a template to be used with a mailing, create an .erb file with the same name as the method in your mailer model. For example, in the mailer defined above, the template at app/views/notifier/signup_notification.text.plain.erb would be used to generate the email.

Variables defined in the model are accessible as instance variables in the view.

Emails by default are sent in plain text, so a sample view for our model example might look like this:

  Hi <%= @account.name %>,
  Thanks for joining our service! Please check back often.

You can even use Action Pack helpers in these views. For example:

  You got a new note!
  <%= truncate(@note.body, 25) %>

If you need to access the subject, from or the recipients in the view, you can do that through message object:

  You got a new note from <%= message.from %>!
  <%= truncate(@note.body, 25) %>

Generating URLs

URLs can be generated in mailer views using url_for or named routes. Unlike controllers from Action Pack, the mailer instance doesn’t have any context about the incoming request, so you’ll need to provide all of the details needed to generate a URL.

When using url_for you’ll need to provide the :host, :controller, and :action:

  <%= url_for(:host => "example.com", :controller => "welcome", :action => "greeting") %>

When using named routes you only need to supply the :host:

  <%= users_url(:host => "example.com") %>

You want to avoid using the name_of_route_path form of named routes because it doesn’t make sense to generate relative URLs in email messages.

It is also possible to set a default host that will be used in all mailers by setting the :host option as a configuration option in config/application.rb:

  config.action_mailer.default_url_options = { :host => "example.com" }

Setting ActionMailer::Base.default_url_options directly is now deprecated, use the configuration option mentioned above to set the default host.

If you do decide to set a default :host for your mailers you want to use the :only_path => false option when using url_for. This will ensure that absolute URLs are generated because the url_for view helper will, by default, generate relative URLs when a :host option isn’t explicitly provided.

Sending mail

Once a mailer action and template are defined, you can deliver your message or create it and save it for delivery later:

  Notifier.welcome(david).deliver # sends the email
  mail = Notifier.welcome(david)  # => a Mail::Message object
  mail.deliver                    # sends the email

You never instantiate your mailer class. Rather, you just call the method you defined on the class itself.

Multipart Emails

Multipart messages can also be used implicitly because Action Mailer will automatically detect and use multipart templates, where each template is named after the name of the action, followed by the content type. Each such detected template will be added as separate part to the message.

For example, if the following templates exist:

Each would be rendered and added as a separate part to the message, with the corresponding content type. The content type for the entire message is automatically set to multipart/alternative, which indicates that the email contains multiple different representations of the same email body. The same instance variables defined in the action are passed to all email templates.

Implicit template rendering is not performed if any attachments or parts have been added to the email. This means that you’ll have to manually add each part to the email and set the content type of the email to multipart/alternative.

Attachments

Sending attachment in emails is easy:

  class ApplicationMailer < ActionMailer::Base
    def welcome(recipient)
      attachments['free_book.pdf'] = File.read('path/to/file.pdf')
      mail(:to => recipient, :subject => "New account information")
    end
  end

Which will (if it had both a welcome.text.plain.erb and welcome.text.html.erb template in the view directory), send a complete multipart/mixed email with two parts, the first part being a multipart/alternative with the text and HTML email parts inside, and the second being a application/pdf with a Base64 encoded copy of the file.pdf book with the filename free_book.pdf.

Inline Attachments

You can also specify that a file should be displayed inline with other HTML. This is useful if you want to display a corporate logo or a photo.

  class ApplicationMailer < ActionMailer::Base
    def welcome(recipient)
      attachments.inline['photo.png'] = File.read('path/to/photo.png')
      mail(:to => recipient, :subject => "Here is what we look like")
    end
  end

And then to reference the image in the view, you create a welcome.html.erb file and make a call to image_tag passing in the attachment you want to display and then call url on the attachment to get the relative content id path for the image source:

  <h1>Please Don't Cringe</h1>

  <%= image_tag attachments['photo.png'].url -%>

As we are using Action View’s image_tag method, you can pass in any other options you want:

  <h1>Please Don't Cringe</h1>

  <%= image_tag attachments['photo.png'].url, :alt => 'Our Photo', :class => 'photo' -%>

Observing and Intercepting Mails

Action Mailer provides hooks into the Mail observer and interceptor methods. These allow you to register objects that are called during the mail delivery life cycle.

An observer object must implement the :delivered_email(message) method which will be called once for every email sent after the email has been sent.

An interceptor object must implement the :delivering_email(message) method which will be called before the email is sent, allowing you to make modifications to the email before it hits the delivery agents. Your object should make and needed modifications directly to the passed in Mail::Message instance.

Default Hash

Action Mailer provides some intelligent defaults for your emails, these are usually specified in a default method inside the class definition:

  class Notifier < ActionMailer::Base
    default :sender => 'system@example.com'
  end

You can pass in any header value that a Mail::Message, out of the box, ActionMailer::Base sets the following:

parts_order and charset are not actually valid Mail::Message header fields, but Action Mailer translates them appropriately and sets the correct values.

As you can pass in any header, you need to either quote the header as a string, or pass it in as an underscorised symbol, so the following will work:

  class Notifier < ActionMailer::Base
    default 'Content-Transfer-Encoding' => '7bit',
            :content_description => 'This is a description'
  end

Finally, Action Mailer also supports passing Proc objects into the default hash, so you can define methods that evaluate as the message is being generated:

  class Notifier < ActionMailer::Base
    default 'X-Special-Header' => Proc.new { my_method }

    private

      def my_method
        'some complex call'
      end
  end

Note that the proc is evaluated right at the start of the mail message generation, so if you set something in the defaults using a proc, and then set the same thing inside of your mailer method, it will get over written by the mailer method.

Configuration options

These options are specified on the class level, like ActionMailer::Base.template_root = "/my/templates"

Attributes

mailer_name[W]

Public Class Methods

default(value = nil) click to toggle source
     # File lib/action_mailer/base.rb, line 370
370:       def default(value = nil)
371:         self.default_params = default_params.merge(value).freeze if value
372:         default_params
373:       end
mailer_name() click to toggle source
     # File lib/action_mailer/base.rb, line 364
364:       def mailer_name
365:         @mailer_name ||= name.underscore
366:       end
new(method_name=nil, *args) click to toggle source

Instantiate a new mailer object. If method_name is not nil, the mailer will be initialized according to the named method. If not, the mailer will remain uninitialized (useful when you only need to invoke the “receive” method, for instance).

     # File lib/action_mailer/base.rb, line 438
438:     def initialize(method_name=nil, *args)
439:       super()
440:       @_message = Mail.new
441:       process(method_name, *args) if method_name
442:     end
receive(raw_mail) click to toggle source

Receives a raw email, parses it into an email object, decodes it, instantiates a new mailer, and passes the email object to the mailer object’s receive method. If you want your mailer to be able to process incoming messages, you’ll need to implement a receive method that accepts the raw email string as a parameter:

  class MyMailer < ActionMailer::Base
    def receive(mail)
      ...
    end
  end
     # File lib/action_mailer/base.rb, line 386
386:       def receive(raw_mail)
387:         ActiveSupport::Notifications.instrument("receive.action_mailer") do |payload|
388:           mail = Mail.new(raw_mail)
389:           set_payload_for_mail(payload, mail)
390:           new.receive(mail)
391:         end
392:       end

Public Instance Methods

attachments() click to toggle source

Allows you to add attachments to an email, like so:

 mail.attachments['filename.jpg'] = File.read('/path/to/filename.jpg')

If you do this, then Mail will take the file name and work out the mime type set the Content-Type, Content-Disposition, Content-Transfer-Encoding and base64 encode the contents of the attachment all for you.

You can also specify overrides if you want by passing a hash instead of a string:

 mail.attachments['filename.jpg'] = {:mime_type => 'application/x-gzip',
                                     :content => File.read('/path/to/filename.jpg')}

If you want to use a different encoding than Base64, you can pass an encoding in, but then it is up to you to pass in the content pre-encoded, and don’t expect Mail to know how to decode this data:

 file_content = SpecialEncode(File.read('/path/to/filename.jpg'))
 mail.attachments['filename.jpg'] = {:mime_type => 'application/x-gzip',
                                     :encoding => 'SpecialEncoding',
                                     :content => file_content }

You can also search for specific attachments:

 # By Filename
 mail.attachments['filename.jpg']   # => Mail::Part object or nil

 # or by index
 mail.attachments[0]                # => Mail::Part (first attachment)
     # File lib/action_mailer/base.rb, line 528
528:     def attachments
529:       @_message.attachments
530:     end
headers(args=nil) click to toggle source

Allows you to pass random and unusual headers to the new +Mail::Message+ object which will add them to itself.

  headers['X-Special-Domain-Specific-Header'] = "SecretValue"

You can also pass a hash into headers of header field names and values, which will then be set on the Mail::Message object:

  headers 'X-Special-Domain-Specific-Header' => "SecretValue",
          'In-Reply-To' => incoming.message_id

The resulting Mail::Message will have the following in it’s header:

  X-Special-Domain-Specific-Header: SecretValue
     # File lib/action_mailer/base.rb, line 490
490:     def headers(args=nil)
491:       if args
492:         DeprecatedHeaderProxy.new(@_message).headers(args)
493:       else
494:         DeprecatedHeaderProxy.new(@_message)
495:       end
496:     end
mail(headers={}, &block) click to toggle source

The main method that creates the message and renders the email templates. There are two ways to call this method, with a block, or without a block.

Both methods accept a headers hash. This hash allows you to specify the most used headers in an email message, these are:

  • :subject - The subject of the message, if this is omitted, Action Mailer will ask the Rails I18n class for a translated :subject in the scope of [:actionmailer, mailer_scope, action_name] or if this is missing, will translate the humanized version of the action_name

  • :to - Who the message is destined for, can be a string of addresses, or an array of addresses.

  • :from - Who the message is from

  • :cc - Who you would like to Carbon-Copy on this email, can be a string of addresses, or an array of addresses.

  • :bcc - Who you would like to Blind-Carbon-Copy on this email, can be a string of addresses, or an array of addresses.

  • :reply_to - Who to set the Reply-To header of the email to.

  • :date - The date to say the email was sent on.

You can set default values for any of the above headers (except :date) by using the default class method:

 class Notifier < ActionMailer::Base
   self.default :from => 'no-reply@test.lindsaar.net',
                :bcc => 'email_logger@test.lindsaar.net',
                :reply_to => 'bounces@test.lindsaar.net'
 end

If you need other headers not listed above, you can either pass them in as part of the headers hash or use the headers['name'] = value method.

When a :return_path is specified as header, that value will be used as the ‘envelope from’ address for the Mail message. Setting this is useful when you want delivery notifications sent to a different address than the one in :from. Mail will actually use the :return_path in preference to the :sender in preference to the :from field for the ‘envelope from’ value.

If you do not pass a block to the mail method, it will find all templates in the view paths using by default the mailer name and the method name that it is being called from, it will then create parts for each of these templates intelligently, making educated guesses on correct content type and sequence, and return a fully prepared Mail::Message ready to call :deliver on to send.

For example:

  class Notifier < ActionMailer::Base
    default :from => 'no-reply@test.lindsaar.net',

    def welcome
      mail(:to => 'mikel@test.lindsaar.net')
    end
  end

Will look for all templates at “app/views/notifier“ with name “welcome”. However, those can be customized:

  mail(:template_path => 'notifications', :template_name => 'another')

And now it will look for all templates at “app/views/notifications“ with name “another”.

If you do pass a block, you can render specific templates of your choice:

  mail(:to => 'mikel@test.lindsaar.net') do |format|
    format.text
    format.html
  end

You can even render text directly without using a template:

  mail(:to => 'mikel@test.lindsaar.net') do |format|
    format.text { render :text => "Hello Mikel!" }
    format.html { render :text => "<h1>Hello Mikel!</h1>" }
  end

Which will render a multipart/alternative email with text/plain and text/html parts.

The block syntax also allows you to customize the part headers if desired:

  mail(:to => 'mikel@test.lindsaar.net') do |format|
    format.text(:content_transfer_encoding => "base64")
    format.html
  end
     # File lib/action_mailer/base.rb, line 618
618:     def mail(headers={}, &block)
619:       # Guard flag to prevent both the old and the new API from firing
620:       # Should be removed when old API is removed
621:       @mail_was_called = true
622:       m = @_message
623: 
624:       # At the beginning, do not consider class default for parts order neither content_type
625:       content_type = headers[:content_type]
626:       parts_order  = headers[:parts_order]
627: 
628:       # Call all the procs (if any)
629:       default_values = self.class.default.merge(self.class.default) do |k,v|
630:         v.respond_to?(:call) ? v.bind(self).call : v
631:       end
632: 
633:       # Handle defaults
634:       headers = headers.reverse_merge(default_values)
635:       headers[:subject] ||= default_i18n_subject
636: 
637:       # Apply charset at the beginning so all fields are properly quoted
638:       m.charset = charset = headers[:charset]
639: 
640:       # Set configure delivery behavior
641:       wrap_delivery_behavior!(headers.delete(:delivery_method))
642: 
643:       # Assign all headers except parts_order, content_type and body
644:       assignable = headers.except(:parts_order, :content_type, :body, :template_name, :template_path)
645:       assignable.each { |k, v| m[k] = v }
646: 
647:       # Render the templates and blocks
648:       responses, explicit_order = collect_responses_and_parts_order(headers, &block)
649:       create_parts_from_responses(m, responses)
650: 
651:       # Setup content type, reapply charset and handle parts order
652:       m.content_type = set_content_type(m, content_type, headers[:content_type])
653:       m.charset      = charset
654: 
655:       if m.multipart?
656:         parts_order ||= explicit_order || headers[:parts_order]
657:         m.body.set_sort_order(parts_order)
658:         m.body.sort_parts!
659:       end
660: 
661:       m
662:     end

Protected Instance Methods

set_content_type(m, user_content_type, class_default) click to toggle source
     # File lib/action_mailer/base.rb, line 666
666:     def set_content_type(m, user_content_type, class_default)
667:       params = m.content_type_parameters || {}
668:       case
669:       when user_content_type.present?
670:         user_content_type
671:       when m.has_attachments?
672:         if m.attachments.detect { |a| a.inline? }
673:           ["multipart", "related", params]
674:         else
675:           ["multipart", "mixed", params]
676:         end
677:       when m.multipart?
678:         ["multipart", "alternative", params]
679:       else
680:         m.content_type || class_default
681:       end
682:     end

Disabled; run with --debug to generate this.

[Validate]

Generated with the Darkfish Rdoc Generator 1.1.6.