base.rb 29.3 KB
Newer Older
1
require 'mail'
2
require 'action_mailer/tmail_compat'
3
require 'action_mailer/collector'
J
Jeremy Kemper 已提交
4
require 'active_support/core_ext/array/wrap'
5
require 'active_support/core_ext/object/blank'
6
require 'active_support/core_ext/proc'
7

D
David Heinemeier Hansson 已提交
8
module ActionMailer #:nodoc:
P
Pratik Naik 已提交
9
  # Action Mailer allows you to send email from your application using a mailer model and views.
D
Initial  
David Heinemeier Hansson 已提交
10
  #
11
  # = Mailer Models
12
  #
P
Pratik Naik 已提交
13
  # To use Action Mailer, you need to create a mailer model.
14
  #
15
  #   $ rails generate mailer Notifier
16
  #
17
  # The generated model inherits from <tt>ActionMailer::Base</tt>. Emails are defined by creating methods
18 19
  # 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.
20 21 22 23
  #
  # Examples:
  #
  #  class Notifier < ActionMailer::Base
24 25
  #    default :from => 'no-reply@example.com',
  #            :return_path => 'system@example.com'
26
  #
27 28
  #    def welcome(recipient)
  #      @account = recipient
29 30
  #      mail(:to => recipient.email_address_with_name,
  #           :bcc => ["bcc@example.com", "Order Watcher <watcher@example.com>"])
31
  #      end
32
  #    end
33
  #
34
  # Within the mailer method, you have access to the following methods:
35
  #
36 37
  # * <tt>attachments[]=</tt> - Allows you to add attachments to your email in an intuitive
  #   manner; <tt>attachments['filename.png'] = File.read('path/to/filename.png')</tt>
38
  #
39 40 41 42 43 44
  # * <tt>headers[]=</tt> - Allows you to specify any header field in your email such
  #   as <tt>headers['X-No-Spam'] = 'True'</tt>. Note, while most fields (like <tt>To:</tt>
  #   <tt>From:</tt> can only appear once in an email header, other fields like <tt>X-Anything</tt>
  #   can appear multiple times. If you want to change a field that can appear multiple times,
  #   you need to set it to nil first so that Mail knows you are replacing it, not adding
  #   another field of the same name.)
45
  #
46 47 48
  # * <tt>headers(hash)</tt> - Allows you to specify multiple headers in your email such
  #   as <tt>headers({'X-No-Spam' => 'True', 'In-Reply-To' => '1234@message.id'})</tt>
  #
49
  # * <tt>mail</tt> - Allows you to specify your email to send.
50
  #
51
  # The hash passed to the mail method allows you to specify any header that a Mail::Message
52
  # will accept (any valid Email header including optional fields).
53 54
  #
  # The mail method, if not passed a block, will inspect your views and send all the views with
55 56
  # 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.
57
  #
58
  # If you want to explicitly render only certain templates, pass a block:
59
  #
60 61 62 63
  #   mail(:to => user.emai) do |format|
  #     format.text
  #     format.html
  #   end
64
  #
65 66 67 68 69 70 71
  # The block syntax is useful if also need to specify information specific to a part:
  #
  #   mail(:to => user.emai) do |format|
  #     format.text(:content_transfer_encoding => "base64")
  #     format.html
  #   end
  #
72
  # Or even to render a special view:
73 74 75 76 77 78
  #
  #   mail(:to => user.emai) do |format|
  #     format.text
  #     format.html { render "some_other_template" }
  #   end
  #
79 80
  # = Mailer views
  #
81 82
  # 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.
83
  #
84 85
  # To define a template to be used with a mailing, create an <tt>.erb</tt> file with the same
  # name as the method in your mailer model. For example, in the mailer defined above, the template at
86
  # <tt>app/views/notifier/signup_notification.text.plain.erb</tt> would be used to generate the email.
87 88 89 90 91 92 93 94
  #
  # 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.
  #
95 96 97
  # You can even use Action Pack helpers in these views. For example:
  #
  #   You got a new note!
98 99
  #   <%= truncate(@note.body, 25) %>
  #
