base.rb 28.4 KB
Newer Older
1
require "active_support/core_ext/class"
2
# Use the old layouts until actionmailer gets refactored
3
require "action_controller/legacy/layout"
4

D
David Heinemeier Hansson 已提交
5
module ActionMailer #:nodoc:
P
Pratik Naik 已提交
6
  # Action Mailer allows you to send email from your application using a mailer model and views.
D
Initial  
David Heinemeier Hansson 已提交
7
  #
8
  #
9
  # = Mailer Models
10
  #
P
Pratik Naik 已提交
11
  # To use Action Mailer, you need to create a mailer model.
12
  #
13 14
  #   $ script/generate mailer Notifier
  #
15 16
  # 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
17 18 19 20 21 22 23
  # to add attachments.
  #
  # Examples:
  #
  #  class Notifier < ActionMailer::Base
  #    def signup_notification(recipient)
  #      recipients recipient.email_address_with_name
P
Pratik Naik 已提交
24
  #      bcc        ["bcc@example.com", "Order Watcher <watcher@example.com>"]
25 26
  #      from       "system@example.com"
  #      subject    "New account information"
27
  #      body       :account => recipient
28 29 30 31 32 33 34 35 36
  #    end
  #  end
  #
  # Mailer methods have the following configuration methods available.
  #
  # * <tt>recipients</tt> - Takes one or more email addresses. These addresses are where your email will be delivered to. Sets the <tt>To:</tt> header.
  # * <tt>subject</tt> - The subject of your email. Sets the <tt>Subject:</tt> header.
  # * <tt>from</tt> - Who the email you are sending is from. Sets the <tt>From:</tt> header.
  # * <tt>cc</tt> - Takes one or more email addresses. These addresses will receive a carbon copy of your email. Sets the <tt>Cc:</tt> header.
37 38
  # * <tt>bcc</tt> - Takes one or more email addresses. These addresses will receive a blind carbon copy of your email. Sets the <tt>Bcc:</tt> header.
  # * <tt>reply_to</tt> - Takes one or more email addresses. These addresses will be listed as the default recipients when replying to your email. Sets the <tt>Reply-To:</tt> header.
39 40 41 42
  # * <tt>sent_on</tt> - The date on which the message was sent. If not set, the header wil be set by the delivery agent.
  # * <tt>content_type</tt> - Specify the content type of the message. Defaults to <tt>text/plain</tt>.
  # * <tt>headers</tt> - Specify additional headers to be set for the message, e.g. <tt>headers 'X-Mail-Count' => 107370</tt>.
  #
43 44 45 46
  # When a <tt>headers 'return-path'</tt> is specified, that value will be used as the 'envelope from'
  # address. Setting this is useful when you want delivery notifications sent to a different address than
  # the one in <tt>from</tt>.
  #
47 48 49
  # The <tt>body</tt> method has special behavior. It takes a hash which generates an instance variable
  # named after each key in the hash containing the value that that key points to.
  #
50
  # So, for example, <tt>body :account => recipient</tt> would result
51
  # in an instance variable <tt>@account</tt> with the value of <tt>recipient</tt> being accessible in the
52 53
  # view.
  #
54 55 56
  #
  # = Mailer views
  #
P
Pratik Naik 已提交
57
  # Like Action Controller, each mailer class has a corresponding view directory
58
  # in which each method of the class looks for a template with its name.
59
  # To define a template to be used with a mailing, create an <tt>.erb</tt> file with the same name as the method
60
  # in your mailer model. For example, in the mailer defined above, the template at
61
  # <tt>app/views/notifier/signup_notification.erb</tt> would be used to generate the email.
62 63 64 65 66 67 68 69
  #
  # 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.
  #
70 71 72 73
  # You can even use Action Pack helpers in these views. For example:
  #
  #   You got a new note!
  #   <%= truncate(note.body, 25) %>
74
  #
75
  #
76
  # = Generating URLs
77
  #
78
  # URLs can be generated in mailer views using <tt>url_for</tt> or named routes.
79 80
  # 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.
81
  #
82
  # When using <tt>url_for</tt> you'll need to provide the <tt>:host</tt>, <tt>:controller</tt>, and <tt>:action</tt>:
83
  #
