Skip to content

Commit 155f734

Browse files
vijaydevfxn
authored andcommitted
mailer guide: fixes indentation, and use fixed width fonts wherever necessary
1 parent 0df00d9 commit 155f734

File tree

1 file changed

+26
-31
lines changed

1 file changed

+26
-31
lines changed

railties/guides/source/action_mailer_basics.textile

Lines changed: 26 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ WARNING. This Guide is based on Rails 3.0. Some of the code shown here will not
88

99
h3. Introduction
1010

11-
Action Mailer allows you to send emails from your application using a mailer model and views. So, in Rails, emails are used by creating mailers that inherit from +ActionMailer::Base+ and live in +app/mailers+. Those mailers have associated views that appear alongside controller views in +app/views+.
11+
Action Mailer allows you to send emails from your application using a mailer model and views. So, in Rails, emails are used by creating mailers that inherit from +ActionMailer::Base+ and live in +app/mailers+. Those mailers have associated views that appear alongside controller views in +app/views+.
1212

1313
h3. Sending Emails
1414

@@ -48,10 +48,8 @@ class UserMailer < ActionMailer::Base
4848
def welcome_email(user)
4949
@user = user
5050
@url = "http://example.com/login"
51-
mail(:to => user.email,
52-
:subject => "Welcome to My Awesome Site")
51+
mail(:to => user.email, :subject => "Welcome to My Awesome Site")
5352
end
54-
5553
end
5654
</ruby>
5755

@@ -142,17 +140,17 @@ end
142140

143141
This provides a much simpler implementation that does not require the registering of observers and the like.
144142

145-
The method +welcome_email+ returns a Mail::Message object which can then just be told +deliver+ to send itself out.
143+
The method +welcome_email+ returns a <tt>Mail::Message</tt> object which can then just be told +deliver+ to send itself out.
146144

147145
NOTE: In previous versions of Rails, you would call +deliver_welcome_email+ or +create_welcome_email+. This has been deprecated in Rails 3.0 in favour of just calling the method name itself.
148146

149-
WARNING: Sending out one email should only take a fraction of a second, if you are planning on sending out many emails, or you have a slow domain resolution service, you might want to investigate using a background process like delayed job.
147+
WARNING: Sending out an email should only take a fraction of a second, but if you are planning on sending out many emails, or you have a slow domain resolution service, you might want to investigate using a background process like Delayed Job.
150148

151149
h4. Auto encoding header values
152150

153151
Action Mailer now handles the auto encoding of multibyte characters inside of headers and bodies.
154152

155-
If you are using UTF-8 as your character set, you do not have to do anything special, just go ahead and send in UTF-8 data to the address fields, subject, keywords, filenames or body of the email and ActionMailer will auto encode it into quoted printable for you in the case of a header field or Base64 encode any body parts that are non US-ASCII.
153+
If you are using UTF-8 as your character set, you do not have to do anything special, just go ahead and send in UTF-8 data to the address fields, subject, keywords, filenames or body of the email and Action Mailer will auto encode it into quoted printable for you in the case of a header field or Base64 encode any body parts that are non US-ASCII.
156154

157155
For more complex examples such as defining alternate character sets or self encoding text first, please refer to the Mail library.
158156

@@ -213,7 +211,7 @@ NOTE: If you specify an encoding, Mail will assume that your content is already
213211

214212
h5. Making Inline Attachments
215213

216-
ActionMailer 3.0 makes inline attachments, which involved a lot of hacking in pre 3.0 versions, much simpler and trivial as they should be.
214+
Action Mailer 3.0 makes inline attachments, which involved a lot of hacking in pre 3.0 versions, much simpler and trivial as they should be.
217215

218216
* Firstly, to tell Mail to turn an attachment into an inline attachment, you just call <tt>#inline</tt> on the attachments method within your Mailer:
219217

@@ -245,15 +243,15 @@ h5. Sending Email To Multiple Recipients
245243
It is possible to send email to one or more recipients in one email (for e.g. informing all admins of a new signup) by setting the list of emails to the <tt>:to</tt> key. The list of emails can be an array of email addresses or a single string with the addresses separated by commas.
246244

247245
<ruby>
248-
class AdminMailer < ActionMailer::Base
249-
default :to => Admin.all.map(&:email),
250-
:from => "[email protected]"
246+
class AdminMailer < ActionMailer::Base
247+
default :to => Admin.all.map(&:email),
248+
:from => "[email protected]"
251249

252-
def new_registration(user)
253-
@user = user
254-
mail(:subject => "New User Signup: #{@user.email}")
255-
end
250+
def new_registration(user)
251+
@user = user
252+
mail(:subject => "New User Signup: #{@user.email}")
256253
end
254+
end
257255
</ruby>
258256