100
  # If you need to access the subject, from or the recipients in the view, you can do that through message object:
101
  #
102
  #   You got a new note from <%= message.from %>!
103
  #   <%= truncate(@note.body, 25) %>
104
  #
105
  #
106
  # = Generating URLs
107
  #
108
  # URLs can be generated in mailer views using <tt>url_for</tt> or named routes. Unlike controllers from
109 110
  # 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.
111
  #
112
  # When using <tt>url_for</tt> you'll need to provide the <tt>:host</tt>, <tt>:controller</tt>, and <tt>:action</tt>:
113
  #
114
  #   <%= url_for(:host => "example.com", :controller => "welcome", :action => "greeting") %>
115
  #
116
  # When using named routes you only need to supply the <tt>:host</tt>:
117
  #
118 119
  #   <%= users_url(:host => "example.com") %>
  #
120 121
  # You will want to avoid using the <tt>name_of_route_path</tt> form of named routes because it doesn't
  # make sense to generate relative URLs in email messages.
122
  #
123 124
  # It is also possible to set a default host that will be used in all mailers by setting the <tt>:host</tt>
  # option in the <tt>ActionMailer::Base.default_url_options</tt> hash as follows:
125 126
  #
  #   ActionMailer::Base.default_url_options[:host] = "example.com"
127
  #
P
Pratik Naik 已提交
128
  # This can also be set as a configuration option in <tt>config/environment.rb</tt>:
129 130
  #
  #   config.action_mailer.default_url_options = { :host => "example.com" }
131
  #
132
  # If you do decide to set a default <tt>:host</tt> for your mailers you will want to use the
133 134 135
  # <tt>:only_path => false</tt> option when using <tt>url_for</tt>. This will ensure that absolute URLs are
  # generated because the <tt>url_for</tt> view helper will, by default, generate relative URLs when a
  # <tt>:host</tt> option isn't explicitly provided.
136 137 138
  #
  # = Sending mail
  #
139
  # Once a mailer action and template are defined, you can deliver your message or create it and save it
140 141
  # for delivery later:
  #
142 143 144
  #   Notifier.welcome(david).deliver # sends the email
  #   mail = Notifier.welcome(david)  # => a Mail::Message object
  #   mail.deliver                    # sends the email
145
  #
146
  # You never instantiate your mailer class. Rather, you just call the method you defined on the class itself.
147
  #
148
  # = Multipart Emails
149
  #
P
Pratik Naik 已提交
150
  # Multipart messages can also be used implicitly because Action Mailer will automatically
151 152
  # 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.
153
  #
154
  # For example, if the following templates existed:
155 156 157
  # * signup_notification.text.plain.erb
  # * signup_notification.text.html.erb
  # * signup_notification.text.xml.builder
158
  # * signup_notification.text.yaml.erb
159
  #
160 161 162 163
  # 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 <tt>multipart/alternative</tt>,
  # 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.
164
  #
165 166 167
  # 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 <tt>multipart/alternative</tt>.
168
  #
169
  # = Attachments
170
  #
171 172
  # You can see above how to make a multipart HTML / Text email, to send attachments is just
  # as easy:
173 174
  #
  #   class ApplicationMailer < ActionMailer::Base
175 176 177
  #     def welcome(recipient)
  #       attachments['free_book.pdf'] = { :data => File.read('path/to/file.pdf') }
  #       mail(:to => recipient, :subject => "New account information")
D
Initial  
David Heinemeier Hansson 已提交
178
  #     end
179
  #   end
180
  #
181 182 183 184 185
  # Which will (if it had both a <tt>welcome.text.plain.erb</tt> and <tt>welcome.text.html.erb</tt>
  # tempalte in the view directory), send a complete <tt>multipart/mixed</tt> email with two parts,
  # the first part being a <tt>multipart/alternative</tt> with the text and HTML email parts inside,
  # and the second being a <tt>application/pdf</tt> with a Base64 encoded copy of the file.pdf book
  # with the filename +free_book.pdf+.
D
David Heinemeier Hansson 已提交
186
  #
187
  # = Observing and Intercepting Mails
188
  #
