base.rb 27.5 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

D
David Heinemeier Hansson 已提交
7
module ActionMailer #:nodoc:
P
Pratik Naik 已提交
8
  # Action Mailer allows you to send email from your application using a mailer model and views.
D
Initial  
David Heinemeier Hansson 已提交
9
  #
10
  # = Mailer Models
11
  #
P
Pratik Naik 已提交
12
  # To use Action Mailer, you need to create a mailer model.
13
  #
14
  #   $ rails generate mailer Notifier
15
  #
16 17 18
  # 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.
19 20 21 22
  #
  # Examples:
  #
  #  class Notifier < ActionMailer::Base
23 24
  #    default :from => 'no-reply@example.com',
  #            :return_path => 'system@example.com'
25 26 27
  # 
  #    def welcome(recipient)
  #      @account = recipient
28 29
  #      mail(:to => recipient.email_address_with_name,
  #           :bcc => ["bcc@example.com", "Order Watcher <watcher@example.com>"])
30
  #      end
31
  #    end
32 33 34 35 36
  # 
  # Within the mailer method, you have access to the following methods:
  # 
  # * <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>
37
  #
38 39 40 41 42 43
  # * <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.)
44
  #
45 46 47
  # * <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>
  #
48 49
  # * <tt>mail</tt> - Allows you to specify your email to send.
  # 
50
  # The hash passed to the mail method allows you to specify any header that a Mail::Message
51
  # will accept (any valid Email header including optional fields).
52 53
  #
  # The mail method, if not passed a block, will inspect your views and send all the views with
54 55
  # 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.
56 57 58 59 60 61 62
  # 
  # If you want to explicitly render only certain templates, pass a block:
  # 
  #   mail(:to => user.emai) do |format|
  #     format.text
  #     format.html
  #   end
63
  #
64 65 66 67 68 69 70
  # 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
  #
71
  # Or even to render a special view:
72 73 74 75 76 77
  #
  #   mail(:to => user.emai) do |format|
  #     format.text
  #     format.html { render "some_other_template" }
  #   end
  #
78 79
  # = Mailer views
  #
80 81 82 83 84
  # 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 <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
85
  # <tt>app/views/notifier/signup_notification.text.plain.erb</tt> would be used to generate the email.
86 87 88 89 90 91 92 93
  #
  # 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.
  #
94 95 96
  # You can even use Action Pack helpers in these views. For example:
  #
  #   You got a new note!
97 98
  #   <%= truncate(@note.body, 25) %>
  #
99
  # If you need to access the subject, from or the recipients in the view, you can do that through message object:
100
  #
101
  #   You got a new note from <%= message.from %>!
102
  #   <%= truncate(@note.body, 25) %>
103
  #
104
  #
105
  # = Generating URLs
106
  #
107 108 109
  # URLs can be generated in mailer views using <tt>url_for</tt> 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.
110
  #
111
  # When using <tt>url_for</tt> you'll need to provide the <tt>:host</tt>, <tt>:controller</tt>, and <tt>:action</tt>:
112
  #
113
  #   <%= url_for(:host => "example.com", :controller => "welcome", :action => "greeting") %>
114
  #
115
  # When using named routes you only need to supply the <tt>:host</tt>:
116
  #
117 118
  #   <%= users_url(:host => "example.com") %>
  #
119 120
  # 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.
121
  #
122 123
  # 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:
124 125
  #
  #   ActionMailer::Base.default_url_options[:host] = "example.com"
126
  #
P
Pratik Naik 已提交
127
  # This can also be set as a configuration option in <tt>config/environment.rb</tt>:
128 129
  #
  #   config.action_mailer.default_url_options = { :host => "example.com" }
130
  #
131
  # If you do decide to set a default <tt>:host</tt> for your mailers you will want to use the
132 133 134
  # <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.
135 136 137
  #
  # = Sending mail
  #
138
  # Once a mailer action and template are defined, you can deliver your message or create it and save it
139 140
  # for delivery later:
  #
141 142 143
  #   Notifier.welcome(david).deliver # sends the email
  #   mail = Notifier.welcome(david)  # => a Mail::Message object
  #   mail.deliver                    # sends the email
144
  #
145
  # You never instantiate your mailer class. Rather, you just call the method you defined on the class itself.
146
  #
147
  # = Multipart Emails
148
  #
P
Pratik Naik 已提交
149
  # Multipart messages can also be used implicitly because Action Mailer will automatically
150 151
  # 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.
152
  #
153
  # For example, if the following templates existed:
154 155 156
  # * signup_notification.text.plain.erb
  # * signup_notification.text.html.erb
  # * signup_notification.text.xml.builder