84
  #   <%= url_for(:host => "example.com", :controller => "welcome", :action => "greeting") %>
85
  #
86
  # When using named routes you only need to supply the <tt>:host</tt>:
87
  #
88 89 90 91 92
  #   <%= users_url(:host => "example.com") %>
  #
  # 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.
  #
93
  # It is also possible to set a default host that will be used in all mailers by setting the <tt>:host</tt> option in
94 95 96
  # the <tt>ActionMailer::Base.default_url_options</tt> hash as follows:
  #
  #   ActionMailer::Base.default_url_options[:host] = "example.com"
97
  #
P
Pratik Naik 已提交
98
  # This can also be set as a configuration option in <tt>config/environment.rb</tt>:
99 100
  #
  #   config.action_mailer.default_url_options = { :host => "example.com" }
101
  #
102 103
  # If you do decide to set a default <tt>:host</tt> for your mailers you will want to use the
  # <tt>:only_path => false</tt> option when using <tt>url_for</tt>. This will ensure that absolute URLs are generated because
104
  # the <tt>url_for</tt> view helper will, by default, generate relative URLs when a <tt>:host</tt> option isn't
105
  # explicitly provided.
106 107 108
  #
  # = Sending mail
  #
109
  # Once a mailer action and template are defined, you can deliver your message or create it and save it
110 111 112 113 114
  # for delivery later:
  #
  #   Notifier.deliver_signup_notification(david) # sends the email
  #   mail = Notifier.create_signup_notification(david)  # => a tmail object
  #   Notifier.deliver(mail)
115
  #
116 117 118 119 120 121
  # You never instantiate your mailer class. Rather, your delivery instance
  # methods are automatically wrapped in class methods that start with the word
  # <tt>deliver_</tt> followed by the name of the mailer method that you would
  # like to deliver. The <tt>signup_notification</tt> method defined above is
  # delivered by invoking <tt>Notifier.deliver_signup_notification</tt>.
  #
122 123 124
  #
  # = HTML email
  #
125
  # To send mail as HTML, make sure your view (the <tt>.erb</tt> file) generates HTML and
126 127 128
  # set the content type to html.
  #
  #   class MyMailer < ActionMailer::Base
129
  #     def signup_notification(recipient)
130 131 132 133 134
  #       recipients   recipient.email_address_with_name
  #       subject      "New account information"
  #       from         "system@example.com"
  #       body         :account => recipient
  #       content_type "text/html"
135
  #     end
136
  #   end
137
  #
138 139 140
  #
  # = Multipart email
  #
141
  # You can explicitly specify multipart messages:
142
  #
143
  #   class ApplicationMailer < ActionMailer::Base
144 145 146 147
  #     def signup_notification(recipient)
  #       recipients      recipient.email_address_with_name
  #       subject         "New account information"
  #       from            "system@example.com"
148
  #       content_type    "multipart/alternative"
149 150 151 152 153 154 155 156 157
  #
  #       part :content_type => "text/html",
  #         :body => render_message("signup-as-html", :account => recipient)
  #
  #       part "text/plain" do |p|
  #         p.body = render_message("signup-as-plain", :account => recipient)
  #         p.transfer_encoding = "base64"
  #       end
  #     end
158
  #   end
159
  #
P
Pratik Naik 已提交
160
  # Multipart messages can also be used implicitly because Action Mailer will automatically
161 162
  # 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.
163
  #
164
  # For example, if the following templates existed:
165 166 167 168
  # * signup_notification.text.plain.erb
  # * signup_notification.text.html.erb
  # * signup_notification.text.xml.builder
  # * signup_notification.text.x-yaml.erb
169
  #
170
  # Each would be rendered and added as a separate part to the message,
171 172 173 174
  # 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 body hash is passed to each template.
175
  #
176 177 178
  # 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>.
179
  #
180
  # = Attachments
181
  #
182 183 184 185 186
  # Attachments can be added by using the +attachment+ method.
  #
  # Example:
  #
  #   class ApplicationMailer < ActionMailer::Base
187 188 189 190 191 192 193 194 195 196 197 198
  #     # attachments
  #     def signup_notification(recipient)
  #       recipients      recipient.email_address_with_name
  #       subject         "New account information"
  #       from            "system@example.com"
  #
  #       attachment :content_type => "image/jpeg",
  #         :body => File.read("an-image.jpg")
  #
  #       attachment "application/pdf" do |a|
  #         a.body = generate_your_pdf_here()
  #       end