189
  # Action Mailer provides hooks into the Mail observer and interceptor methods.  These allow you to
190
  # register objects that are called during the mail delivery life cycle.
191
  #
192 193
  # An observer object must implement the <tt>:delivered_email(message)</tt> method which will be
  # called once for every email sent after the email has been sent.
194
  #
195 196 197 198
  # An interceptor object must implement the <tt>:delivering_email(message)</tt> 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.
199
  #
200
  # = Default Hash
201
  #
202
  # Action Mailer provides some intelligent defaults for your emails, these are usually specified in a
203
  # default method inside the class definition:
204
  #
205 206 207
  #   class Notifier < ActionMailer::Base
  #     default :sender => 'system@example.com'
  #   end
208
  #
209 210
  # You can pass in any header value that a <tt>Mail::Message</tt>, out of the box, <tt>ActionMailer::Base</tt>
  # sets the following:
211
  #
212 213 214 215
  # * <tt>:mime_version => "1.0"</tt>
  # * <tt>:charset      => "UTF-8",</tt>
  # * <tt>:content_type => "text/plain",</tt>
  # * <tt>:parts_order  => [ "text/plain", "text/enriched", "text/html" ]</tt>
216
  #
217
  # <tt>parts_order</tt> and <tt>charset</tt> are not actually valid <tt>Mail::Message</tt> header fields,
218
  # but Action Mailer translates them appropriately and sets the correct values.
219
  #
220 221
  # 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:
222
  #
223 224 225 226
  #   class Notifier < ActionMailer::Base
  #     default 'Content-Transfer-Encoding' => '7bit',
  #             :content_description => 'This is a description'
  #   end
227
  #
228
  # Finally, Action Mailer also supports passing <tt>Proc</tt> objects into the default hash, so you
229
  # can define methods that evaluate as the message is being generated:
230
  #
231 232
  #   class Notifier < ActionMailer::Base
  #     default 'X-Special-Header' => Proc.new { my_method }
233
  #
234
  #     private
235
  #
236 237 238 239
  #       def my_method
  #         'some complex call'
  #       end
  #   end
240
  #
241
  # Note that the proc is evaluated right at the start of the mail message generation, so if you
242
  # set something in the defaults using a proc, and then set the same thing inside of your
243
  # mailer method, it will get over written by the mailer method.
244
  #
D
David Heinemeier Hansson 已提交
245 246
  # = Configuration options
  #
247
  # These options are specified on the class level, like
248
  # <tt>ActionMailer::Base.template_root = "/my/templates"</tt>
D
David Heinemeier Hansson 已提交
249
  #
250 251
  # * <tt>default</tt> - You can pass this in at a class level as well as within the class itself as
  #   per the above section.
252
  #
D
David Heinemeier Hansson 已提交
253 254 255
  # * <tt>logger</tt> - the logger is used for generating information on the mailing run if available.
  #   Can be set to nil for no logging. Compatible with both Ruby's own Logger and Log4r loggers.
  #
256
  # * <tt>smtp_settings</tt> - Allows detailed configuration for <tt>:smtp</tt> delivery method:
257 258
  #   * <tt>:address</tt> - Allows you to use a remote mail server. Just change it from its default
  #     "localhost" setting.
P
Pratik Naik 已提交
259 260 261 262
  #   * <tt>:port</tt> - On the off chance that your mail server doesn't run on port 25, you can change it.
  #   * <tt>:domain</tt> - If you need to specify a HELO domain, you can do it here.
  #   * <tt>:user_name</tt> - If your mail server requires authentication, set the username in this setting.
  #   * <tt>:password</tt> - If your mail server requires authentication, set the password in this setting.
263 264
  #   * <tt>:authentication</tt> - If your mail server requires authentication, you need to specify the
  #     authentication type here.
265
  #     This is a symbol and one of <tt>:plain</tt>, <tt>:login</tt>, <tt>:cram_md5</tt>.
266 267
  #   * <tt>:enable_starttls_auto</tt> - When set to true, detects if STARTTLS is enabled in your SMTP server
  #     and starts to use it.
D
David Heinemeier Hansson 已提交
268
  #