157
  # * signup_notification.text.yaml.erb
158
  #
159 160 161 162
  # 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.
163
  #
164 165 166
  # 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>.
167
  #
168
  # = Attachments
169
  #
170 171
  # You can see above how to make a multipart HTML / Text email, to send attachments is just
  # as easy:
172 173
  #
  #   class ApplicationMailer < ActionMailer::Base
174 175 176
  #     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 已提交
177
  #     end
178
  #   end
179
  # 
180 181 182 183 184
  # 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 已提交
185
  #
186 187 188 189 190 191 192 193 194 195 196 197
  # = Observing and Intercepting Mails
  # 
  # ActionMailer 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 <tt>:delivered_email(message)</tt> method which will be
  # called once for every email sent after the email has been sent.
  # 
  # 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.
198
  #
D
David Heinemeier Hansson 已提交
199 200 201 202
  # = Configuration options
  #
  # These options are specified on the class level, like <tt>ActionMailer::Base.template_root = "/my/templates"</tt>
  #
203
  # * <tt>default</tt> - This is a class wide hash of <tt>:key => value</tt> pairs containing
204 205
  #   default values for the specified header fields of the <tt>Mail::Message</tt>.  You can 
  #   specify a default for any valid header for <tt>Mail::Message</tt> and it will be used if
206 207 208
  #   you do not override it.  You pass in the header value as a symbol, all lower case with under
  #   scores instead of hyphens, so <tt>Content-Transfer-Encoding:</tt>
  #   becomes <tt>:content_transfer_encoding</tt>. The defaults set by Action Mailer are:
209
  #   * <tt>:mime_version => "1.0"</tt>
210
  #   * <tt>:charset      => "UTF-8",</tt>
211 212
  #   * <tt>:content_type => "text/plain",</tt>
  #   * <tt>:parts_order  => [ "text/plain", "text/enriched", "text/html" ]</tt>
D
David Heinemeier Hansson 已提交
213 214 215 216
  #
  # * <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.
  #
217
  # * <tt>smtp_settings</tt> - Allows detailed configuration for <tt>:smtp</tt> delivery method:
218 219
  #   * <tt>:address</tt> - Allows you to use a remote mail server. Just change it from its default
  #     "localhost" setting.
P
Pratik Naik 已提交
220 221 222 223
  #   * <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.
224 225
  #   * <tt>:authentication</tt> - If your mail server requires authentication, you need to specify the
  #     authentication type here.
226
  #     This is a symbol and one of <tt>:plain</tt>, <tt>:login</tt>, <tt>:cram_md5</tt>.
227 228
  #   * <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 已提交
229
  #
230 231
  # * <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>.
232 233
  #   * <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 已提交
234
  #
235
  # * <tt>file_settings</tt> - Allows you to override options for the <tt>:file</tt> delivery method.
236 237
  #   * <tt>:location</tt> - The directory into which emails will be written. Defaults to the application
  #     <tt>tmp/mails</tt>.
238
  #
P
Pratik Naik 已提交
239
  # * <tt>raise_delivery_errors</tt> - Whether or not errors should be raised if the email fails to be delivered.
D
David Heinemeier Hansson 已提交
240
  #
241 242 243 244
  # * <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 已提交
245
  #
246 247 248
  # * <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 已提交
249
  #
250 251
  # * <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 已提交
252
  #
253
  # * <tt>default_charset</tt> - This is now deprecated, use the +default+ method above to 
254
  #   set the default +:charset+.
255
  #
256
  # * <tt>default_content_type</tt> - This is now deprecated, use the +default+ method above 
257
  #   to set the default +:content_type+.
258
  #
259
  # * <tt>default_mime_version</tt> - This is now deprecated, use the +default+ method above 
260
  #   to set the default +:mime_version+.
261
  #
262
  # * <tt>default_implicit_parts_order</tt> - This is now deprecated, use the +default+ method above 
263 264 265
  #   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.
266
  class Base < AbstractController::Base
267
    include DeliveryMethods
268 269
    abstract!

270
    include AbstractController::Logger
271
    include AbstractController::Rendering
272
    include AbstractController::Layouts
273
    include AbstractController::Helpers
274
    include AbstractController::Translation
275

276
    helper  ActionMailer::MailHelper
277

278
    include ActionMailer::OldApi
279
    include ActionMailer::DeprecatedApi
280 281 282
    
    delegate :register_observer, :to => Mail
    delegate :register_interceptor, :to => Mail
283

D
David Heinemeier Hansson 已提交
284
    private_class_method :new #:nodoc:
D
Initial  
David Heinemeier Hansson 已提交
285

J
Jeremy Kemper 已提交
286
    class_attribute :default_params