D
Initial  
David Heinemeier Hansson 已提交
199
  #     end
200
  #   end
D
David Heinemeier Hansson 已提交
201
  #
202
  #
D
David Heinemeier Hansson 已提交
203 204 205 206
  # = Configuration options
  #
  # These options are specified on the class level, like <tt>ActionMailer::Base.template_root = "/my/templates"</tt>
  #
207
  # * <tt>template_root</tt> - Determines the base from which template references will be made.
D
David Heinemeier Hansson 已提交
208 209 210 211
  #
  # * <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.
  #
212
  # * <tt>smtp_settings</tt> - Allows detailed configuration for <tt>:smtp</tt> delivery method:
P
Pratik Naik 已提交
213 214 215 216 217
  #   * <tt>:address</tt> - Allows you to use a remote mail server. Just change it from its default "localhost" setting.
  #   * <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.
218
  #   * <tt>:authentication</tt> - If your mail server requires authentication, you need to specify the authentication type here.
219
  #     This is a symbol and one of <tt>:plain</tt>, <tt>:login</tt>, <tt>:cram_md5</tt>.
220 221
  #   * <tt>:enable_starttls_auto</tt> - When set to true, detects if STARTTLS is enabled in your SMTP server and starts to use it.
  #     It works only on Ruby >= 1.8.7 and Ruby >= 1.9. Default is true.
D
David Heinemeier Hansson 已提交
222
  #
223 224 225
  # * <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>.
  #   * <tt>:arguments</tt> - The command line arguments. Defaults to <tt>-i -t</tt>.
P
Pratik Naik 已提交
226 227
  #
  # * <tt>raise_delivery_errors</tt> - Whether or not errors should be raised if the email fails to be delivered.
D
David Heinemeier Hansson 已提交
228
  #
229
  # * <tt>delivery_method</tt> - Defines a delivery method. Possible values are <tt>:smtp</tt> (default), <tt>:sendmail</tt>, and <tt>:test</tt>.
D
David Heinemeier Hansson 已提交
230
  #
P
Pratik Naik 已提交
231
  # * <tt>perform_deliveries</tt> - Determines whether <tt>deliver_*</tt> methods are actually carried out. By default they are,
D
David Heinemeier Hansson 已提交
232 233
  #   but this can be turned off to help functional testing.
  #
234
  # * <tt>deliveries</tt> - Keeps an array of all the emails sent out through the Action Mailer with <tt>delivery_method :test</tt>. Most useful
D
David Heinemeier Hansson 已提交
235
  #   for unit and functional testing.
D
David Heinemeier Hansson 已提交
236
  #
237
  # * <tt>default_charset</tt> - The default charset used for the body and to encode the subject. Defaults to UTF-8. You can also
238
  #   pick a different charset from inside a method with +charset+.
239
  #
D
David Heinemeier Hansson 已提交
240
  # * <tt>default_content_type</tt> - The default content type used for the main part of the message. Defaults to "text/plain". You
241
  #   can also pick a different content type from inside a method with +content_type+.
242
  #
243 244
  # * <tt>default_mime_version</tt> - The default mime version used for the message. Defaults to <tt>1.0</tt>. You
  #   can also pick a different value from inside a method with +mime_version+.
245
  #
D
David Heinemeier Hansson 已提交
246
  # * <tt>default_implicit_parts_order</tt> - When a message is built implicitly (i.e. multiple parts are assembled from templates
247
  #   which specify the content type in their filenames) this variable controls how the parts are ordered. Defaults to
248
  #   <tt>["text/html", "text/enriched", "text/plain"]</tt>. Items that appear first in the array have higher priority in the mail client
249
  #   and appear last in the mime encoded message. You can also pick a different order from inside a method with
250
  #   +implicit_parts_order+.
D
Initial  
David Heinemeier Hansson 已提交
251
  class Base
252
    include AdvAttrAccessor, PartContainer, Quoting, Utils
253 254
    if Object.const_defined?(:ActionController)
      include ActionController::UrlWriter
255
      include ActionController::Layout
256
    end
257