269 270
  # * <tt>sendmail_settings</tt> - Allows you to override options for the <tt>:sendmail</tt> delivery method.
  #   * <tt>:location</tt> - The location of the sendmail executable. Defaults to <tt>/usr/sbin/sendmail</tt>.
271 272
  #   * <tt>:arguments</tt> - The command line arguments. Defaults to <tt>-i -t</tt> with <tt>-f sender@addres</tt>
  #     added automatically before the message is sent.
P
Pratik Naik 已提交
273
  #
274
  # * <tt>file_settings</tt> - Allows you to override options for the <tt>:file</tt> delivery method.
275 276
  #   * <tt>:location</tt> - The directory into which emails will be written. Defaults to the application
  #     <tt>tmp/mails</tt>.
277
  #
P
Pratik Naik 已提交
278
  # * <tt>raise_delivery_errors</tt> - Whether or not errors should be raised if the email fails to be delivered.
D
David Heinemeier Hansson 已提交
279
  #
280 281 282 283
  # * <tt>delivery_method</tt> - Defines a delivery method. Possible values are <tt>:smtp</tt> (default),
  #   <tt>:sendmail</tt>, <tt>:test</tt>, and <tt>:file</tt>. Or you may provide a custom delivery method
  #   object eg. MyOwnDeliveryMethodClass.new.  See the Mail gem documentation on the interface you need to
  #   implement for a custom delivery agent.
D
David Heinemeier Hansson 已提交
284
  #
285 286 287
  # * <tt>perform_deliveries</tt> - Determines whether emails are actually sent from Action Mailer when you
  #   call <tt>.deliver</tt> on an mail message or on an Action Mailer method.  This is on by default but can
  #   be turned off to aid in functional testing.
D
David Heinemeier Hansson 已提交
288
  #
289 290
  # * <tt>deliveries</tt> - Keeps an array of all the emails sent out through the Action Mailer with
  #   <tt>delivery_method :test</tt>. Most useful for unit and functional testing.
D
David Heinemeier Hansson 已提交
291
  #
292
  # * <tt>default_charset</tt> - This is now deprecated, use the +default+ method above to
293
  #   set the default +:charset+.
294
  #
295
  # * <tt>default_content_type</tt> - This is now deprecated, use the +default+ method above
296
  #   to set the default +:content_type+.
297
  #
298
  # * <tt>default_mime_version</tt> - This is now deprecated, use the +default+ method above
299
  #   to set the default +:mime_version+.
300
  #
301
  # * <tt>default_implicit_parts_order</tt> - This is now deprecated, use the +default+ method above
302 303 304
  #   to set the default +:parts_order+.  Parts Order is used when a message is built implicitly
  #   (i.e. multiple parts are assembled from templates which specify the content type in their
  #   filenames) this variable controls how the parts are ordered.
305
  class Base < AbstractController::Base
306
    include DeliveryMethods
307 308
    abstract!

309
    include AbstractController::Logger
310
    include AbstractController::Rendering
311
    include AbstractController::Layouts
312
    include AbstractController::Helpers
313
    include AbstractController::Translation
314

315
    helper  ActionMailer::MailHelper
316

317
    include ActionMailer::OldApi
318
    include ActionMailer::DeprecatedApi
319

320 321
    delegate :register_observer, :to => Mail
    delegate :register_interceptor, :to => Mail
322

D
David Heinemeier Hansson 已提交
323
    private_class_method :new #:nodoc:
D
Initial  
David Heinemeier Hansson 已提交
324

J
Jeremy Kemper 已提交
325
    class_attribute :default_params
326 327
    self.default_params = {
      :mime_version => "1.0",
328
      :charset      => "UTF-8",
329 330
      :content_type => "text/plain",
      :parts_order  => [ "text/plain", "text/enriched", "text/html" ]
J
Jeremy Kemper 已提交
331
    }.freeze
332

333
    class << self
334

335 336 337
      def mailer_name
        @mailer_name ||= name.underscore
      end
338 339
      attr_writer :mailer_name
      alias :controller_path :mailer_name
340

