Merge docrails along with the new guides and guides generation code

author: Pratik Naik <pratiknaik@gmail.com> 2009-02-06 01:57:02 +0000
committer: Pratik Naik <pratiknaik@gmail.com> 2009-02-06 02:01:22 +0000
commit: 96d610553e5fdaabc923835ab1f194070ddb4477 (patch)
tree: 5154390d4f47971d522619db9f3826abb771b42f /railties/guides/source/action_mailer_basics.textile
parent: bccd2c54b2c7708f881faf9c9464dcf29bd30bef (diff)
download: rails-96d610553e5fdaabc923835ab1f194070ddb4477.tar.gz
rails-96d610553e5fdaabc923835ab1f194070ddb4477.tar.bz2
rails-96d610553e5fdaabc923835ab1f194070ddb4477.zip
1 files changed, 423 insertions, 0 deletions
diff --git a/railties/guides/source/action_mailer_basics.textile b/railties/guides/source/action_mailer_basics.textile
new file mode 100644
index 0000000000..9c56691dc1
--- /dev/null
+++ b/railties/guides/source/action_mailer_basics.textile
@@ -0,0 +1,423 @@
+h2. Action Mailer Basics
+
+This guide should provide you with all you need to get started in sending and receiving emails from/to your application, and many internals of Action Mailer. It will also cover how to test your mailers.
+
+endprologue.
+
+h3. Introduction
+
+Action Mailer allows you to send email from your application using a mailer model and views. Yes, that is correct, in Rails, emails are used by creating models that inherit from ActionMailer::Base. They live alongside other models in `app/models` but they have views just like controllers that appear alongside other views in `app/views`.
+
+h3. Sending Emails
+
+Let's say you want to send a welcome email to a user after they signup. Here is how you would go about this:
+
+h4. Walkthrough to generating a mailer
+
+h5. Create the mailer:
+
+<shell>
+./script/generate mailer UserMailer
+exists  app/models/
+create  app/views/user_mailer
+exists  test/unit/
+create  test/fixtures/user_mailer
+create  app/models/user_mailer.rb
+create  test/unit/user_mailer_test.rb
+</shell>
+
+So we got the model, the fixtures, and the tests all created for us
+
+h5. Edit the model:
+
+If you look at +app/models/user_mailer.rb+, you will see:
+
+<ruby>
+class UserMailer < ActionMailer::Base
+end
+</ruby>
+
+Lets add a method called +welcome_email+, that will send an email to the user's registered email address:
+
+<ruby>
+class UserMailer < ActionMailer::Base
+
+  def welcome_email(user)
+    recipients    user.email
+    from          "My Awesome Site Notifications <notifications@example.com>"
+    subject       "Welcome to My Awesome Site"
+    sent_on       Time.now
+    body          {:user => user, :url => "http://example.com/login"}
+    content_type  "text/html"
+  end
+
+end
+</ruby>
+
+So what do we have here?
+
+|recipients| The recipients of the email. It can be a string or, if there are multiple recipients, an array of strings|
+|from| Who the email will appear to come from in the recipients' mailbox|
+|subject| The subject of the email|
+|sent_on| Timestamp for the email|
+|content_type| The content type, by default is text/plain|
+
+The keys of the hash passed to `body` become instance variables in the view. Thus, in our example the mailer view will have a @user and a @url instance variables available.
+
+h5. Create the mailer view
+
+Create a file called +welcome_email.html.erb+ in +#{RAILS_ROOT}/app/views/user_mailer/+. This will be the template used for the email. This file will be used for html formatted emails. Had we wanted to send text-only emails, the file would have been called +welcome_email.txt.erb+, and we would have set the content type to text/plain in the mailer model.
+
+The file can look like:
+
+<erb>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+  <head>
+    <meta content="text/html; charset=UTF-8" http-equiv="Content-Type" />
+  </head>
+  <body>
+    <h1>Welcome to example.com, <%=h @user.first_name %></h1>
+    <p>
+      You have successfully signed up to example.com, and your username is: <%= @user.login %>.<br/>
+      To login to the site, just follow this link: <%=h @url %>.
+    </p>
+    <p>Thanks for joining and have a great day!</p>
+  </body>
+</html>
+</erb>
+
+h5. Wire it up so that the system sends the email when a user signs up
+
+There are three ways to achieve this. One is to send the email from the controller that sends the email, another is to put it in a +before_create+ callback in the user model, and the last one is to use an observer on the user model. Whether you use the second or third methods is up to you, but staying away from the first is recommended. Not because it's wrong, but because it keeps your controller clean, and keeps all logic related to the user model within the user model. This way, whichever way a user is created (from a web form, or from an API call, for example), we are guaranteed that the email will be sent.
+
+Let's see how we would go about wiring it up using an observer:
+
+In +config/environment.rb+:
+
+<ruby>
+# Code that already exists
+Rails::Initializer.run do |config|
+  # Code that already exists
+  config.active_record.observers = :user_observer
+end
+</ruby>
+
+There was a bit of a debate on where to put observers. Some people put them in app/models, but a cleaner method may be to create an app/observers folder to store all observers, and add that to your load path. Open +config/environment.rb+ and make it look like:
+
+<ruby>
+# Code that already exists
+Rails::Initializer.run do |config|
+  # Code that already exists
+  config.load_paths += %W(#{RAILS_ROOT}/app/observers)
+  config.active_record.observers = :user_observer
+end
+</ruby>
+
+Now create a file called user_observer in +app/models+ or +app/observers+ depending on where you stored it, and make it look like:
+
+<ruby>
+class UserObserver < ActiveRecord::Observer
+  def after_create(user)
+    UserMailer.deliver_welcome_email(user)
+  end
+end
+</ruby>
+
+Notice how we call +deliver_welcome_email+? Where is that method? Well if you remember, we created a method called +welcome_email+ in UserMailer, right? Well, as part of the "magic" of Rails, we deliver the email identified by +welcome_email+ by calling +deliver_welcome_email+. The next section will go through this in more detail.
+
+That's it! Now whenever your users signup, they will be greeted with a nice welcome email.
+
+h4. Action Mailer and dynamic deliver_<method> methods
+
+So how does Action Mailer understand this deliver_welcome_email call? If you read the documentation (http://api.rubyonrails.org/files/vendor/rails/actionmailer/README.html), you will find this in the "Sending Emails" section:
+
+You never instantiate your mailer class. Rather, your delivery instance methods are automatically wrapped in class methods that start with the word +deliver_+ followed by the name of the mailer method that you would like to deliver. The +welcome_email+ method defined above is delivered by invoking +Notifier.deliver_welcome_email+.
+
+So, how exactly does this work?
+
+In +ActionMailer::Base+, you will find this:
+
+<ruby>
+def method_missing(method_symbol, *parameters)#:nodoc:
+  case method_symbol.id2name
+    when /^create_([_a-z]\w*)/  then new($1, *parameters).mail
+    when /^deliver_([_a-z]\w*)/ then new($1, *parameters).deliver!
+    when "new" then nil
+    else super
+  end
+end
+</ruby>
+
+Hence, if the method name starts with +deliver_+ followed by any combination of lowercase letters or underscore, +method_missing+  calls +new+ on your mailer class (+UserMailer+ in our example above), sending the combination of lower case letters or underscore, along with the parameters. The resulting object is then sent the +deliver!+ method, which well... delivers it.
+
+h4. Complete List of ActionMailer user-settable attributes
+
+|bcc| Specify the BCC addresses for the message|
+|body| 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.|
+|cc| Specify the CC addresses for the message.|
+|charset| Specify the charset to use for the message. This defaults to the default_charset specified for ActionMailer::Base.|
+|content_type| Specify the content type for the message. This defaults to <text/plain in most cases, but can be automatically set in some situations.|
+|from| Specify the from address for the message.|
+|reply_to| Specify the address (if different than the "from" address) to direct replies to this message.|
+|headers| Specify additional headers to be added to the message.|
+|implicit_parts_order| Specify the order in which parts should be sorted, based on content-type. This defaults to the value for the default_implicit_parts_order.|
+|mime_version| Defaults to "1.0", but may be explicitly given if needed.|
+|recipient| The recipient addresses for the message, either as a string (for a single address) or an array (for multiple addresses).|
+|sent_on| The date on which the message was sent. If not set (the default), the header will be set by the delivery agent.|
+|subject| Specify the subject of the message.|
+|template| 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.|
+
+h4. Mailer Views
+
+Mailer views are located in /app/views/name_of_mailer_class. The specific mailer view is known to the class because it's name is the same as the mailer method. So for example, in our example from above, our mailer view for the welcome_email method will be in /app/views/user_mailer/welcome_email.html.erb for the html version and welcome_email.txt.erb for the plain text version.
+
+To change the default mailer view for your action you do something like:
+
+<ruby>
+class UserMailer < ActionMailer::Base
+
+  def welcome_email(user)
+    recipients    user.email
+    from          "My Awesome Site Notifications<notifications@example.com>"
+    subject       "Welcome to My Awesome Site"
+    sent_on       Time.now
+    body          {:user => user, :url => "http://example.com/login"}
+    content_type  "text/html"
+
+    # change the default from welcome_email.[html, txt].erb
+    template "some_other_template" # this will be in app/views/user_mailer/some_other_template.[html, txt].erb
+  end
+
+end
+</ruby>
+
+h4. Action Mailer Layouts
+
+Just like controller views, you can also have mailer layouts. The layout name needs to end in _mailer to be automatically recognized by your mailer as a layout. So in our UserMailer example, we need to call our layout user_mailer.[html,txt].erb. In order to use a different file just use:
+
+<ruby>
+class UserMailer < ActionMailer::Base
+
+  layout 'awesome' # will use awesome.html.erb as the layout
+
+end
+</ruby>
+
+Just like with controller views, use yield to render the view inside the layout.
+
+h4. Generating URL's in Action Mailer views
+
+URLs can be generated in mailer views using url_for 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.
+
+When using url_for you'll need to provide the :host, :controller, and :action:
+
+<erb>
+<%= url_for(:host => "example.com", :controller => "welcome", :action => "greeting") %>
+</erb>
+
+When using named routes you only need to supply the :host:
+
+<erb>
+<%= users_url(:host => "example.com") %>
+</erb>
+
+You will want to avoid using the name_of_route_path form of named routes because it doesn't make sense to generate relative URLs in email messages. The reason that it doesn't make sense is because the email is opened on a mail client outside of your environment. Since the email is not being served by your server, a URL like "/users/show/1", will have no context. In order for the email client to properly link to a URL on your server it needs something like "http://yourserver.com/users/show/1".
+
+It is also possible to set a default host that will be used in all mailers by setting the :host option in
+the ActionMailer::Base.default_url_options hash as follows:
+
+<erb>
+ActionMailer::Base.default_url_options[:host] = "example.com"
+</erb>
+
+This can also be set as a configuration option in config/environment.rb:
+
+<erb>
+config.action_mailer.default_url_options = { :host => "example.com" }
+</erb>
+
+If you do decide to set a default :host for your mailers you will want to use the :only_path => false option when using url_for. This will ensure that absolute URLs are generated because the url_for view helper will, by default, generate relative URLs when a :host option isn't explicitly provided.
+
+h4. Sending multipart emails
+
+Action Mailer will automatically send multipart emails if you have different templates for the same action. So, for our UserMailer example, if you have welcome_email.txt.erb and welcome_email.html.erb in app/views/user_mailer, Action Mailer will automatically send a multipart email with the html and text versions setup as different parts.
+
+To explicitly specify multipart messages, you can do something like:
+
+<ruby>
+class UserMailer < ActionMailer::Base
+
+  def welcome_email(user)
+    recipients      user.email_address
+    subject         "New account information"
+    from            "system@example.com"
+    content_type    "multipart/alternative"
+
+    part :content_type => "text/html",
+      :body => "<p>html content, can also be the name of an action that you call<p>"
+
+    part "text/plain" do |p|
+      p.body = "text content, can also be the name of an action that you call"
+    end
+  end
+
+end
+</ruby>
+
+h4. Sending emails with attachments
+
+Attachments can be added by using the attachment method:
+
+<ruby>
+class UserMailer < ActionMailer::Base
+
+  def welcome_email(user)
+    recipients      user.email_address
+    subject         "New account information"
+    from            "system@example.com"
+    content_type    "multipart/alternative"
+
+    attachment :content_type => "image/jpeg",
+      :body => File.read("an-image.jpg")
+
+    attachment "application/pdf" do |a|
+      a.body = generate_your_pdf_here()
+    end
+  end
+
+end
+</ruby>
+
+h3. Receiving Emails
+
+Receiving and parsing emails with Action Mailer can be a rather complex endeavour. Before your email reaches your Rails app, you would have had to configure your system to somehow forward emails to your app, which needs to be listening for that.
+So, to receive emails in your Rails app you'll need:
+
+1. Configure your email server to forward emails from the address(es) you would like your app to receive to /path/to/app/script/runner \'UserMailer.receive(STDIN.read)'
+
+2. Implement a receive method in your mailer
+
+Once a method called receive is defined in any mailer, Action Mailer will parse the raw incoming email into an email object, decode it, instantiate a new mailer, and pass the email object to the mailer object‘s receive method. Here's an example:
+
+<ruby>
+class UserMailer < ActionMailer::Base
+
+  def receive(email)
+    page = Page.find_by_address(email.to.first)
+    page.emails.create(
+      :subject => email.subject,
+      :body => email.body
+    )
+
+    if email.has_attachments?
+      for attachment in email.attachments
+        page.attachments.create({
+          :file => attachment,
+          :description => email.subject
+        })
+      end
+    end
+  end
+
+
+end
+</ruby>
+
+
+h3. Using Action Mailer Helpers
+
+Action Mailer classes have 4 helper methods available to them:
+
+|add_template_helper(helper_module)|Makes all the (instance) methods in the helper module available to templates rendered through this controller.|
+|helper(*args, &block)| Declare a helper: helper :foo requires 'foo_helper' and includes FooHelper in the template class.  helper FooHelper includes FooHelper in the template class.  helper { def foo() "#{bar} is the very best" end } evaluates the block in the template class, adding method foo.  helper(:three, BlindHelper) { def mice() 'mice' end } does all three. |
+|helper_method| Declare a controller method as a helper.  For example, helper_method :link_to def link_to(name, options) ... end makes the link_to controller method available in the view.|
+|helper_attr| Declare a controller attribute as a helper.  For example, helper_attr :name attr_accessor :name makes the name and name= controller methods available in the view.  The is a convenience wrapper for helper_method.|
+
+h3. Action Mailer Configuration
+
+The following configuration options are best made in one of the environment files (environment.rb, production.rb, etc...)
+
+|template_root|Determines the base from which template references will be made.|
+|logger|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.|
+|smtp_settings|Allows detailed configuration for :smtp delivery method: :address - Allows you to use a remote mail server. Just change it from its default "localhost" setting.  :port  - On the off chance that your mail server doesn't run on port 25, you can change it.  :domain - If you need to specify a HELO domain, you can do it here.  :user_name - If your mail server requires authentication, set the username in this setting.  :password - If your mail server requires authentication, set the password in this setting.  :authentication - If your mail server requires authentication, you need to specify the authentication type here. This is a symbol and one of :plain, :login, :cram_md5.|
+|sendmail_settings|Allows you to override options for the :sendmail delivery method.  :location - The location of the sendmail executable. Defaults to /usr/sbin/sendmail.  :arguments - The command line arguments. Defaults to -i -t.|
+|raise_delivery_errors|Whether or not errors should be raised if the email fails to be delivered.|
+|delivery_method|Defines a delivery method. Possible values are :smtp (default), :sendmail, and :test.|
+|perform_deliveries|Determines whether deliver_* methods are actually carried out. By default they are, but this can be turned off to help functional testing.|
+|deliveries|Keeps an array of all the emails sent out through the Action Mailer with delivery_method :test. Most useful for unit and functional testing.|
+|default_charset|The default charset used for the body and to encode the subject. Defaults to UTF-8. You can also  pick a different charset from inside a method with charset.|
+|default_content_type|The default content type used for the main part of the message. Defaults to "text/plain". You can also pick a different content type from inside a method with content_type.|
+|default_mime_version|The default mime version used for the message. Defaults to 1.0. You can also pick a different value from inside a method with mime_version.|
+|default_implicit_parts_order|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. Defaults to ["text/html", "text/enriched", "text/plain"]. Items that appear first in the array have higher priority in the mail client and appear last in the mime encoded message. You can also pick a different order from inside a method with implicit_parts_order.|
+
+
+h4. Example Action Mailer Configuration
+
+An example would be:
+
+<ruby>
+ActionMailer::Base.delivery_method = :sendmail
+ActionMailer::Base.sendmail_settings = {
+  :location => '/usr/sbin/sendmail',
+  :arguments => '-i -t'
+}
+ActionMailer::Base.perform_deliveries = true
+ActionMailer::Base.raise_delivery_errors = true
+ActionMailer::Base.default_charset = "iso-8859-1"
+</ruby>
+
+h4. Action Mailer Configuration for GMail
+
+Instructions copied from http://http://www.fromjavatoruby.com/2008/11/actionmailer-with-gmail-must-issue.html
+
+First you must install the action_mailer_tls plugin from http://code.openrain.com/rails/action_mailer_tls/, then all you have to do is configure action mailer.
+
+<ruby>
+ActionMailer::Base.smtp_settings = {
+  :address        => "smtp.gmail.com",
+  :port           => 587,
+  :domain         => "domain.com",
+  :user_name      => "user@domain.com",
+  :password       => "password",
+  :authentication => :plain
+}
+</ruby>
+
+h4. Configure Action Mailer to recognize HAML templates
+
+In environment.rb, add the following line:
+
+<ruby>
+ActionMailer::Base.register_template_extension('haml')
+</ruby>
+
+h3. Mailer Testing
+
+Testing mailers involves 2 things. One is that the mail was queued and the other that the body contains what we expect it to contain. With that in mind, we could test our example mailer from above like so:
+
+<ruby>
+class UserMailerTest < ActionMailer::TestCase
+    tests UserMailer
+
+    def test_welcome_email
+      user = users(:some_user_in_your_fixtures)
+
+      # Send the email, then test that it got queued
+      email = UserMailer.deliver_welcome_email(user)
+      assert !ActionMailer::Base.deliveries.empty?
+
+      # Test the body of the sent email contains what we expect it to
+      assert_equal [@user.email],                 email.to
+      assert_equal "Welcome to My Awesome Site",  email.subject
+      assert       email.body =~ /Welcome to example.com, #{user.first_name}/
+    end
+  end
+</ruby>
+
+What have we done? Well, we sent the email and stored the returned object in the email variable. We then ensured that it was sent (the first assert), then, in the second batch of assertion, we ensure that the email does indeed contain the values that we expect.
+
+h3. Epilogue
+
+This guide presented how to create a mailer and how to test it. In reality, you may find that writing your tests before you actually write your code to be a rewarding experience. It may take some time to get used to TDD (Test Driven Development), but coding this way achieves two major benefits. Firstly, you know that the code does indeed work, because the tests fail (because there's no code), then they pass, because the code that satisfies the tests was written. Secondly, when you start with the tests, you don't have to make time AFTER you write the code, to write the tests, then never get around to it. The tests are already there and testing has now become part of your coding regimen.
author	Pratik Naik <pratiknaik@gmail.com>	2009-02-06 01:57:02 +0000
committer	Pratik Naik <pratiknaik@gmail.com>	2009-02-06 02:01:22 +0000
commit	96d610553e5fdaabc923835ab1f194070ddb4477 (patch)
tree	5154390d4f47971d522619db9f3826abb771b42f /railties/guides/source/action_mailer_basics.textile
parent	bccd2c54b2c7708f881faf9c9464dcf29bd30bef (diff)
download	rails-96d610553e5fdaabc923835ab1f194070ddb4477.tar.gz rails-96d610553e5fdaabc923835ab1f194070ddb4477.tar.bz2 rails-96d610553e5fdaabc923835ab1f194070ddb4477.zip