D
David Heinemeier Hansson 已提交
258
    private_class_method :new #:nodoc:
D
Initial  
David Heinemeier Hansson 已提交
259

260
    class_inheritable_accessor :view_paths
261 262
    self.view_paths = []

D
Initial  
David Heinemeier Hansson 已提交
263 264
    cattr_accessor :logger

265
    @@smtp_settings = {
266 267 268 269 270 271 272
      :address              => "localhost",
      :port                 => 25,
      :domain               => 'localhost.localdomain',
      :user_name            => nil,
      :password             => nil,
      :authentication       => nil,
      :enable_starttls_auto => true,
D
Initial  
David Heinemeier Hansson 已提交
273
    }
274
    cattr_accessor :smtp_settings
275

276 277 278 279 280
    @@sendmail_settings = {
      :location       => '/usr/sbin/sendmail',
      :arguments      => '-i -t'
    }
    cattr_accessor :sendmail_settings
D
Initial  
David Heinemeier Hansson 已提交
281 282 283 284

    @@raise_delivery_errors = true
    cattr_accessor :raise_delivery_errors

285 286
    superclass_delegating_accessor :delivery_method
    self.delivery_method = :smtp
287

D
Initial  
David Heinemeier Hansson 已提交
288 289
    @@perform_deliveries = true
    cattr_accessor :perform_deliveries
290

D
Initial  
David Heinemeier Hansson 已提交
291 292 293
    @@deliveries = []
    cattr_accessor :deliveries

294 295 296
    @@default_charset = "utf-8"
    cattr_accessor :default_charset

297 298
    @@default_content_type = "text/plain"
    cattr_accessor :default_content_type
299

300
    @@default_mime_version = "1.0"
301
    cattr_accessor :default_mime_version
302

303 304 305
    @@default_implicit_parts_order = [ "text/html", "text/enriched", "text/plain" ]
    cattr_accessor :default_implicit_parts_order

306 307 308
    cattr_reader :protected_instance_variables
    @@protected_instance_variables = %w(@body)

309 310
    # Specify the BCC addresses for the message
    adv_attr_accessor :bcc
311

312 313 314 315
    # Define the body of the message. This is either a Hash (in which case it
    # specifies the variables to pass to the template when it is rendered),
    # or a string, in which case it specifies the actual text of the message.
    adv_attr_accessor :body
316

317 318
    # Specify the CC addresses for the message.
    adv_attr_accessor :cc
319

320 321 322
    # Specify the charset to use for the message. This defaults to the
    # +default_charset+ specified for ActionMailer::Base.
    adv_attr_accessor :charset
323

324 325 326
    # Specify the content type for the message. This defaults to <tt>text/plain</tt>
    # in most cases, but can be automatically set in some situations.
    adv_attr_accessor :content_type
327

328 329
    # Specify the from address for the message.
    adv_attr_accessor :from
330

331 332 333 334
    # Specify the address (if different than the "from" address) to direct
    # replies to this message.
    adv_attr_accessor :reply_to

335 336
    # Specify additional headers to be added to the message.
    adv_attr_accessor :headers
337

338 339 340
    # Specify the order in which parts should be sorted, based on content-type.
    # This defaults to the value for the +default_implicit_parts_order+.
    adv_attr_accessor :implicit_parts_order
341

342 343
    # Defaults to "1.0", but may be explicitly given if needed.
    adv_attr_accessor :mime_version
344

345 346 347
    # The recipient addresses for the message, either as a string (for a single
    # address) or an array (for multiple addresses).
    adv_attr_accessor :recipients
348

349 350 351
    # The date on which the message was sent. If not set (the default), the
    # header will be set by the delivery agent.
    adv_attr_accessor :sent_on
352

353 354
    # Specify the subject of the message.
    adv_attr_accessor :subject
355

356 357 358 359
    # Specify the template name to use for current message. This is the "base"
    # template name, without the extension or directory, and may be used to
    # have multiple mailer methods share the same template.
    adv_attr_accessor :template
360

361 362 363 364 365 366 367 368 369 370
    # Override the mailer name, which defaults to an inflected version of the
    # mailer's class name. If you want to use a template in a non-standard
    # location, you can use this to specify that location.
    def mailer_name(value = nil)
      if value
        self.mailer_name = value
      else
        self.class.mailer_name
      end
    end