J
Jeremy Kemper 已提交
341 342 343
      def default(value = nil)
        self.default_params = default_params.merge(value).freeze if value
        default_params
344 345
      end

346 347
      # Receives a raw email, parses it into an email object, decodes it,
      # instantiates a new mailer, and passes the email object to the mailer
P
Pratik Naik 已提交
348 349
      # object's +receive+ method. If you want your mailer to be able to
      # process incoming messages, you'll need to implement a +receive+
350
      # method that accepts the raw email string as a parameter:
351 352 353 354 355 356
      #
      #   class MyMailer < ActionMailer::Base
      #     def receive(mail)
      #       ...
      #     end
      #   end
357
      def receive(raw_mail)
358
        ActiveSupport::Notifications.instrument("receive.action_mailer") do |payload|
359 360
          mail = Mail.new(raw_mail)
          set_payload_for_mail(payload, mail)
J
José Valim 已提交
361 362
          new.receive(mail)
        end
363 364
      end

365 366 367 368
      # Wraps an email delivery inside of Active Support Notifications instrumentation. This
      # method is actually called by the <tt>Mail::Message</tt> object itself through a call back
      # when you call <tt>:deliver</tt> on the Mail::Message, calling +deliver_mail+ directly
      # and passing a Mail::Message will do nothing except tell the logger you sent the email.
369
      def deliver_mail(mail) #:nodoc:
370
        ActiveSupport::Notifications.instrument("deliver.action_mailer") do |payload|
371
          self.set_payload_for_mail(payload, mail)
372
          yield # Let Mail do the delivery actions
373 374 375
        end
      end

376 377 378 379 380 381
      def respond_to?(method, *args) #:nodoc:
        super || action_methods.include?(method.to_s)
      end

    protected

382
      def set_payload_for_mail(payload, mail) #:nodoc:
383
        payload[:mailer]     = self.name
384 385 386 387 388 389 390 391
        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
392
      end
393

394
      def method_missing(method, *args) #:nodoc:
395 396 397 398 399 400
        if action_methods.include?(method.to_s)
          new(method, *args).message
        else
          super
        end
      end
401 402
    end

403 404
    attr_internal :message

405 406 407 408 409 410
    # 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).
    def initialize(method_name=nil, *args)
      super()
411
      @_message = Mail.new
412 413 414
      process(method_name, *args) if method_name
    end

415 416 417 418 419
    def process(*args) #:nodoc:
      lookup_context.skip_default_locale!
      super
    end

420 421
    # Allows you to pass random and unusual headers to the new +Mail::Message+ object
    # which will add them to itself.
422
    #
423
    #   headers['X-Special-Domain-Specific-Header'] = "SecretValue"
424
    #
425 426
    # You can also pass a hash into headers of header field names and values, which
    # will then be set on the Mail::Message object:
427
    #
428 429
    #   headers 'X-Special-Domain-Specific-Header' => "SecretValue",
    #           'In-Reply-To' => incoming.message_id
430
    #
431
    # The resulting Mail::Message will have the following in it's header:
432
    #
433
    #   X-Special-Domain-Specific-Header: SecretValue
434 435
    def headers(args=nil)
      if args
436
        @_message.headers(args)
437 438 439 440
      else
        @_message
      end
    end
441

442
    # Allows you to add attachments to an email, like so:
443
    #
444
    #  mail.attachments['filename.jpg'] = File.read('/path/to/filename.jpg')
445
    #
446
    # If you do this, then Mail will take the file name and work out the mime type
447
    # set the Content-Type, Content-Disposition, Content-Transfer-Encoding and
448
    # base64 encode the contents of the attachment all for you.
449
    #
450
    # You can also specify overrides if you want by passing a hash instead of a string:
451
    #
452 453
    #  mail.attachments['filename.jpg'] = {:mime_type => 'application/x-gzip',
    #                                      :content => File.read('/path/to/filename.jpg')}
454
    #
455 456 457
    # 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:
458
    #
459 460 461 462
    #  file_content = SpecialEncode(File.read('/path/to/filename.jpg'))
    #  mail.attachments['filename.jpg'] = {:mime_type => 'application/x-gzip',
    #                                      :encoding => 'SpecialEncoding',
    #                                      :content => file_content }