287 288
    self.default_params = {
      :mime_version => "1.0",
289
      :charset      => "UTF-8",
290 291
      :content_type => "text/plain",
      :parts_order  => [ "text/plain", "text/enriched", "text/html" ]
J
Jeremy Kemper 已提交
292
    }.freeze
293

294
    ActiveSupport.run_load_hooks(:action_mailer, self)
295

296
    class << self
297

298 299 300
      def mailer_name
        @mailer_name ||= name.underscore
      end
301 302
      attr_writer :mailer_name
      alias :controller_path :mailer_name
303

J
Jeremy Kemper 已提交
304 305 306
      def default(value = nil)
        self.default_params = default_params.merge(value).freeze if value
        default_params
307 308
      end

309 310
      # 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 已提交
311 312
      # object's +receive+ method. If you want your mailer to be able to
      # process incoming messages, you'll need to implement a +receive+
313
      # method that accepts the raw email string as a parameter:
314 315 316 317 318 319
      #
      #   class MyMailer < ActionMailer::Base
      #     def receive(mail)
      #       ...
      #     end
      #   end
320 321 322 323
      def receive(raw_mail)
        ActiveSupport::Notifications.instrument("action_mailer.receive") do |payload|
          mail = Mail.new(raw_mail)
          set_payload_for_mail(payload, mail)
J
José Valim 已提交
324 325
          new.receive(mail)
        end
326 327
      end

328 329 330 331
      # 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.
332
      def deliver_mail(mail) #:nodoc:
333
        ActiveSupport::Notifications.instrument("action_mailer.deliver") do |payload|
334
          self.set_payload_for_mail(payload, mail)
335
          yield # Let Mail do the delivery actions
336 337 338
        end
      end

339 340 341 342 343 344
      def respond_to?(method, *args) #:nodoc:
        super || action_methods.include?(method.to_s)
      end

    protected

345
      def set_payload_for_mail(payload, mail) #:nodoc:
346
        payload[:mailer]     = self.name
347 348 349 350 351 352 353 354
        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
355
      end
356

357
      def method_missing(method, *args) #:nodoc:
358 359 360 361 362 363
        if action_methods.include?(method.to_s)
          new(method, *args).message
        else
          super
        end
      end
364 365
    end

366 367
    attr_internal :message

368 369 370 371 372 373
    # 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()
374
      @_message = Mail.new
375 376 377
      process(method_name, *args) if method_name
    end

378 379 380 381 382
    # 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"
    # 
383 384 385
    # You can also pass a hash into headers of header field names and values, which
    # will then be set on the Mail::Message object:
    # 
386 387
    #   headers 'X-Special-Domain-Specific-Header' => "SecretValue",
    #           'In-Reply-To' => incoming.message_id
388
    # 
389 390 391
    # The resulting Mail::Message will have the following in it's header:
    # 
    #   X-Special-Domain-Specific-Header: SecretValue
392 393
    def headers(args=nil)
      if args
394
        @_message.headers(args)
395 396 397 398
      else
        @_message
      end
    end
399

400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429
    # 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)
    #  
430 431 432
    def attachments
      @_message.attachments
    end
433

434 435 436
    # 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.
    # 
437
    # Both methods accept a headers hash. This hash allows you to specify the most used headers
438 439 440 441 442 443 444 445
    # in an email message, these are:
    # 
    # * <tt>:subject</tt> - The subject of the message, if this is omitted, ActionMailer will
    #   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.
446
    # * <tt>:from</tt> - Who the message is from
447 448 449 450 451 452 453
    # * <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.
    # 
454
    # You can set default values for any of the above headers (except :date) by using the <tt>default</tt> 
455 456
    # class method:
    # 
457
    #  class Notifier < ActionMailer::Base
458 459 460
    #    self.default :from => 'no-reply@test.lindsaar.net',
    #                 :bcc => 'email_logger@test.lindsaar.net',
    #                 :reply_to => 'bounces@test.lindsaar.net'
461 462
    #  end
    # 
463 464
    # If you need other headers not listed above, use the <tt>headers['name'] = value</tt> method.
    #
465
    # When a <tt>:return_path</tt> is specified as header, that value will be used as the 'envelope from'
466 467 468 469 470 471
    # address for the Mail message.  Setting this is useful when you want delivery notifications
    # sent to a different address than the one in <tt>:from</tt>.  Mail will actually use the 
    # <tt>:return_path</tt> in preference to the <tt>:sender</tt> in preference to the <tt>:from</tt>
    # field for the 'envelope from' value.
    #
    # If you do not pass a block to the +mail+ method, it will find all templates in the 
472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492
    # 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".