259257
The same format can be used to set carbon copy (Cc:) and blind carbon copy (Bcc:) recipients, by using the <tt>:cc</tt> and <tt>:bcc</tt> keys respectively.
@@ -264,12 +262,11 @@ Sometimes you wish to show the name of the person instead of just their email ad
264262
to format the email address in the format <tt>"Name &lt;email&gt;"</tt>.
265263

266264
<ruby>
267-
def welcome_email(user)
268-
@user = user
269-
email_with_name = "#{@user.name} <#{@user.email}>"
270-
mail(:to => email_with_name,
271-
:subject => "Welcome to My Awesome Site")
272-
end
265+
def welcome_email(user)
266+
@user = user
267+
email_with_name = "#{@user.name} <#{@user.email}>"
268+
mail(:to => email_with_name, :subject => "Welcome to My Awesome Site")
269+
end
273270
</ruby>
274271

275272
h4. Mailer Views
@@ -289,9 +286,7 @@ class UserMailer < ActionMailer::Base
289286
:subject => "Welcome to My Awesome Site",
290287
:template_path => 'notifications',
291288
:template_name => 'another')
292-
end
293289
end
294-
295290
end
296291
</ruby>
297292

@@ -461,14 +456,14 @@ h3. Action Mailer Configuration
461456

462457
The following configuration options are best made in one of the environment files (environment.rb, production.rb, etc...)
463458

464-
|template_root|Determines the base from which template references will be made.|
465-
|logger|Generates 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.|
466-
|smtp_settings|Allows detailed configuration for :smtp delivery method:<ul><li>:address - Allows you to use a remote mail server. Just change it from its default "localhost" setting.</li><li>:port - On the off chance that your mail server doesn't run on port 25, you can change it.</li><li>:domain - If you need to specify a HELO domain, you can do it here.</li><li>:user_name - If your mail server requires authentication, set the username in this setting.</li><li>:password - If your mail server requires authentication, set the password in this setting.</li><li>: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.</li></ul>|
467-
|sendmail_settings|Allows you to override options for the :sendmail delivery method.<ul><li>:location - The location of the sendmail executable. Defaults to /usr/sbin/sendmail.</li><li>:arguments - The command line arguments to be passed to sendmail. Defaults to -i -t.</li></ul>|
468-
|raise_delivery_errors|Whether or not errors should be raised if the email fails to be delivered.|
469-
|delivery_method|Defines a delivery method. Possible values are :smtp (default), :sendmail, :file and :test.|
470-
|perform_deliveries|Determines whether deliveries are actually carried out when the +deliver+ method is invoked on the Mail message. By default they are, but this can be turned off to help functional testing.|
471-
|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.|
459+
|+template_root+|Determines the base from which template references will be made.|
460+
|+logger+|Generates 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.|
461+
|+smtp_settings+|Allows detailed configuration for <tt>:smtp</tt> delivery method:<ul><li><tt>:address</tt> - Allows you to use a remote mail server. Just change it from its default "localhost" setting.</li><li><tt>:port</tt> - On the off chance that your mail server doesn't run on port 25, you can change it.</li><li><tt>:domain</tt> - If you need to specify a HELO domain, you can do it here.</li><li><tt>:user_name</tt> - If your mail server requires authentication, set the username in this setting.</li><li><tt>:password</tt> - If your mail server requires authentication, set the password in this setting.</li><li><tt>:authentication</tt> - If your mail server requires authentication, you need to specify the authentication type here. This is a symbol and one of <tt>:plain</tt>, <tt>:login</tt>, <tt>:cram_md5</tt>.</li></ul>|
462+
|+sendmail_settings+|Allows you to override options for the <tt>:sendmail</tt> delivery method.<ul><li><tt>:location</tt> - The location of the sendmail executable. Defaults to <tt>/usr/sbin/sendmail</tt>.</li><li><tt>:arguments</tt> - The command line arguments to be passed to sendmail. Defaults to <tt>-i -t</tt>.</li></ul>|
463+
|+raise_delivery_errors+|Whether or not errors should be raised if the email fails to be delivered.|
464+
|+delivery_method+|Defines a delivery method. Possible values are <tt>:smtp</tt> (default), <tt>:sendmail</tt>, <tt>:file</tt> and <tt>:test</tt>.|
465+
|+perform_deliveries+|Determines whether deliveries are actually carried out when the +deliver+ method is invoked on the Mail message. By default they are, but this can be turned off to help functional testing.|
466+
|+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.|
472467

473468
h4. Example Action Mailer Configuration
474469

0 commit comments

Comments
 (0)