Update docs to reflect changes to MailerGenerator.

1 files changed, 17 insertions, 11 deletions

diff --git a/actionmailer/lib/action_mailer/base.rb b/actionmailer/lib/action_mailer/base.rb
index a70bf1544a..23139bcbe8 100644
--- a/actionmailer/lib/action_mailer/base.rb
+++ b/actionmailer/lib/action_mailer/base.rb
@@ -15,11 +15,17 @@ module ActionMailer
   #
   #   $ rails generate mailer Notifier
   #
-  # The generated model inherits from <tt>ActionMailer::Base</tt>. A mailer model defines methods
+  # The generated model inherits from <tt>ApplicationMailer</tt> which in turn
+  # inherits from <tt>ActionMailer::Base</tt>. A mailer model defines methods
   # used to generate an email message. In these methods, you can setup variables to be used in
   # the mailer views, options on the mail itself such as the <tt>:from</tt> address, and attachments.
   #
-  #   class Notifier < ActionMailer::Base
+  #   class ApplicationMailer < ActionMailer::Base
+  #     default from: 'from@exmaple.com'
+  #     layout 'mailer'
+  #   end
+  #
+  #   class Notifier < ApplicationMailer
   #     default from: 'no-reply@example.com',
   #             return_path: 'system@example.com'
   #
@@ -84,7 +90,7 @@ module ActionMailer
   # name as the method in your mailer model. For example, in the mailer defined above, the template at
   # <tt>app/views/notifier/welcome.text.erb</tt> would be used to generate the email.
   #
-  # Variables defined in the methods of your mailer model are accessible as instance variables in their 
+  # Variables defined in the methods of your mailer model are accessible as instance variables in their
   # corresponding view.
   #
   # Emails by default are sent in plain text, so a sample view for our model example might look like this:
@@ -178,7 +184,7 @@ module ActionMailer
   #
   # Sending attachment in emails is easy:
   #
-  #   class ApplicationMailer < ActionMailer::Base
+  #   class Notifier < ApplicationMailer
   #     def welcome(recipient)
   #       attachments['free_book.pdf'] = File.read('path/to/file.pdf')
   #       mail(to: recipient, subject: "New account information")
@@ -194,7 +200,7 @@ module ActionMailer
   # If you need to send attachments with no content, you need to create an empty view for it,
   # or add an empty body parameter like this:
   #
-  #     class ApplicationMailer < ActionMailer::Base
+  #     class Notifier < ApplicationMailer
   #       def welcome(recipient)
   #         attachments['free_book.pdf'] = File.read('path/to/file.pdf')
   #         mail(to: recipient, subject: "New account information", body: "")
@@ -206,7 +212,7 @@ module ActionMailer
   # You can also specify that a file should be displayed inline with other HTML. This is useful
   # if you want to display a corporate logo or a photo.
   #
-  #   class ApplicationMailer < ActionMailer::Base
+  #   class Notifier < ApplicationMailer
   #     def welcome(recipient)
   #       attachments.inline['photo.png'] = File.read('path/to/photo.png')
   #       mail(to: recipient, subject: "Here is what we look like")
@@ -245,7 +251,7 @@ module ActionMailer
   # Action Mailer provides some intelligent defaults for your emails, these are usually specified in a
   # default method inside the class definition:
   #
-  #   class Notifier < ActionMailer::Base
+  #   class Notifier < ApplicationMailer
   #     default sender: 'system@example.com'
   #   end
   #
@@ -263,7 +269,7 @@ module ActionMailer
   # As you can pass in any header, you need to either quote the header as a string, or pass it in as
   # an underscored symbol, so the following will work:
   #
-  #   class Notifier < ActionMailer::Base
+  #   class Notifier < ApplicationMailer
   #     default 'Content-Transfer-Encoding' => '7bit',
   #             content_description: 'This is a description'
   #   end
@@ -271,7 +277,7 @@ module ActionMailer
   # Finally, Action Mailer also supports passing <tt>Proc</tt> objects into the default hash, so you
   # can define methods that evaluate as the message is being generated:
   #
-  #   class Notifier < ActionMailer::Base
+  #   class Notifier < ApplicationMailer
   #     default 'X-Special-Header' => Proc.new { my_method }
   #
   #     private
@@ -296,7 +302,7 @@ module ActionMailer
   # This may be useful, for example, when you want to add default inline attachments for all
   # messages sent out by a certain mailer class:
   #
-  #   class Notifier < ActionMailer::Base
+  #   class Notifier < ApplicationMailer
   #     before_action :add_inline_attachment!
   #
   #     def welcome
@@ -703,7 +709,7 @@ module ActionMailer
     # 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.
     #
-    # It accepts a headers hash. This hash allows you to specify 
+    # It accepts a headers hash. This hash allows you to specify
     # the most used headers in an email message, these are:
     #
     # * +:subject+ - The subject of the message, if this is omitted, Action Mailer will