371

372 373 374 375
    def mailer_name=(value)
      self.class.mailer_name = value
    end

376 377
    # The mail object instance referenced by this mailer.
    attr_reader :mail
378
    attr_reader :template_name, :default_template_name, :action_name
379

380 381 382 383 384 385 386 387
    def controller_path
      self.class.controller_path
    end
    
    def formats
      @template.formats
    end

388
    class << self
389 390 391 392 393 394 395 396 397 398
      attr_writer :mailer_name

      def mailer_name
        @mailer_name ||= name.underscore
      end

      # for ActionView compatibility
      alias_method :controller_name, :mailer_name
      alias_method :controller_path, :mailer_name

399 400 401 402 403
      def respond_to?(method_symbol, include_private = false) #:nodoc:
        matches_dynamic_method?(method_symbol) || super
      end

      def method_missing(method_symbol, *parameters) #:nodoc:
404 405 406 407 408
        if match = matches_dynamic_method?(method_symbol)
          case match[1]
            when 'create'  then new(match[2], *parameters).mail
            when 'deliver' then new(match[2], *parameters).deliver!
            when 'new'     then nil
409
            else super
410 411 412
          end
        else
          super
413 414 415
        end
      end

416 417
      # 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 已提交
418 419
      # object's +receive+ method. If you want your mailer to be able to
      # process incoming messages, you'll need to implement a +receive+
420 421 422 423 424 425 426 427
      # method that accepts the email object as a parameter:
      #
      #   class MyMailer < ActionMailer::Base
      #     def receive(mail)
      #       ...
      #     end
      #   end
      def receive(raw_email)
428 429 430 431 432 433 434 435 436 437 438 439 440 441 442
        logger.info "Received mail:\n #{raw_email}" unless logger.nil?
        mail = TMail::Mail.parse(raw_email)
        mail.base64_decode
        new.receive(mail)
      end

      # Deliver the given mail object directly. This can be used to deliver
      # a preconstructed mail object, like:
      #
      #   email = MyMailer.create_some_mail(parameters)
      #   email.set_some_obscure_header "frobnicate"
      #   MyMailer.deliver(email)
      def deliver(mail)
        new.deliver!(mail)
      end
443

444 445 446 447
      def template_root
        self.view_paths && self.view_paths.first
      end

448
      def template_root=(root)
449
        self.view_paths = ActionView::Base.process_view_paths(root)
450
      end
451 452 453 454

      private
        def matches_dynamic_method?(method_name) #:nodoc:
          method_name = method_name.to_s
455
          /^(create|deliver)_([_a-z]\w*)/.match(method_name) || /^(new)$/.match(method_name)
456
        end
457 458
    end

459 460 461 462
    # 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).
463
    def initialize(method_name=nil, *parameters) #:nodoc:
464
      create!(method_name, *parameters) if method_name
465 466 467 468
    end

    # Initialize the mailer via the given +method_name+. The body will be
    # rendered and a new TMail::Mail object created.
469
    def create!(method_name, *parameters) #:nodoc:
470
      initialize_defaults(method_name)
471
      __send__(method_name, *parameters)
472
      
473 474 475 476
      # If an explicit, textual body has not been set, we check assumptions.
      unless String === @body
        # First, we look to see if there are any likely templates that match,
        # which include the content-type in their file name (i.e.,
477
        # "the_template_file.text.html.erb", etc.). Only do this if parts
478
        # have not already been specified manually.
479 480
        # if @parts.empty?
          template_root.find_all_by_parts(@template, {}, template_path).each do |template|
481
            @parts << Part.new(
482
              :content_type => template.mime_type ? template.mime_type.to_s : "text/plain",
483 484
              :disposition => "inline",
              :charset => charset,
485
              :body => render_template(template, @body)
486
            )
487
          end
488 489
          
          if @parts.size > 1
490
            @content_type = "multipart/alternative" if @content_type !~ /^multipart/
491 492
            @parts = sort_parts(@parts, @implicit_parts_order)
          end
493 494
        # end
        
495 496 497 498
        # Then, if there were such templates, we check to see if we ought to
        # also render a "normal" template (without the content type). If a
        # normal template exists (or if there were no implicit parts) we render
        # it.
