diff options
| author | Zachary Scott <e@zzak.io> | 2015-04-12 13:31:29 -0700 |
|---|---|---|
| committer | Zachary Scott <e@zzak.io> | 2015-04-12 13:31:29 -0700 |
| commit | 9cabd35d4300208e1e038ee5720cf6ab6fd2018a (patch) | |
| tree | 1887a46502994345d4ce5f8d59b06c4a58b77e37 /actionmailer/lib | |
| parent | 08a3baa380f9f5189f50abecba657de2d5659845 (diff) | |
| parent | a647277fb9172f8434d961e6fa3b90f234b67c4e (diff) | |
| download | rails-9cabd35d4300208e1e038ee5720cf6ab6fd2018a.tar.gz rails-9cabd35d4300208e1e038ee5720cf6ab6fd2018a.tar.bz2 rails-9cabd35d4300208e1e038ee5720cf6ab6fd2018a.zip | |
Merge branch 'mfazekas-action-mailer-async-doc-fixes'
Diffstat (limited to 'actionmailer/lib')
| -rw-r--r-- | actionmailer/lib/action_mailer/base.rb | 19 |
1 files changed, 11 insertions, 8 deletions
diff --git a/actionmailer/lib/action_mailer/base.rb b/actionmailer/lib/action_mailer/base.rb index c7f09ed192..6ddc4c9596 100644 --- a/actionmailer/lib/action_mailer/base.rb +++ b/actionmailer/lib/action_mailer/base.rb @@ -134,25 +134,28 @@ module ActionMailer # # = Sending mail # - # Once a mailer action and template are defined, you can deliver your message or create it and save it - # for delivery later: + # Once a mailer action and template are defined, you can deliver your message or defer its creation and + # delivery for later: # # NotifierMailer.welcome(User.first).deliver_now # sends the email # mail = NotifierMailer.welcome(User.first) # => an ActionMailer::MessageDelivery object - # mail.deliver_now # sends the email + # mail.deliver_now # generates and sends the email now # - # The <tt>ActionMailer::MessageDelivery</tt> class is a wrapper around a <tt>Mail::Message</tt> object. If - # you want direct access to the <tt>Mail::Message</tt> object you can call the <tt>message</tt> method on - # the <tt>ActionMailer::MessageDelivery</tt> object. + # The <tt>ActionMailer::MessageDelivery</tt> class is a wrapper around a delegate that will call + # your method to generate the mail. If you want direct access to delegator, or <tt>Mail::Message</tt>, + # you can call the <tt>message</tt> method on the <tt>ActionMailer::MessageDelivery</tt> object. # # NotifierMailer.welcome(User.first).message # => a Mail::Message object # - # Action Mailer is nicely integrated with Active Job so you can send emails in the background (example: outside - # of the request-response cycle, so the user doesn't have to wait on it): + # Action Mailer is nicely integrated with Active Job so you can generate and send emails in the background + # (example: outside of the request-response cycle, so the user doesn't have to wait on it): # # NotifierMailer.welcome(User.first).deliver_later # enqueue the email sending to Active Job # + # Note that <tt>deliver_later</tt> will execute your method from the background job. + # # You never instantiate your mailer class. Rather, you just call the method you defined on the class itself. + # All instance method are expected to return a message object to be sent. # # = Multipart Emails # |