463
    #
464
    # You can also search for specific attachments:
465
    #
466 467
    #  # By Filename
    #  mail.attachments['filename.jpg']   #=> Mail::Part object or nil
468
    #
469 470
    #  # or by index
    #  mail.attachments[0]                #=> Mail::Part (first attachment)
471
    #
472 473 474
    def attachments
      @_message.attachments
    end
475

476 477
    # 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.
478
    #
479
    # Both methods accept a headers hash. This hash allows you to specify the most used headers
480
    # in an email message, these are:
481
    #
482
    # * <tt>:subject</tt> - The subject of the message, if this is omitted, Action Mailer will
483 484 485 486 487
    #   ask the Rails I18n class for a translated <tt>:subject</tt> in the scope of
    #   <tt>[:actionmailer, mailer_scope, action_name]</tt> or if this is missing, will translate the
    #   humanized version of the <tt>action_name</tt>
    # * <tt>:to</tt> - Who the message is destined for, can be a string of addresses, or an array
    #   of addresses.
488
    # * <tt>:from</tt> - Who the message is from
489 490 491 492 493 494
    # * <tt>:cc</tt> - Who you would like to Carbon-Copy on this email, can be a string of addresses,
    #   or an array of addresses.
    # * <tt>:bcc</tt> - Who you would like to Blind-Carbon-Copy on this email, can be a string of
    #   addresses, or an array of addresses.
    # * <tt>:reply_to</tt> - Who to set the Reply-To header of the email to.
    # * <tt>:date</tt> - The date to say the email was sent on.
495 496
    #
    # You can set default values for any of the above headers (except :date) by using the <tt>default</tt>
497
    # class method:
498
    #
499
    #  class Notifier < ActionMailer::Base
500 501 502
    #    self.default :from => 'no-reply@test.lindsaar.net',
    #                 :bcc => 'email_logger@test.lindsaar.net',
    #                 :reply_to => 'bounces@test.lindsaar.net'
503
    #  end
504
    #
505 506
    # If you need other headers not listed above, use the <tt>headers['name'] = value</tt> method.
    #
507
    # When a <tt>:return_path</tt> is specified as header, that value will be used as the 'envelope from'
508
    # address for the Mail message.  Setting this is useful when you want delivery notifications
509
    # sent to a different address than the one in <tt>:from</tt>.  Mail will actually use the
510 511 512
    # <tt>:return_path</tt> in preference to the <tt>:sender</tt> in preference to the <tt>:from</tt>
    # field for the 'envelope from' value.
    #
513
    # If you do not pass a block to the +mail+ method, it will find all templates in the
514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534
    # 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 <tt>:deliver</tt> 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".
535 536
    #
    # If you do pass a block, you can render specific templates of your choice:
537
    #
538 539 540 541
    #   mail(:to => 'mikel@test.lindsaar.net') do |format|
    #     format.text
    #     format.html
    #   end
542
    #
543
    # You can even render text directly without using a template:
544
    #
545 546 547 548
    #   mail(:to => 'mikel@test.lindsaar.net') do |format|
    #     format.text { render :text => "Hello Mikel!" }
    #     format.html { render :text => "<h1>Hello Mikel!</h1>" }
    #   end
549
    #
550
    # Which will render a <tt>multipart/alternative</tt> email with <tt>text/plain</tt> and
551
    # <tt>text/html</tt> parts.
552 553 554 555 556 557 558 559
    #
    # 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
    #
560 561 562 563 564
    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
565

566 567 568
      # At the beginning, do not consider class default for parts order neither content_type
      content_type = headers[:content_type]
      parts_order  = headers[:parts_order]
569

570 571
      # Call all the procs (if any)
      default_values = self.class.default.merge(self.class.default) do |k,v|
572
        v.respond_to?(:call) ? v.bind(self).call : v
573
      end
574

575
      # Handle defaults
576
      headers = headers.reverse_merge(default_values)
577
      headers[:subject] ||= default_i18n_subject
578 579 580 581 582 583 584 585

      # 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