493 494 495 496 497 498 499 500 501 502 503 504 505 506 507
    #
    # 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
    # 
508
    # Which will render a <tt>multipart/alternative</tt> email with <tt>text/plain</tt> and
509
    # <tt>text/html</tt> parts.
510 511 512 513 514 515 516 517
    #
    # 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
    #
518 519 520 521 522
    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
523

524 525 526
      # At the beginning, do not consider class default for parts order neither content_type
      content_type = headers[:content_type]
      parts_order  = headers[:parts_order]
527

528
      # Merge defaults from class
529
      headers = headers.reverse_merge(self.class.default)
530
      charset = headers.delete(:charset)
531

532 533
      # Quote fields
      headers[:subject] ||= default_i18n_subject
534
      set_fields!(headers, charset)
535

536
      # Render the templates and blocks
537
      responses, explicit_order = collect_responses_and_parts_order(headers, &block)
538
      create_parts_from_responses(m, responses, charset)
539

540 541
      # Finally setup content type and parts order
      m.content_type = set_content_type(m, content_type, headers[:content_type])
542 543
      m.charset      = charset

544
      if m.multipart?
545 546
        parts_order ||= explicit_order || headers[:parts_order]
        m.body.set_sort_order(parts_order)
547 548
        m.body.sort_parts!
      end
549

550
      # Set configure delivery behavior
551
      wrap_delivery_behavior!(headers.delete(:delivery_method))
552

553 554
      # Remove any missing configuration header and assign all others
      headers.except!(:parts_order, :content_type)
555
      headers.each { |k, v| m[k] = v }
556 557 558
      m
    end

559 560
  protected

561
    def set_content_type(m, user_content_type, class_default)
562 563 564 565 566 567 568 569 570
      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
571
        m.content_type || class_default
572 573 574
      end
    end

575
    def default_i18n_subject #:nodoc:
576
      mailer_scope = self.class.mailer_name.gsub('/', '.')
577
      I18n.t(:subject, :scope => [:actionmailer, mailer_scope, action_name], :default => action_name.humanize)
578 579
    end

580
    def set_fields!(headers, charset) #:nodoc:
581
      m = @_message
582
      m.charset = charset
583 584 585 586 587 588
      m.subject  ||= headers.delete(:subject)  if headers[:subject]
      m.to       ||= headers.delete(:to)       if headers[:to]
      m.from     ||= headers.delete(:from)     if headers[:from]
      m.cc       ||= headers.delete(:cc)       if headers[:cc]
      m.bcc      ||= headers.delete(:bcc)      if headers[:bcc]
      m.reply_to ||= headers.delete(:reply_to) if headers[:reply_to]
589 590
    end

591 592
    def collect_responses_and_parts_order(headers) #:nodoc:
      responses, parts_order = [], nil
593 594

      if block_given?
595
        collector = ActionMailer::Collector.new(lookup_context) { render(action_name) }
596
        yield(collector)
597
        parts_order = collector.responses.map { |r| r[:content_type] }
598 599 600
        responses  = collector.responses
      elsif headers[:body]
        responses << {
601
          :body => headers.delete(:body),
602
          :content_type => self.class.default[:content_type] || "text/plain"
603 604
        }
      else
605 606 607 608
        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|
609 610
          self.formats = template.formats

611
          responses << {
612
            :body => render(:template => template),
613 614 615 616 617
            :content_type => template.mime_type.to_s
          }
        end
      end

618
      [responses, parts_order]
619 620
    end

621
    def each_template(paths, name, &block) #:nodoc:
J
Jeremy Kemper 已提交
622
      Array.wrap(paths).each do |path|
623
        templates = lookup_context.find_all(name, path)
624
        templates = templates.uniq_by { |t| t.formats }
625

626 627 628
        unless templates.empty?
          templates.each(&block)
          return
629 630 631 632
        end
      end
    end

633 634
    def create_parts_from_responses(m, responses, charset) #:nodoc:
      if responses.size == 1 && !m.has_attachments?
635
        responses[0].each { |k,v| m[k] = v }
636
      elsif responses.size > 1 && m.has_attachments?
637
        container = Mail::Part.new
638
        container.content_type = "multipart/alternative"
639 640 641 642 643
        responses.each { |r| insert_part(container, r, charset) }
        m.add_part(container)
      else
        responses.each { |r| insert_part(m, r, charset) }
      end
644 645
    end

646 647 648 649
    def insert_part(container, response, charset) #:nodoc:
      response[:charset] ||= charset
      part = Mail::Part.new(response)
      container.add_part(part)
650
    end
651

D
Initial  
David Heinemeier Hansson 已提交
652 653
  end
end