499 500 501
        # ====
        # TODO: Revisit this
        # template_exists = @parts.empty?
502
        # template_exists ||= template_root.find("#{mailer_name}/#{@template}")
503
        # @body = render_message(@template, @body) if template_exists
504 505 506 507

        # Finally, if there are other message parts and a textual body exists,
        # we shift it onto the front of the parts and set the body to nil (so
        # that create_mail doesn't try to render it in addition to the parts).
508 509 510 511 512 513
        # ====
        # TODO: Revisit this
        # if !@parts.empty? && String === @body
        #   @parts.unshift Part.new(:charset => charset, :body => @body)
        #   @body = nil
        # end
D
Initial  
David Heinemeier Hansson 已提交
514 515
      end

516 517 518 519
      # If this is a multipart e-mail add the mime_version if it is not
      # already set.
      @mime_version ||= "1.0" if !@parts.empty?

520 521 522
      # build the mail object itself
      @mail = create_mail
    end
D
Initial  
David Heinemeier Hansson 已提交
523

524
    # Delivers a TMail::Mail object. By default, it delivers the cached mail
P
Pratik Naik 已提交
525
    # object (from the <tt>create!</tt> method). If no cached mail object exists, and
526
    # no alternate has been given as the parameter, this will fail.
527
    def deliver!(mail = @mail)
528
      raise "no mail object available for delivery!" unless mail
529
      
530
      unless logger.nil?
531
        logger.info  "Sent mail to #{Array(recipients).join(', ')}"
532 533
        logger.debug "\n#{mail.encoded}"
      end
534

535
      begin
536
        __send__("perform_delivery_#{delivery_method}", mail) if perform_deliveries
537
      rescue Exception => e  # Net::SMTP errors or sendmail pipe errors
538 539
        raise e if raise_delivery_errors
      end
540

541
      return mail
542
    end
543

544
    private
545 546 547 548
      # Set up the default values for the various instance variables of this
      # mailer. Subclasses may override this method to provide different
      # defaults.
      def initialize_defaults(method_name)
549 550 551 552
        @charset ||= @@default_charset.dup
        @content_type ||= @@default_content_type.dup
        @implicit_parts_order ||= @@default_implicit_parts_order.dup
        @template ||= method_name
553
        @default_template_name = @action_name = @template
554
        @mailer_name ||= self.class.name.underscore
555 556 557
        @parts ||= []
        @headers ||= {}
        @body ||= {}
558
        @mime_version = @@default_mime_version.dup if @@default_mime_version
559
        @sent_on ||= Time.now
560 561
      end

562
      def render_template(template, body)
563 564
        if template.respond_to?(:mime_type)
          @current_template_content_type = template.mime_type && template.mime_type.to_sym.to_s
565
        end
566 567
        
        @template = initialize_template_class(body)
568 569
        layout = _pick_layout(layout, true) unless 
          ActionController::Base.exempt_from_layout.include?(template.handler)
570
        @template._render_template(template, layout, {})
571 572 573 574 575
      ensure
        @current_template_content_type = nil
      end

      def render_message(method_name, body)
576
        render :file => method_name, :body => body
577 578
      ensure
        @current_template_content_type = nil
579
      end
580 581

      def render(opts)
582 583
        layout, file = opts.delete(:layout), opts[:file]
        
584
        begin
585 586 587 588
          @template = initialize_template_class(opts.delete(:body))
          
          if file
            prefix = mailer_name unless file =~ /\//
589
            template = view_paths.find(file, {:formats => formats}, prefix)
590 591 592
          end

          layout = _pick_layout(layout, 
593
            !template || ActionController::Base.exempt_from_layout.include?(template.handler))
594 595

          if template
596
            @template._render_template(template, layout, opts)
597 598 599
          elsif inline = opts[:inline]
            @template._render_inline(inline, layout, opts)
          end
600 601 602 603
        end
      end

      def default_template_format
604 605 606 607 608
        if @current_template_content_type
          Mime::Type.lookup(@current_template_content_type).to_sym
        else
          :html
        end
609 610
      end

611 612 613 614 615 616 617 618
      def template_root
        self.class.template_root
      end

      def template_root=(root)
        self.class.template_root = root
      end

619
      def template_path
620
        "#{mailer_name}"