586
      assignable = headers.except(:parts_order, :content_type, :body, :template_name, :template_path)
587
      assignable.each { |k, v| m[k] = v }
588

589
      # Render the templates and blocks
590
      responses, explicit_order = collect_responses_and_parts_order(headers, &block)
591
      create_parts_from_responses(m, responses)
592

593
      # Setup content type, reapply charset and handle parts order
594
      m.content_type = set_content_type(m, content_type, headers[:content_type])
595 596
      m.charset      = charset

597
      if m.multipart?
598 599
        parts_order ||= explicit_order || headers[:parts_order]
        m.body.set_sort_order(parts_order)
600 601
        m.body.sort_parts!
      end
602

603 604 605
      m
    end

606 607
  protected

608
    def set_content_type(m, user_content_type, class_default)
609 610 611 612 613 614 615 616 617
      params = m.content_type_parameters || {}
      case
      when user_content_type.present?
        user_content_type
      when m.has_attachments?
        ["multipart", "mixed", params]
      when m.multipart?
        ["multipart", "alternative", params]
      else
618
        m.content_type || class_default
619 620 621
      end
    end

622
    def default_i18n_subject #:nodoc:
623
      mailer_scope = self.class.mailer_name.gsub('/', '.')
624
      I18n.t(:subject, :scope => [:actionmailer, mailer_scope, action_name], :default => action_name.humanize)
625 626
    end

627 628
    def collect_responses_and_parts_order(headers) #:nodoc:
      responses, parts_order = [], nil
629 630

      if block_given?
631
        collector = ActionMailer::Collector.new(lookup_context) { render(action_name) }
632
        yield(collector)
633
        parts_order = collector.responses.map { |r| r[:content_type] }
634 635 636
        responses  = collector.responses
      elsif headers[:body]
        responses << {
637
          :body => headers.delete(:body),
638
          :content_type => self.class.default[:content_type] || "text/plain"
639 640
        }
      else
641 642 643 644
        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|
645 646
          self.formats = template.formats

647
          responses << {
648
            :body => render(:template => template),
649 650 651 652 653
            :content_type => template.mime_type.to_s
          }
        end
      end

654
      [responses, parts_order]
655 656
    end

657
    def each_template(paths, name, &block) #:nodoc:
J
Jeremy Kemper 已提交
658
      Array.wrap(paths).each do |path|
659
        templates = lookup_context.find_all(name, path)
660
        templates = templates.uniq_by { |t| t.formats }
661

662 663 664
        unless templates.empty?
          templates.each(&block)
          return
665 666 667 668
        end
      end
    end

669
    def create_parts_from_responses(m, responses) #:nodoc:
670
      if responses.size == 1 && !m.has_attachments?
671
        responses[0].each { |k,v| m[k] = v }
672
      elsif responses.size > 1 && m.has_attachments?
673
        container = Mail::Part.new
674
        container.content_type = "multipart/alternative"
675
        responses.each { |r| insert_part(container, r, m.charset) }
676 677
        m.add_part(container)
      else
678
        responses.each { |r| insert_part(m, r, m.charset) }
679
      end
680 681
    end

682 683 684 685
    def insert_part(container, response, charset) #:nodoc:
      response[:charset] ||= charset
      part = Mail::Part.new(response)
      container.add_part(part)
686
    end
687

688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709
    module DeprecatedUrlOptions
      def default_url_options
        deprecated_url_options
      end

      def default_url_options=(val)
        deprecated_url_options
      end

      def deprecated_url_options
        raise "You can no longer call ActionMailer::Base.default_url_options " \
              "directly. You need to set config.action_mailer.default_url_options. " \
              "If you are using ActionMailer standalone, you need to include the " \
              "url_helpers of a router directly."
      end
    end

    # This module will complain if the user tries to set default_url_options
    # directly instead of through the config object. In ActionMailer's Railtie,
    # we include the url_helpers of the router, which will override this module
    extend DeprecatedUrlOptions

710
    ActiveSupport.run_load_hooks(:action_mailer, self)
D
Initial  
David Heinemeier Hansson 已提交
711 712
  end
end