class ActionMailer::Base

filenames) this variable controls how the parts are ordered.
(i.e. multiple parts are assembled from templates which specify the content type in their
to set the default :parts_order. Parts Order is used when a message is built implicitly
* default_implicit_parts_order - This is now deprecated, use the default method above
to set the default :mime_version.
* default_mime_version - This is now deprecated, use the default method above
to set the default :content_type.
* default_content_type - This is now deprecated, use the default method above
set the default :charset.
* default_charset - This is now deprecated, use the default method above to
delivery_method :test. Most useful for unit and functional testing.
* deliveries - Keeps an array of all the emails sent out through the Action Mailer with
be turned off to aid in functional testing.
call .deliver on an mail message or on an Action Mailer method. This is on by default but can
* perform_deliveries - Determines whether emails are actually sent from Action Mailer when you
implement for a custom delivery agent.
object eg. MyOwnDeliveryMethodClass.new. See the Mail gem documentation on the interface you need to
:sendmail, :test, and :file. Or you may provide a custom delivery method
* delivery_method - Defines a delivery method. Possible values are :smtp (default),
* raise_delivery_errors - Whether or not errors should be raised if the email fails to be delivered.
tmp/mails.
* :location - The directory into which emails will be written. Defaults to the application
* file_settings - Allows you to override options for the :file delivery method.
added automatically before the message is sent.
* :arguments - The command line arguments. Defaults to -i -t with -f sender@address
* :location - The location of the sendmail executable. Defaults to /usr/sbin/sendmail.
* sendmail_settings - Allows you to override options for the :sendmail delivery method.
constant (OpenSSL::SSL::VERIFY_NONE, OpenSSL::SSL::VERIFY_PEER,…).
of an OpenSSL verify constant (‘none’, ‘peer’, ‘client_once’,‘fail_if_no_peer_cert’) or directly the
really useful if you need to validate a self-signed and/or a wildcard certificate. You can use the name
* :openssl_verify_mode - When using TLS, you can set how OpenSSL checks the certificate. This is
and starts to use it.
* :enable_starttls_auto - When set to true, detects if STARTTLS is enabled in your SMTP server
information and a cryptographic Message Digest 5 algorithm to hash important information)
send password Base64 encoded) or :cram_md5 (combines a Challenge/Response mechanism to exchange
This is a symbol and one of :plain (will send the password in the clear), :login (will
authentication type here.
* :authentication - If your mail server requires authentication, you need to specify the
* :password - If your mail server requires authentication, set the password in this setting.
* :user_name - If your mail server requires authentication, set the username in this setting.
* :domain - If you need to specify a HELO domain, you can do it here.
* :port - On the off chance that your mail server doesn’t run on port 25, you can change it.
“localhost” setting.
* :address - Allows you to use a remote mail server. Just change it from its default
* smtp_settings - Allows detailed configuration for :smtp delivery method:
Can be set to nil for no logging. Compatible with both Ruby’s own Logger and Log4r loggers.
* logger - the logger is used for generating information on the mailing run if available.
per the above section.
* default - You can pass this in at a class level as well as within the class itself as
ActionMailer::Base.raise_delivery_errors = true
These options are specified on the class level, like
= Configuration options
mailer method, it will get over written by the mailer method.
set something in the defaults using a proc, and then set the same thing inside of your
Note that the proc is evaluated right at the start of the mail message generation, so if you
end
end
’some complex call’
def my_method
private
default ‘X-Special-Header’ => Proc.new { my_method }
class Notifier < ActionMailer::Base
can define methods that evaluate as the message is being generated:
Finally, Action Mailer also supports passing Proc objects into the default hash, so you
end
:content_description => ‘This is a description’
default ‘Content-Transfer-Encoding’ => ‘7bit’,
class Notifier < ActionMailer::Base
an underscored symbol, so the following will work:
As you can pass in any header, you need to either quote the header as a string, or pass it in as
but Action Mailer translates them appropriately and sets the correct values.
parts_order and charset are not actually valid Mail::Message header fields,
* :parts_order => [ "text/plain", "text/enriched", "text/html" ]
* :content_type => "text/plain",
* :charset => "UTF-8",
* :mime_version => "1.0"
ActionMailer::Base sets the following:
You can pass in any header value that a Mail::Message accepts. Out of the box,
end
default :sender => ‘system@example.com’
class Notifier < ActionMailer::Base
default method inside the class definition:
Action Mailer provides some intelligent defaults for your emails, these are usually specified in a
= Default Hash
in Mail::Message instance.
the delivery agents. Your object should make any needed modifications directly to the passed
called before the email is sent, allowing you to make modifications to the email before it hits
An interceptor object must implement the :delivering_email(message) method which will be
called once for every email sent after the email has been sent.
An observer object must implement the :delivered_email(message) method which will be
register objects that are called during the mail delivery life cycle.
Action Mailer provides hooks into the Mail observer and interceptor methods. These allow you to
= Observing and Intercepting Mails
<%= image_tag attachments.url, :alt => ‘Our Photo’, :class => ‘photo’ -%>
<h1>Please Don’t Cringe</h1>
As we are using Action View’s image_tag method, you can pass in any other options you want:
<%= image_tag attachments.url -%>
<h1>Please Don’t Cringe</h1>
url on the attachment to get the relative content id path for the image source:
make a call to image_tag passing in the attachment you want to display and then call
And then to reference the image in the view, you create a welcome.html.erb file and
end
end
mail(:to => recipient, :subject => “Here is what we look like”)<br>attachments.inline = File.read(‘path/to/photo.png’)
def welcome(recipient)
class ApplicationMailer < ActionMailer::Base
if you want to display a corporate logo or a photo.
You can also specify that a file should be displayed inline with other HTML. This is useful
= Inline Attachments
with the filename free_book.pdf.
and the second being a application/pdf with a Base64 encoded copy of the file.pdf book
the first part being a multipart/alternative with the text and HTML email parts inside,
template in the view directory), send a complete multipart/mixed email with two parts,
Which will (if it had both a welcome.text.plain.erb and welcome.text.html.erb
end
end
mail(:to => recipient, :subject => “New account information”)<br>attachments = File.read(‘path/to/file.pdf’)
def welcome(recipient)
class ApplicationMailer < ActionMailer::Base
Sending attachment in emails is easy:
= Attachments
to multipart/alternative.
This means that you’ll have to manually add each part to the email and set the content type of the email
Implicit template rendering is not performed if any attachments or parts have been added to the email.
body. The same instance variables defined in the action are passed to all email templates.
which indicates that the email contains multiple different representations of the same email
type. The content type for the entire message is automatically set to multipart/alternative,
Each would be rendered and added as a separate part to the message, with the corresponding content
* signup_notification.text.yaml.erb
* signup_notification.text.xml.builder
* signup_notification.text.html.erb
* signup_notification.text.plain.erb
For example, if the following templates exist:
by the content type. Each such detected template will be added as separate part to the message.
detect and use multipart templates, where each template is named after the name of the action, followed
Multipart messages can also be used implicitly because Action Mailer will automatically
= Multipart Emails
You never instantiate your mailer class. Rather, you just call the method you defined on the class itself.
mail.deliver # sends the email
mail = Notifier.welcome(david) # => a Mail::Message object
Notifier.welcome(david).deliver # sends the email
for delivery later:
Once a mailer action and template are defined, you can deliver your message or create it and save it
= Sending mail
:host option isn’t explicitly provided.
generated because the url_for view helper will, by default, generate relative URLs when a
:only_path => false option when using url_for. This will ensure that absolute URLs are
If you do decide to set a default :host for your mailers you want to use the
option mentioned above to set the default host.
Setting ActionMailer::Base.default_url_options directly is now deprecated, use the configuration
config.action_mailer.default_url_options = { :host => “example.com” }
option as a configuration option in config/application.rb:
It is also possible to set a default host that will be used in all mailers by setting the :host
make sense to generate relative URLs in email messages.
You want to avoid using the name_of_route_path form of named routes because it doesn’t
<%= users_url(:host => “example.com”) %>
When using named routes you only need to supply the :host:
<%= url_for(:host => “example.com”, :controller => “welcome”, :action => “greeting”) %>
When using url_for you’ll need to provide the :host, :controller, and :action:
to provide all of the details needed to generate a URL.
Action Pack, the mailer instance doesn’t have any context about the incoming request, so you’ll need
URLs can be generated in mailer views using url_for or named routes. Unlike controllers from
= Generating URLs
<%= truncate(@note.body, 25) %>
You got a new note from <%= message.from %>!
If you need to access the subject, from or the recipients in the view, you can do that through message object:
<%= truncate(@note.body, 25) %>
You got a new note!
You can even use Action Pack helpers in these views. For example:
Thanks for joining our service! Please check back often.
Hi <%= @account.name %>,
Emails by default are sent in plain text, so a sample view for our model example might look like this:
Variables defined in the model are accessible as instance variables in the view.
app/views/notifier/signup_notification.text.plain.erb would be used to generate the email.
name as the method in your mailer model. For example, in the mailer defined above, the template at
To define a template to be used with a mailing, create an .erb file with the same
method of the class looks for a template with its name.
Like Action Controller, each mailer class has a corresponding view directory in which each
= Mailer views
end
format.html { render “some_other_template” }
format.text
mail(:to => user.email) do |format|
Or even to render a special view:
end
format.html
format.text(:content_transfer_encoding => “base64”)
mail(:to => user.email) do |format|
The block syntax is also useful in providing information specific to a part:
end
format.html
format.text
mail(:to => user.email) do |format|
If you want to explicitly render only certain templates, pass a block:
file as well as the welcome.text.html.erb view file in a multipart/alternative email.
the same name as the method, so the above action would send the welcome.text.plain.erb view
The mail method, if not passed a block, will inspect your views and send all the views with
will accept (any valid Email header including optional fields).
The hash passed to the mail method allows you to specify any header that a Mail::Message
* mail - Allows you to specify email to be sent.
as headers({'X-No-Spam' => 'True', 'In-Reply-To' => '1234@message.id'})
* headers(hash) - Allows you to specify multiple headers in your email such
another field of the same name.
you need to set it to nil first so that Mail knows you are replacing it and not adding
can appear multiple times. If you want to change a field that can appear multiple times,
From: can only appear once in an email header, other fields like X-Anything
as headers['X-No-Spam'] = 'True'. Note, while most fields like To:
* headers[]= - Allows you to specify any header field in your email such
in the same manner as attachments[]=
* attachments.inline[]= - Allows you to add an inline attachment to your email
manner; attachments['filename.png'] = File.read('path/to/filename.png')
* attachments[]= - Allows you to add attachments to your email in an intuitive
Within the mailer method, you have access to the following methods:
end
end
:bcc => [“bcc@example.com”, “Order Watcher <watcher@example.com>”])
mail(:to => recipient.email_address_with_name,
@account = recipient
def welcome(recipient)
:return_path => ‘system@example.com’
default :from => ‘no-reply@example.com’,
class Notifier < ActionMailer::Base
Examples:
change options on the mail, or to add attachments.
within the model which are then used to set variables to be used in the mail template, to
The generated model inherits from ActionMailer::Base. Emails are defined by creating methods
$ rails generate mailer Notifier
To use Action Mailer, you need to create a mailer model.
= Mailer Models
Action Mailer allows you to send email from your application using a mailer model and views.
:nodoc:

def attachments


mail.attachments[0] # => Mail::Part (first attachment)
# or by index

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

You can also search for specific attachments:

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

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

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

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

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

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

Allows you to add attachments to an email, like so: 
def attachments
  @_message.attachments
end

def collect_responses_and_parts_order(headers) #:nodoc:

:nodoc: 
def collect_responses_and_parts_order(headers) #:nodoc:
  responses, parts_order = [], nil
  if block_given?
    collector = ActionMailer::Collector.new(lookup_context) { render(action_name) }
    yield(collector)
    parts_order = collector.responses.map { |r| r[:content_type] }
    responses  = collector.responses
  elsif headers[:body]
    responses << {
      :body => headers.delete(:body),
      :content_type => self.class.default[:content_type] || "text/plain"
    }
  else
    templates_path = headers.delete(:template_path) || self.class.mailer_name
    templates_name = headers.delete(:template_name) || action_name
    each_template(templates_path, templates_name) do |template|
      self.formats = template.formats
      responses << {
        :body => render(:template => template),
        :content_type => template.mime_type.to_s
      }
    end
  end
  [responses, parts_order]
end

def create_parts_from_responses(m, responses) #:nodoc:

:nodoc: 
def create_parts_from_responses(m, responses) #:nodoc:
  if responses.size == 1 && !m.has_attachments?
    responses[0].each { |k,v| m[k] = v }
  elsif responses.size > 1 && m.has_attachments?
    container = Mail::Part.new
    container.content_type = "multipart/alternative"
    responses.each { |r| insert_part(container, r, m.charset) }
    m.add_part(container)
  else
    responses.each { |r| insert_part(m, r, m.charset) }
  end
end

def default(value = nil) 

def default(value = nil)
  self.default_params = default_params.merge(value).freeze if value
  default_params
end

def default_i18n_subject #:nodoc:

:nodoc:
humanized version of the action_name.
If it does not find a translation for the +subject+ under the specified scope it will default to a
Translates the +subject+ using Rails I18n class under [:actionmailer, mailer_scope, action_name] scope. 
def default_i18n_subject #:nodoc:
  mailer_scope = self.class.mailer_name.gsub('/', '.')
  I18n.t(:subject, :scope => [mailer_scope, action_name], :default => action_name.humanize)
end

def deliver_mail(mail) #:nodoc:

:nodoc:
and passing a Mail::Message will do nothing except tell the logger you sent the email.
when you call :deliver on the Mail::Message, calling +deliver_mail+ directly
method is actually called by the Mail::Message object itself through a callback
Wraps an email delivery inside of Active Support Notifications instrumentation. This 
def deliver_mail(mail) #:nodoc:
  ActiveSupport::Notifications.instrument("deliver.action_mailer") do |payload|
    self.set_payload_for_mail(payload, mail)
    yield # Let Mail do the delivery actions
  end
end

def each_template(paths, name, &block) #:nodoc:

:nodoc: 
def each_template(paths, name, &block) #:nodoc:
  templates = lookup_context.find_all(name, Array.wrap(paths))
  templates.uniq_by { |t| t.formats }.each(&block)
end

def headers(args=nil)

X-Special-Domain-Specific-Header: SecretValue

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

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

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

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

which will add them to itself.
Allows you to pass random and unusual headers to the new +Mail::Message+ object 
def headers(args=nil)
  if args
    @_message.headers(args)
  else
    @_message
  end
end

def initialize(method_name=nil, *args)

method, for instance).
remain uninitialized (useful when you only need to invoke the "receive"
will be initialized according to the named method. If not, the mailer will
Instantiate a new mailer object. If +method_name+ is not +nil+, the mailer 
def initialize(method_name=nil, *args)
  super()
  @_message = Mail.new
  process(method_name, *args) if method_name
end

def insert_part(container, response, charset) #:nodoc:

:nodoc: 
def insert_part(container, response, charset) #:nodoc:
  response[:charset] ||= charset
  part = Mail::Part.new(response)
  container.add_part(part)
end

def mail(headers={}, &block)


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

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

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

end
format.html { render :text => "

Hello Mikel!

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

You can even render text directly without using a template:

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

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

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

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

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

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

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

For example:

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

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

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

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

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

* :date - The date to say the email was sent on.
* :reply_to - Who to set the Reply-To header of the email to.
addresses, or an array of addresses.
* :bcc - Who you would like to Blind-Carbon-Copy on this email, can be a string of
or an array of addresses.
* :cc - Who you would like to Carbon-Copy on this email, can be a string of addresses,
* :from - Who the message is from
of addresses.
* :to - Who the message is destined for, can be a string of addresses, or an array
humanized version of the action_name
[:actionmailer, mailer_scope, action_name] or if this is missing, will translate the
ask the Rails I18n class for a translated :subject in the scope of
* :subject - The subject of the message, if this is omitted, Action Mailer will

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

two ways to call this method, with a block, or without a block.
The main method that creates the message and renders the email templates. There are 
def mail(headers={}, &block)
  # Guard flag to prevent both the old and the new API from firing
  # Should be removed when old API is removed
  @mail_was_called = true
  m = @_message
  # At the beginning, do not consider class default for parts order neither content_type
  content_type = headers[:content_type]
  parts_order  = headers[:parts_order]
  # Call all the procs (if any)
  default_values = self.class.default.merge(self.class.default) do |k,v|
    v.respond_to?(:call) ? v.bind(self).call : v
  end
  # Handle defaults
  headers = headers.reverse_merge(default_values)
  headers[:subject] ||= default_i18n_subject
  # Apply charset at the beginning so all fields are properly quoted
  m.charset = charset = headers[:charset]
  # Set configure delivery behavior
  wrap_delivery_behavior!(headers.delete(:delivery_method))
  # Assign all headers except parts_order, content_type and body
  assignable = headers.except(:parts_order, :content_type, :body, :template_name, :template_path)
  assignable.each { |k, v| m[k] = v }
  # Render the templates and blocks
  responses, explicit_order = collect_responses_and_parts_order(headers, &block)
  create_parts_from_responses(m, responses)
  # Setup content type, reapply charset and handle parts order
  m.content_type = set_content_type(m, content_type, headers[:content_type])
  m.charset      = charset
  if m.multipart?
    parts_order ||= explicit_order || headers[:parts_order]
    m.body.set_sort_order(parts_order)
    m.body.sort_parts!
  end
  m
end

def mailer_name 

def mailer_name
  @mailer_name ||= name.underscore
end

def mailer_name 

def mailer_name
  self.class.mailer_name
end

def method_missing(method, *args) #:nodoc:

:nodoc: 
def method_missing(method, *args) #:nodoc:
  return super unless respond_to?(method)
  new(method, *args).message
end

def process(*args) #:nodoc:

:nodoc: 
def process(*args) #:nodoc:
  lookup_context.skip_default_locale!
  super
end

def receive(raw_mail)

end
end
...
def receive(mail)
class MyMailer < ActionMailer::Base

method that accepts the raw email string as a parameter:
process incoming messages, you'll need to implement a +receive+
object's +receive+ method. If you want your mailer to be able to
instantiates a new mailer, and passes the email object to the mailer
Receives a raw email, parses it into an email object, decodes it, 
def receive(raw_mail)
  ActiveSupport::Notifications.instrument("receive.action_mailer") do |payload|
    mail = Mail.new(raw_mail)
    set_payload_for_mail(payload, mail)
    new.receive(mail)
  end
end

def register_interceptor(interceptor)

it will be constantized.
Either a class or a string can be passed in as the Observer. If a string is passed in
Register an Inteceptor which will be called before mail is sent. 
def register_interceptor(interceptor)
  delivery_interceptor = (interceptor.is_a?(String) ? interceptor.constantize : interceptor)
  Mail.register_interceptor(delivery_interceptor)
end

def register_interceptors(*interceptors)

Register one or more Interceptors which will be called before mail is sent. 
def register_interceptors(*interceptors)
  interceptors.flatten.compact.each { |interceptor| register_interceptor(interceptor) }
end

def register_observer(observer)

it will be constantized.
Either a class or a string can be passed in as the Observer. If a string is passed in
Register an Observer which will be notified when mail is delivered. 
def register_observer(observer)
  delivery_observer = (observer.is_a?(String) ? observer.constantize : observer)
  Mail.register_observer(delivery_observer)
end

def register_observers(*observers)

Register one or more Observers which will be notified when mail is delivered. 
def register_observers(*observers)
  observers.flatten.compact.each { |observer| register_observer(observer) }
end

def respond_to?(method, include_private = false) #:nodoc:

:nodoc: 
def respond_to?(method, include_private = false) #:nodoc:
  super || action_methods.include?(method.to_s)
end

def set_content_type(m, user_content_type, class_default) 

def set_content_type(m, user_content_type, class_default)
  params = m.content_type_parameters || {}
  case
  when user_content_type.present?
    user_content_type
  when m.has_attachments?
    if m.attachments.detect { |a| a.inline? }
      ["multipart", "related", params]
    else
      ["multipart", "mixed", params]
    end
  when m.multipart?
    ["multipart", "alternative", params]
  else
    m.content_type || class_default
  end
end

def set_payload_for_mail(payload, mail) #:nodoc:

:nodoc: 
def set_payload_for_mail(payload, mail) #:nodoc:
  payload[:mailer]     = name
  payload[:message_id] = mail.message_id
  payload[:subject]    = mail.subject
  payload[:to]         = mail.to
  payload[:from]       = mail.from
  payload[:bcc]        = mail.bcc if mail.bcc.present?
  payload[:cc]         = mail.cc  if mail.cc.present?
  payload[:date]       = mail.date
  payload[:mail]       = mail.encoded
end