D
Initial  
David Heinemeier Hansson 已提交
621 622
      end

J
Jamis Buck 已提交
623
      def initialize_template_class(assigns)
624
        template = ActionView::Base.new(self.class.view_paths, assigns, self)
625
        template.formats = [default_template_format]
626
        template
J
Jamis Buck 已提交
627 628
      end

629 630
      def sort_parts(parts, order = [])
        order = order.collect { |s| s.downcase }
631
        
632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657
        parts = parts.sort do |a, b|
          a_ct = a.content_type.downcase
          b_ct = b.content_type.downcase

          a_in = order.include? a_ct
          b_in = order.include? b_ct

          s = case
          when a_in && b_in
            order.index(a_ct) <=> order.index(b_ct)
          when a_in
            -1
          when b_in
            1
          else
            a_ct <=> b_ct
          end

          # reverse the ordering because parts that come last are displayed
          # first in mail clients
          (s * -1)
        end

        parts
      end

658 659
      def create_mail
        m = TMail::Mail.new
660

661 662 663 664 665
        m.subject,     = quote_any_if_necessary(charset, subject)
        m.to, m.from   = quote_any_address_if_necessary(charset, recipients, from)
        m.bcc          = quote_address_if_necessary(bcc, charset) unless bcc.nil?
        m.cc           = quote_address_if_necessary(cc, charset) unless cc.nil?
        m.reply_to     = quote_address_if_necessary(reply_to, charset) unless reply_to.nil?
666
        m.mime_version = mime_version unless mime_version.nil?
667 668
        m.date         = sent_on.to_time rescue sent_on if sent_on

669
        headers.each { |k, v| m[k] = v }
D
Initial  
David Heinemeier Hansson 已提交
670

671
        real_content_type, ctype_attrs = parse_content_type
672
        
673
        if @parts.empty?
674
          m.set_content_type(real_content_type, nil, ctype_attrs)
675
          m.body = normalize_new_lines(body)
676 677 678
        elsif @parts.size == 1 && @parts.first.parts.empty?
          m.set_content_type(real_content_type, nil, ctype_attrs)
          m.body = normalize_new_lines(@parts.first.body)
679 680 681
        else
          if String === body
            part = TMail::Mail.new
682
            part.body = normalize_new_lines(body)
683
            part.set_content_type(real_content_type, nil, ctype_attrs)
684 685 686
            part.set_content_disposition "inline"
            m.parts << part
          end
687

688 689 690 691
          @parts.each do |p|
            part = (TMail::Mail === p ? p : p.to_mail(self))
            m.parts << part
          end
692

693 694 695 696
          if real_content_type =~ /multipart/
            ctype_attrs.delete "charset"
            m.set_content_type(real_content_type, nil, ctype_attrs)
          end
697
        end
698

699
        @mail = m
700 701
      end

702
      def perform_delivery_smtp(mail)
703 704
        destinations = mail.destinations
        mail.ready_to_send
705
        sender = (mail['return-path'] && mail['return-path'].spec) || mail['from']
706

707
        smtp = Net::SMTP.new(smtp_settings[:address], smtp_settings[:port])
708
        smtp.enable_starttls_auto if smtp_settings[:enable_starttls_auto] && smtp.respond_to?(:enable_starttls_auto)
709 710
        smtp.start(smtp_settings[:domain], smtp_settings[:user_name], smtp_settings[:password],
                   smtp_settings[:authentication]) do |smtp|
711
          smtp.sendmail(mail.encoded, sender, destinations)
712
        end
713 714
      end

715
      def perform_delivery_sendmail(mail)
716 717 718
        sendmail_args = sendmail_settings[:arguments]
        sendmail_args += " -f \"#{mail['return-path']}\"" if mail['return-path']
        IO.popen("#{sendmail_settings[:location]} #{sendmail_args}","w+") do |sm|
719
          sm.print(mail.encoded.gsub(/\r/, ''))
720
          sm.flush
721 722 723
        end
      end

724 725 726
      def perform_delivery_test(mail)
        deliveries << mail
      end
D
Initial  
David Heinemeier Hansson 已提交
727
  end
728 729 730 731 732

  Base.class_eval do
    include Helpers
    helper MailHelper
  end
D
Initial  
David Heinemeier Hansson 已提交
733
end