Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 735 lines (687 sloc) 31.66 kb
616ebb8 José Valim Remove unused code paths and require mail only when it's needed.
josevalim authored
1 require 'mail'
c985a0e Add some tests to collector with templates and any.
José Valim and Mikel Lindsaar authored
2 require 'action_mailer/collector'
41af6d9 Jeremy Kemper Use Array.wrap not Array()
jeremy authored
3 require 'active_support/core_ext/array/wrap'
76f024a Xavier Noria adds missing requires for Object#blank? and Object#present?
fxn authored
4 require 'active_support/core_ext/object/blank'
fa5f936 Santiago Pastorino Added missing require, we are using bind method defined on active_suppor...
spastorino authored
5 require 'active_support/core_ext/proc'
284ca81 Josh Kalderimis remove AM delegating register_observer and register_interceptor to Mail ...
joshk authored
6 require 'active_support/core_ext/string/inflections'
0f8a6eb Prem Sichanugrist Fix missing requires in Action Mailer
sikachu authored
7 require 'active_support/core_ext/hash/except'
6788db8 José Valim Move Rails::LogSubscriber to ActiveSupport::LogSubscriber, allowing fram...
josevalim authored
8 require 'action_mailer/log_subscriber'
a63caa4 Get tests to run (with failures) without old base around
Yehuda Katz + Carl Lerche authored
9
c4590d5 David Heinemeier Hansson Fixed docs
dhh authored
10 module ActionMailer #:nodoc:
98dc582 Pratik Merge docrails.
lifo authored
11 # Action Mailer allows you to send email from your application using a mailer model and views.
db045db David Heinemeier Hansson Initial
dhh authored
12 #
0a407bc ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, Mar...
Marcel Molina authored
13 # = Mailer Models
20bd4bd David Heinemeier Hansson Updated docs and otherwise
dhh authored
14 #
98dc582 Pratik Merge docrails.
lifo authored
15 # To use Action Mailer, you need to create a mailer model.
3b0e1d9 Joshua Peek Prefer string core_ext inflector methods over directly accessing Inflect...
josh authored
16 #
f44a0b1 Roman Dittert fix usage examples and more to use new invocations
romdi authored
17 # $ rails generate mailer Notifier
0a407bc ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, Mar...
Marcel Molina authored
18 #
058f7fe Mikel Lindsaar Cleaning up Action Mailer spelling with and without the space
mikel authored
19 # The generated model inherits from <tt>ActionMailer::Base</tt>. Emails are defined by creating methods
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
20 # within the model which are then used to set variables to be used in the mail template, to
21 # change options on the mail, or to add attachments.
0a407bc ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, Mar...
Marcel Molina authored
22 #
23 # Examples:
24 #
0f0213f Siong minor spacing fix in code example in ActionMailer::Base.
siong1987 authored
25 # class Notifier < ActionMailer::Base
26 # default :from => 'no-reply@example.com',
452bb1e Jeremy Kemper Rename 'defaults' class method to 'default' to reflect that it's a decla...
jeremy authored
27 # :return_path => 'system@example.com'
458f571 Yehuda Katz Remove the need for a special action_mailer.url_for initializer that loa...
wycats authored
28 #
0f0213f Siong minor spacing fix in code example in ActionMailer::Base.
siong1987 authored
29 # def welcome(recipient)
30 # @account = recipient
31 # mail(:to => recipient.email_address_with_name,
32 # :bcc => ["bcc@example.com", "Order Watcher <watcher@example.com>"])
33 # end
34 # end
458f571 Yehuda Katz Remove the need for a special action_mailer.url_for initializer that loa...
wycats authored
35 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
36 # Within the mailer method, you have access to the following methods:
458f571 Yehuda Katz Remove the need for a special action_mailer.url_for initializer that loa...
wycats authored
37 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
38 # * <tt>attachments[]=</tt> - Allows you to add attachments to your email in an intuitive
39 # manner; <tt>attachments['filename.png'] = File.read('path/to/filename.png')</tt>
6589976 Remove old files, add some information to docs and improve test suite.
José Valim and Mikel Lindsaar authored
40 #
3762362 Mikel Lindsaar Updating readme for ActionMailer::Base
mikel authored
41 # * <tt>attachments.inline[]=</tt> - Allows you to add an inline attachment to your email
42 # in the same manner as <tt>attachments[]=</tt>
43 #
bb2c7b4 Mikel Lindsaar Updating Action Mailer documentation
mikel authored
44 # * <tt>headers[]=</tt> - Allows you to specify any header field in your email such
daad445 Neeraj Singh itsy bitsy changes to ActionMailer documentation
neerajdotname authored
45 # as <tt>headers['X-No-Spam'] = 'True'</tt>. Note, while most fields like <tt>To:</tt>
bb2c7b4 Mikel Lindsaar Updating Action Mailer documentation
mikel authored
46 # <tt>From:</tt> can only appear once in an email header, other fields like <tt>X-Anything</tt>
47 # can appear multiple times. If you want to change a field that can appear multiple times,
daad445 Neeraj Singh itsy bitsy changes to ActionMailer documentation
neerajdotname authored
48 # you need to set it to nil first so that Mail knows you are replacing it and not adding
49 # another field of the same name.
6589976 Remove old files, add some information to docs and improve test suite.
José Valim and Mikel Lindsaar authored
50 #
9520166 Mikel Lindsaar Fixed up being able to pass random headers in with headers, or mail. Al...
mikel authored
51 # * <tt>headers(hash)</tt> - Allows you to specify multiple headers in your email such
52 # as <tt>headers({'X-No-Spam' => 'True', 'In-Reply-To' => '1234@message.id'})</tt>
53 #
daad445 Neeraj Singh itsy bitsy changes to ActionMailer documentation
neerajdotname authored
54 # * <tt>mail</tt> - Allows you to specify email to be sent.
458f571 Yehuda Katz Remove the need for a special action_mailer.url_for initializer that loa...
wycats authored
55 #
9520166 Mikel Lindsaar Fixed up being able to pass random headers in with headers, or mail. Al...
mikel authored
56 # The hash passed to the mail method allows you to specify any header that a Mail::Message
bb2c7b4 Mikel Lindsaar Updating Action Mailer documentation
mikel authored
57 # will accept (any valid Email header including optional fields).
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
58 #
59 # The mail method, if not passed a block, will inspect your views and send all the views with
bb2c7b4 Mikel Lindsaar Updating Action Mailer documentation
mikel authored
60 # the same name as the method, so the above action would send the +welcome.text.plain.erb+ view
61 # file as well as the +welcome.text.html.erb+ view file in a +multipart/alternative+ email.
458f571 Yehuda Katz Remove the need for a special action_mailer.url_for initializer that loa...
wycats authored
62 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
63 # If you want to explicitly render only certain templates, pass a block:
458f571 Yehuda Katz Remove the need for a special action_mailer.url_for initializer that loa...
wycats authored
64 #
c125116 David Chelimsky docfix (email instead of emai)
dchelimsky authored
65 # mail(:to => user.email) do |format|
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
66 # format.text
67 # format.html
68 # end
20bd4bd David Heinemeier Hansson Updated docs and otherwise
dhh authored
69 #
daad445 Neeraj Singh itsy bitsy changes to ActionMailer documentation
neerajdotname authored
70 # The block syntax is also useful in providing information specific to a part:
6589976 Remove old files, add some information to docs and improve test suite.
José Valim and Mikel Lindsaar authored
71 #
c125116 David Chelimsky docfix (email instead of emai)
dchelimsky authored
72 # mail(:to => user.email) do |format|
6589976 Remove old files, add some information to docs and improve test suite.
José Valim and Mikel Lindsaar authored
73 # format.text(:content_transfer_encoding => "base64")
74 # format.html
75 # end
76 #
bb2c7b4 Mikel Lindsaar Updating Action Mailer documentation
mikel authored
77 # Or even to render a special view:
6589976 Remove old files, add some information to docs and improve test suite.
José Valim and Mikel Lindsaar authored
78 #
c125116 David Chelimsky docfix (email instead of emai)
dchelimsky authored
79 # mail(:to => user.email) do |format|
6589976 Remove old files, add some information to docs and improve test suite.
José Valim and Mikel Lindsaar authored
80 # format.text
81 # format.html { render "some_other_template" }
82 # end
83 #
20bd4bd David Heinemeier Hansson Updated docs and otherwise
dhh authored
84 # = Mailer views
85 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
86 # Like Action Controller, each mailer class has a corresponding view directory in which each
87 # method of the class looks for a template with its name.
458f571 Yehuda Katz Remove the need for a special action_mailer.url_for initializer that loa...
wycats authored
88 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
89 # To define a template to be used with a mailing, create an <tt>.erb</tt> file with the same
90 # name as the method in your mailer model. For example, in the mailer defined above, the template at
bb2c7b4 Mikel Lindsaar Updating Action Mailer documentation
mikel authored
91 # <tt>app/views/notifier/signup_notification.text.plain.erb</tt> would be used to generate the email.
0a407bc ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, Mar...
Marcel Molina authored
92 #
93 # Variables defined in the model are accessible as instance variables in the view.
94 #
95 # Emails by default are sent in plain text, so a sample view for our model example might look like this:
96 #
97 # Hi <%= @account.name %>,
98 # Thanks for joining our service! Please check back often.
99 #
20bd4bd David Heinemeier Hansson Updated docs and otherwise
dhh authored
100 # You can even use Action Pack helpers in these views. For example:
101 #
102 # You got a new note!
ee70d1b José Valim adv_attr_accessors in ActionMailer are not sent to the views, use the ma...
josevalim authored
103 # <%= truncate(@note.body, 25) %>
104 #
6589976 Remove old files, add some information to docs and improve test suite.
José Valim and Mikel Lindsaar authored
105 # If you need to access the subject, from or the recipients in the view, you can do that through message object:
ee70d1b José Valim adv_attr_accessors in ActionMailer are not sent to the views, use the ma...
josevalim authored
106 #
6589976 Remove old files, add some information to docs and improve test suite.
José Valim and Mikel Lindsaar authored
107 # You got a new note from <%= message.from %>!
ee70d1b José Valim adv_attr_accessors in ActionMailer are not sent to the views, use the ma...
josevalim authored
108 # <%= truncate(@note.body, 25) %>
3b0e1d9 Joshua Peek Prefer string core_ext inflector methods over directly accessing Inflect...
josh authored
109 #
20bd4bd David Heinemeier Hansson Updated docs and otherwise
dhh authored
110 #
4809dcc * Remove default_url_options from mailer generator
Cody Fauser authored
111 # = Generating URLs
3b0e1d9 Joshua Peek Prefer string core_ext inflector methods over directly accessing Inflect...
josh authored
112 #
458f571 Yehuda Katz Remove the need for a special action_mailer.url_for initializer that loa...
wycats authored
113 # URLs can be generated in mailer views using <tt>url_for</tt> or named routes. Unlike controllers from
bb2c7b4 Mikel Lindsaar Updating Action Mailer documentation
mikel authored
114 # Action Pack, the mailer instance doesn't have any context about the incoming request, so you'll need
115 # to provide all of the details needed to generate a URL.
20bd4bd David Heinemeier Hansson Updated docs and otherwise
dhh authored
116 #
4809dcc * Remove default_url_options from mailer generator
Cody Fauser authored
117 # When using <tt>url_for</tt> you'll need to provide the <tt>:host</tt>, <tt>:controller</tt>, and <tt>:action</tt>:
3b0e1d9 Joshua Peek Prefer string core_ext inflector methods over directly accessing Inflect...
josh authored
118 #
4809dcc * Remove default_url_options from mailer generator
Cody Fauser authored
119 # <%= url_for(:host => "example.com", :controller => "welcome", :action => "greeting") %>
20bd4bd David Heinemeier Hansson Updated docs and otherwise
dhh authored
120 #
4809dcc * Remove default_url_options from mailer generator
Cody Fauser authored
121 # When using named routes you only need to supply the <tt>:host</tt>:
3b0e1d9 Joshua Peek Prefer string core_ext inflector methods over directly accessing Inflect...
josh authored
122 #
4809dcc * Remove default_url_options from mailer generator
Cody Fauser authored
123 # <%= users_url(:host => "example.com") %>
124 #
daad445 Neeraj Singh itsy bitsy changes to ActionMailer documentation
neerajdotname authored
125 # You want to avoid using the <tt>name_of_route_path</tt> form of named routes because it doesn't
bb2c7b4 Mikel Lindsaar Updating Action Mailer documentation
mikel authored
126 # make sense to generate relative URLs in email messages.
4809dcc * Remove default_url_options from mailer generator
Cody Fauser authored
127 #
bb2c7b4 Mikel Lindsaar Updating Action Mailer documentation
mikel authored
128 # It is also possible to set a default host that will be used in all mailers by setting the <tt>:host</tt>
ab62aa1 Jeroen van Dijk Mention that ActionMailer::Base.default_url_options is now deprecated
jeroenvandijk authored
129 # option as a configuration option in <tt>config/application.rb</tt>:
4809dcc * Remove default_url_options from mailer generator
Cody Fauser authored
130 #
131 # config.action_mailer.default_url_options = { :host => "example.com" }
20bd4bd David Heinemeier Hansson Updated docs and otherwise
dhh authored
132 #
daad445 Neeraj Singh itsy bitsy changes to ActionMailer documentation
neerajdotname authored
133 # If you do decide to set a default <tt>:host</tt> for your mailers you want to use the
bb2c7b4 Mikel Lindsaar Updating Action Mailer documentation
mikel authored
134 # <tt>:only_path => false</tt> option when using <tt>url_for</tt>. This will ensure that absolute URLs are
135 # generated because the <tt>url_for</tt> view helper will, by default, generate relative URLs when a
136 # <tt>:host</tt> option isn't explicitly provided.
20bd4bd David Heinemeier Hansson Updated docs and otherwise
dhh authored
137 #
138 # = Sending mail
139 #
3b0e1d9 Joshua Peek Prefer string core_ext inflector methods over directly accessing Inflect...
josh authored
140 # Once a mailer action and template are defined, you can deliver your message or create it and save it
0a407bc ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, Mar...
Marcel Molina authored
141 # for delivery later:
142 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
143 # Notifier.welcome(david).deliver # sends the email
144 # mail = Notifier.welcome(david) # => a Mail::Message object
145 # mail.deliver # sends the email
0a407bc ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, Mar...
Marcel Molina authored
146 #
bb2c7b4 Mikel Lindsaar Updating Action Mailer documentation
mikel authored
147 # You never instantiate your mailer class. Rather, you just call the method you defined on the class itself.
20bd4bd David Heinemeier Hansson Updated docs and otherwise
dhh authored
148 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
149 # = Multipart Emails
3b0e1d9 Joshua Peek Prefer string core_ext inflector methods over directly accessing Inflect...
josh authored
150 #
98dc582 Pratik Merge docrails.
lifo authored
151 # Multipart messages can also be used implicitly because Action Mailer will automatically
0a407bc ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, Mar...
Marcel Molina authored
152 # detect and use multipart templates, where each template is named after the name of the action, followed
153 # by the content type. Each such detected template will be added as separate part to the message.
3b0e1d9 Joshua Peek Prefer string core_ext inflector methods over directly accessing Inflect...
josh authored
154 #
daad445 Neeraj Singh itsy bitsy changes to ActionMailer documentation
neerajdotname authored
155 # For example, if the following templates exist:
21187c0 David Heinemeier Hansson Apply the rest of Chads patch
dhh authored
156 # * signup_notification.text.plain.erb
157 # * signup_notification.text.html.erb
158 # * signup_notification.text.xml.builder
6589976 Remove old files, add some information to docs and improve test suite.
José Valim and Mikel Lindsaar authored
159 # * signup_notification.text.yaml.erb
3b0e1d9 Joshua Peek Prefer string core_ext inflector methods over directly accessing Inflect...
josh authored
160 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
161 # Each would be rendered and added as a separate part to the message, with the corresponding content
162 # type. The content type for the entire message is automatically set to <tt>multipart/alternative</tt>,
163 # which indicates that the email contains multiple different representations of the same email
164 # body. The same instance variables defined in the action are passed to all email templates.
359caef Jamis Buck A very thorough refactoring, resulting in new mail property setters and ...
jamis authored
165 #
46f30f9 Pratik Merge documentation changes from docrails.
lifo authored
166 # Implicit template rendering is not performed if any attachments or parts have been added to the email.
167 # This means that you'll have to manually add each part to the email and set the content type of the email
168 # to <tt>multipart/alternative</tt>.
20bd4bd David Heinemeier Hansson Updated docs and otherwise
dhh authored
169 #
0a407bc ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, Mar...
Marcel Molina authored
170 # = Attachments
20bd4bd David Heinemeier Hansson Updated docs and otherwise
dhh authored
171 #
daad445 Neeraj Singh itsy bitsy changes to ActionMailer documentation
neerajdotname authored
172 # Sending attachment in emails is easy:
0a407bc ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, Mar...
Marcel Molina authored
173 #
174 # class ApplicationMailer < ActionMailer::Base
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
175 # def welcome(recipient)
3762362 Mikel Lindsaar Updating readme for ActionMailer::Base
mikel authored
176 # attachments['free_book.pdf'] = File.read('path/to/file.pdf')
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
177 # mail(:to => recipient, :subject => "New account information")
db045db David Heinemeier Hansson Initial
dhh authored
178 # end
3b0e1d9 Joshua Peek Prefer string core_ext inflector methods over directly accessing Inflect...
josh authored
179 # end
458f571 Yehuda Katz Remove the need for a special action_mailer.url_for initializer that loa...
wycats authored
180 #
bb2c7b4 Mikel Lindsaar Updating Action Mailer documentation
mikel authored
181 # Which will (if it had both a <tt>welcome.text.plain.erb</tt> and <tt>welcome.text.html.erb</tt>
ccf9577 Ev Dolzhenko Fix a bunch of minor spelling mistakes
dolzenko authored
182 # template in the view directory), send a complete <tt>multipart/mixed</tt> email with two parts,
bb2c7b4 Mikel Lindsaar Updating Action Mailer documentation
mikel authored
183 # the first part being a <tt>multipart/alternative</tt> with the text and HTML email parts inside,
184 # and the second being a <tt>application/pdf</tt> with a Base64 encoded copy of the file.pdf book
185 # with the filename +free_book.pdf+.
c927aa0 David Heinemeier Hansson Updated documentation
dhh authored
186 #
3762362 Mikel Lindsaar Updating readme for ActionMailer::Base
mikel authored
187 # = Inline Attachments
b451de0 Santiago Pastorino Deletes trailing whitespaces (over text files only find * -type f -exec ...
spastorino authored
188 #
189 # You can also specify that a file should be displayed inline with other HTML. This is useful
daad445 Neeraj Singh itsy bitsy changes to ActionMailer documentation
neerajdotname authored
190 # if you want to display a corporate logo or a photo.
b451de0 Santiago Pastorino Deletes trailing whitespaces (over text files only find * -type f -exec ...
spastorino authored
191 #
3762362 Mikel Lindsaar Updating readme for ActionMailer::Base
mikel authored
192 # class ApplicationMailer < ActionMailer::Base
193 # def welcome(recipient)
194 # attachments.inline['photo.png'] = File.read('path/to/photo.png')
195 # mail(:to => recipient, :subject => "Here is what we look like")
196 # end
197 # end
b451de0 Santiago Pastorino Deletes trailing whitespaces (over text files only find * -type f -exec ...
spastorino authored
198 #
3762362 Mikel Lindsaar Updating readme for ActionMailer::Base
mikel authored
199 # And then to reference the image in the view, you create a <tt>welcome.html.erb</tt> file and
b451de0 Santiago Pastorino Deletes trailing whitespaces (over text files only find * -type f -exec ...
spastorino authored
200 # make a call to +image_tag+ passing in the attachment you want to display and then call
3762362 Mikel Lindsaar Updating readme for ActionMailer::Base
mikel authored
201 # +url+ on the attachment to get the relative content id path for the image source:
b451de0 Santiago Pastorino Deletes trailing whitespaces (over text files only find * -type f -exec ...
spastorino authored
202 #
3762362 Mikel Lindsaar Updating readme for ActionMailer::Base
mikel authored
203 # <h1>Please Don't Cringe</h1>
b451de0 Santiago Pastorino Deletes trailing whitespaces (over text files only find * -type f -exec ...
spastorino authored
204 #
3762362 Mikel Lindsaar Updating readme for ActionMailer::Base
mikel authored
205 # <%= image_tag attachments['photo.png'].url -%>
b451de0 Santiago Pastorino Deletes trailing whitespaces (over text files only find * -type f -exec ...
spastorino authored
206 #
f17159b Xavier Noria edit pass: the names of Rails components have a space, ie, "Active Recor...
fxn authored
207 # As we are using Action View's +image_tag+ method, you can pass in any other options you want:
b451de0 Santiago Pastorino Deletes trailing whitespaces (over text files only find * -type f -exec ...
spastorino authored
208 #
3762362 Mikel Lindsaar Updating readme for ActionMailer::Base
mikel authored
209 # <h1>Please Don't Cringe</h1>
b451de0 Santiago Pastorino Deletes trailing whitespaces (over text files only find * -type f -exec ...
spastorino authored
210 #
3762362 Mikel Lindsaar Updating readme for ActionMailer::Base
mikel authored
211 # <%= image_tag attachments['photo.png'].url, :alt => 'Our Photo', :class => 'photo' -%>
b451de0 Santiago Pastorino Deletes trailing whitespaces (over text files only find * -type f -exec ...
spastorino authored
212 #
cefc136 Mikel Lindsaar Adding options to register observers and interceptors through ActionMail...
mikel authored
213 # = Observing and Intercepting Mails
458f571 Yehuda Katz Remove the need for a special action_mailer.url_for initializer that loa...
wycats authored
214 #
5d0d4d8 Sebastian Martinez Remove extra white spaces on ActionMailer docs.
smartinez87 authored
215 # Action Mailer provides hooks into the Mail observer and interceptor methods. These allow you to
5acf76d Paco Guzmán Add action_mailer observer and interceptors configuration options
pacoguzman authored
216 # register classes that are called during the mail delivery life cycle.
458f571 Yehuda Katz Remove the need for a special action_mailer.url_for initializer that loa...
wycats authored
217 #
5acf76d Paco Guzmán Add action_mailer observer and interceptors configuration options
pacoguzman authored
218 # An observer class must implement the <tt>:delivered_email(message)</tt> method which will be
cefc136 Mikel Lindsaar Adding options to register observers and interceptors through ActionMail...
mikel authored
219 # called once for every email sent after the email has been sent.
458f571 Yehuda Katz Remove the need for a special action_mailer.url_for initializer that loa...
wycats authored
220 #
5acf76d Paco Guzmán Add action_mailer observer and interceptors configuration options
pacoguzman authored
221 # An interceptor class must implement the <tt>:delivering_email(message)</tt> method which will be
cefc136 Mikel Lindsaar Adding options to register observers and interceptors through ActionMail...
mikel authored
222 # called before the email is sent, allowing you to make modifications to the email before it hits
5acf76d Paco Guzmán Add action_mailer observer and interceptors configuration options
pacoguzman authored
223 # the delivery agents. Your class should make any needed modifications directly to the passed
cefc136 Mikel Lindsaar Adding options to register observers and interceptors through ActionMail...
mikel authored
224 # in Mail::Message instance.
20bd4bd David Heinemeier Hansson Updated docs and otherwise
dhh authored
225 #
fb30feb Mikel Lindsaar Adding more docs to ActionMailer
mikel authored
226 # = Default Hash
458f571 Yehuda Katz Remove the need for a special action_mailer.url_for initializer that loa...
wycats authored
227 #
058f7fe Mikel Lindsaar Cleaning up Action Mailer spelling with and without the space
mikel authored
228 # Action Mailer provides some intelligent defaults for your emails, these are usually specified in a
fb30feb Mikel Lindsaar Adding more docs to ActionMailer
mikel authored
229 # default method inside the class definition:
458f571 Yehuda Katz Remove the need for a special action_mailer.url_for initializer that loa...
wycats authored
230 #
fb30feb Mikel Lindsaar Adding more docs to ActionMailer
mikel authored
231 # class Notifier < ActionMailer::Base
232 # default :sender => 'system@example.com'
233 # end
458f571 Yehuda Katz Remove the need for a special action_mailer.url_for initializer that loa...
wycats authored
234 #
ad8e1ba Cheah Chu Yeow Fix missing word in ActionMailer::Base documentation.
chuyeow authored
235 # You can pass in any header value that a <tt>Mail::Message</tt> accepts. Out of the box,
236 # <tt>ActionMailer::Base</tt> sets the following:
458f571 Yehuda Katz Remove the need for a special action_mailer.url_for initializer that loa...
wycats authored
237 #
fb30feb Mikel Lindsaar Adding more docs to ActionMailer
mikel authored
238 # * <tt>:mime_version => "1.0"</tt>
239 # * <tt>:charset => "UTF-8",</tt>
240 # * <tt>:content_type => "text/plain",</tt>
241 # * <tt>:parts_order => [ "text/plain", "text/enriched", "text/html" ]</tt>
458f571 Yehuda Katz Remove the need for a special action_mailer.url_for initializer that loa...
wycats authored
242 #
fb30feb Mikel Lindsaar Adding more docs to ActionMailer
mikel authored
243 # <tt>parts_order</tt> and <tt>charset</tt> are not actually valid <tt>Mail::Message</tt> header fields,
058f7fe Mikel Lindsaar Cleaning up Action Mailer spelling with and without the space
mikel authored
244 # but Action Mailer translates them appropriately and sets the correct values.
458f571 Yehuda Katz Remove the need for a special action_mailer.url_for initializer that loa...
wycats authored
245 #
fb30feb Mikel Lindsaar Adding more docs to ActionMailer
mikel authored
246 # As you can pass in any header, you need to either quote the header as a string, or pass it in as
b72cd29 Mikel Lindsaar Fixing spelling
mikel authored
247 # an underscored symbol, so the following will work:
458f571 Yehuda Katz Remove the need for a special action_mailer.url_for initializer that loa...
wycats authored
248 #
fb30feb Mikel Lindsaar Adding more docs to ActionMailer
mikel authored
249 # class Notifier < ActionMailer::Base
250 # default 'Content-Transfer-Encoding' => '7bit',
251 # :content_description => 'This is a description'
252 # end
458f571 Yehuda Katz Remove the need for a special action_mailer.url_for initializer that loa...
wycats authored
253 #
058f7fe Mikel Lindsaar Cleaning up Action Mailer spelling with and without the space
mikel authored
254 # Finally, Action Mailer also supports passing <tt>Proc</tt> objects into the default hash, so you
fb30feb Mikel Lindsaar Adding more docs to ActionMailer
mikel authored
255 # can define methods that evaluate as the message is being generated:
458f571 Yehuda Katz Remove the need for a special action_mailer.url_for initializer that loa...
wycats authored
256 #
fb30feb Mikel Lindsaar Adding more docs to ActionMailer
mikel authored
257 # class Notifier < ActionMailer::Base
258 # default 'X-Special-Header' => Proc.new { my_method }
458f571 Yehuda Katz Remove the need for a special action_mailer.url_for initializer that loa...
wycats authored
259 #
fb30feb Mikel Lindsaar Adding more docs to ActionMailer
mikel authored
260 # private
458f571 Yehuda Katz Remove the need for a special action_mailer.url_for initializer that loa...
wycats authored
261 #
fb30feb Mikel Lindsaar Adding more docs to ActionMailer
mikel authored
262 # def my_method
263 # 'some complex call'
264 # end
265 # end
458f571 Yehuda Katz Remove the need for a special action_mailer.url_for initializer that loa...
wycats authored
266 #
fb30feb Mikel Lindsaar Adding more docs to ActionMailer
mikel authored
267 # Note that the proc is evaluated right at the start of the mail message generation, so if you
458f571 Yehuda Katz Remove the need for a special action_mailer.url_for initializer that loa...
wycats authored
268 # set something in the defaults using a proc, and then set the same thing inside of your
fb30feb Mikel Lindsaar Adding more docs to ActionMailer
mikel authored
269 # mailer method, it will get over written by the mailer method.
458f571 Yehuda Katz Remove the need for a special action_mailer.url_for initializer that loa...
wycats authored
270 #
c927aa0 David Heinemeier Hansson Updated documentation
dhh authored
271 # = Configuration options
272 #
458f571 Yehuda Katz Remove the need for a special action_mailer.url_for initializer that loa...
wycats authored
273 # These options are specified on the class level, like
e968acc Ryan Bigg Update ActionMailer documentation to not use deprecated template_root me...
radar authored
274 # <tt>ActionMailer::Base.raise_delivery_errors = true</tt>
c927aa0 David Heinemeier Hansson Updated documentation
dhh authored
275 #
fb30feb Mikel Lindsaar Adding more docs to ActionMailer
mikel authored
276 # * <tt>default</tt> - You can pass this in at a class level as well as within the class itself as
277 # per the above section.
458f571 Yehuda Katz Remove the need for a special action_mailer.url_for initializer that loa...
wycats authored
278 #
c927aa0 David Heinemeier Hansson Updated documentation
dhh authored
279 # * <tt>logger</tt> - the logger is used for generating information on the mailing run if available.
280 # Can be set to nil for no logging. Compatible with both Ruby's own Logger and Log4r loggers.
281 #
64092de Xavier Noria Improve documentation coverage and markup
fxn authored
282 # * <tt>smtp_settings</tt> - Allows detailed configuration for <tt>:smtp</tt> delivery method:
bb2c7b4 Mikel Lindsaar Updating Action Mailer documentation
mikel authored
283 # * <tt>:address</tt> - Allows you to use a remote mail server. Just change it from its default
284 # "localhost" setting.
dc4eec1 Pratik Merge docrails:
lifo authored
285 # * <tt>:port</tt> - On the off chance that your mail server doesn't run on port 25, you can change it.
286 # * <tt>:domain</tt> - If you need to specify a HELO domain, you can do it here.
287 # * <tt>:user_name</tt> - If your mail server requires authentication, set the username in this setting.
288 # * <tt>:password</tt> - If your mail server requires authentication, set the password in this setting.
bb2c7b4 Mikel Lindsaar Updating Action Mailer documentation
mikel authored
289 # * <tt>:authentication</tt> - If your mail server requires authentication, you need to specify the
290 # authentication type here.
5a898e1 Explain actionamailer authentication types
Peter Baker authored
291 # This is a symbol and one of <tt>:plain</tt> (will send the password in the clear), <tt>:login</tt> (will
3457db7 Dalibor Nasevic Correct spelling for Base64 in action_mailer
dalibor authored
292 # send password Base64 encoded) or <tt>:cram_md5</tt> (combines a Challenge/Response mechanism to exchange
5a898e1 Explain actionamailer authentication types
Peter Baker authored
293 # information and a cryptographic Message Digest 5 algorithm to hash important information)
bb2c7b4 Mikel Lindsaar Updating Action Mailer documentation
mikel authored
294 # * <tt>:enable_starttls_auto</tt> - When set to true, detects if STARTTLS is enabled in your SMTP server
295 # and starts to use it.
d500ad3 Josh Kalderimis Removed deprecated ActionMailer API and related tests
joshk authored
296 # * <tt>:openssl_verify_mode</tt> - When using TLS, you can set how OpenSSL checks the certificate. This is
297 # really useful if you need to validate a self-signed and/or a wildcard certificate. You can use the name
298 # of an OpenSSL verify constant ('none', 'peer', 'client_once','fail_if_no_peer_cert') or directly the
a1639ad Florent Piteau Undocumented :openssl_verify_mode option for smtp_settings
flop authored
299 # constant (OpenSSL::SSL::VERIFY_NONE, OpenSSL::SSL::VERIFY_PEER,...).
c927aa0 David Heinemeier Hansson Updated documentation
dhh authored
300 #
46f30f9 Pratik Merge documentation changes from docrails.
lifo authored
301 # * <tt>sendmail_settings</tt> - Allows you to override options for the <tt>:sendmail</tt> delivery method.
302 # * <tt>:location</tt> - The location of the sendmail executable. Defaults to <tt>/usr/sbin/sendmail</tt>.
b72cd29 Mikel Lindsaar Fixing spelling
mikel authored
303 # * <tt>:arguments</tt> - The command line arguments. Defaults to <tt>-i -t</tt> with <tt>-f sender@address</tt>
bb2c7b4 Mikel Lindsaar Updating Action Mailer documentation
mikel authored
304 # added automatically before the message is sent.
dc4eec1 Pratik Merge docrails:
lifo authored
305 #
fbe6c3c Eric Davis Adds a :file delivery_method to save email to a file on disk
edavis10 authored
306 # * <tt>file_settings</tt> - Allows you to override options for the <tt>:file</tt> delivery method.
bb2c7b4 Mikel Lindsaar Updating Action Mailer documentation
mikel authored
307 # * <tt>:location</tt> - The directory into which emails will be written. Defaults to the application
308 # <tt>tmp/mails</tt>.
fbe6c3c Eric Davis Adds a :file delivery_method to save email to a file on disk
edavis10 authored
309 #
dc4eec1 Pratik Merge docrails:
lifo authored
310 # * <tt>raise_delivery_errors</tt> - Whether or not errors should be raised if the email fails to be delivered.
c927aa0 David Heinemeier Hansson Updated documentation
dhh authored
311 #
bb2c7b4 Mikel Lindsaar Updating Action Mailer documentation
mikel authored
312 # * <tt>delivery_method</tt> - Defines a delivery method. Possible values are <tt>:smtp</tt> (default),
313 # <tt>:sendmail</tt>, <tt>:test</tt>, and <tt>:file</tt>. Or you may provide a custom delivery method
5d0d4d8 Sebastian Martinez Remove extra white spaces on ActionMailer docs.
smartinez87 authored
314 # object eg. MyOwnDeliveryMethodClass.new. See the Mail gem documentation on the interface you need to
bb2c7b4 Mikel Lindsaar Updating Action Mailer documentation
mikel authored
315 # implement for a custom delivery agent.
c927aa0 David Heinemeier Hansson Updated documentation
dhh authored
316 #
bb2c7b4 Mikel Lindsaar Updating Action Mailer documentation
mikel authored
317 # * <tt>perform_deliveries</tt> - Determines whether emails are actually sent from Action Mailer when you
5d0d4d8 Sebastian Martinez Remove extra white spaces on ActionMailer docs.
smartinez87 authored
318 # call <tt>.deliver</tt> on an mail message or on an Action Mailer method. This is on by default but can
bb2c7b4 Mikel Lindsaar Updating Action Mailer documentation
mikel authored
319 # be turned off to aid in functional testing.
c927aa0 David Heinemeier Hansson Updated documentation
dhh authored
320 #
bb2c7b4 Mikel Lindsaar Updating Action Mailer documentation
mikel authored
321 # * <tt>deliveries</tt> - Keeps an array of all the emails sent out through the Action Mailer with
322 # <tt>delivery_method :test</tt>. Most useful for unit and functional testing.
af56c80 David Heinemeier Hansson Updated documentation
dhh authored
323 #
4964d3b José Valim Make ActionMailer::Base inherit from AbstractController::Base
josevalim authored
324 class Base < AbstractController::Base
dbcf01e Mikel Lindsaar Removing quoting.rb, upgrade to 2.1.3.6, changing all utf-8 references t...
mikel authored
325 include DeliveryMethods
f30d73b Add new class delivery method API.
José Valim and Mikel Lindsaar authored
326 abstract!
327
c03c40b José Valim Expose a _render_partial hook as thhe _render_template one and make use ...
josevalim authored
328 include AbstractController::Logger
83f4d86 David Heinemeier Hansson Rename the RenderingController module to just plain Rendering
dhh authored
329 include AbstractController::Rendering
a9751a7 José Valim Refactor ActionMailer layout and remove legacy one.
josevalim authored
330 include AbstractController::Layouts
684c2dc José Valim Remove ActionMailer helpers and rely on AbstractController one.
josevalim authored
331 include AbstractController::Helpers
48a3985 José Valim Also include translation in ActionMailer.
josevalim authored
332 include AbstractController::Translation
08baa34 David Heinemeier Hansson Extract assets paths and make them available to Action Mailer as well
dhh authored
333 include AbstractController::AssetPaths
359caef Jamis Buck A very thorough refactoring, resulting in new mail property setters and ...
jamis authored
334
d42bb68 José Valim More updates to ivars list.
josevalim authored
335 self.protected_instance_variables = %w(@_action_has_layout)
336
972efa1 José Valim Deprecate the old mailer API that was not deprecated yet.
josevalim authored
337 helper ActionMailer::MailHelper
458f571 Yehuda Katz Remove the need for a special action_mailer.url_for initializer that loa...
wycats authored
338
c927aa0 David Heinemeier Hansson Updated documentation
dhh authored
339 private_class_method :new #:nodoc:
db045db David Heinemeier Hansson Initial
dhh authored
340
e5ab4b0 Jeremy Kemper Convert to class_attribute
jeremy authored
341 class_attribute :default_params
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored
342 self.default_params = {
343 :mime_version => "1.0",
dbcf01e Mikel Lindsaar Removing quoting.rb, upgrade to 2.1.3.6, changing all utf-8 references t...
mikel authored
344 :charset => "UTF-8",
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored
345 :content_type => "text/plain",
346 :parts_order => [ "text/plain", "text/enriched", "text/html" ]
e5ab4b0 Jeremy Kemper Convert to class_attribute
jeremy authored
347 }.freeze
e1c1318 Added delivers_from.
José Valim and Mikel Lindsaar authored
348
eda1719 Jamis Buck ActionMailer::Base.deliver(email) had been accidentally removed, but was...
jamis authored
349 class << self
284ca81 Josh Kalderimis remove AM delegating register_observer and register_interceptor to Mail ...
joshk authored
350 # Register one or more Observers which will be notified when mail is delivered.
351 def register_observers(*observers)
352 observers.flatten.compact.each { |observer| register_observer(observer) }
353 end
354
355 # Register one or more Interceptors which will be called before mail is sent.
356 def register_interceptors(*interceptors)
357 interceptors.flatten.compact.each { |interceptor| register_interceptor(interceptor) }
358 end
359
360 # Register an Observer which will be notified when mail is delivered.
361 # Either a class or a string can be passed in as the Observer. If a string is passed in
362 # it will be <tt>constantize</tt>d.
363 def register_observer(observer)
cb9e501 Josh Kalderimis AM register_interceptor and register_observer only constantize if the ar...
joshk authored
364 delivery_observer = (observer.is_a?(String) ? observer.constantize : observer)
284ca81 Josh Kalderimis remove AM delegating register_observer and register_interceptor to Mail ...
joshk authored
365 Mail.register_observer(delivery_observer)
366 end
367
368 # Register an Inteceptor which will be called before mail is sent.
9a67a11 Siong minor typo in the rdoc about Interceptor.
siong1987 authored
369 # Either a class or a string can be passed in as the Interceptor. If a string is passed in
284ca81 Josh Kalderimis remove AM delegating register_observer and register_interceptor to Mail ...
joshk authored
370 # it will be <tt>constantize</tt>d.
371 def register_interceptor(interceptor)
cb9e501 Josh Kalderimis AM register_interceptor and register_observer only constantize if the ar...
joshk authored
372 delivery_interceptor = (interceptor.is_a?(String) ? interceptor.constantize : interceptor)
284ca81 Josh Kalderimis remove AM delegating register_observer and register_interceptor to Mail ...
joshk authored
373 Mail.register_interceptor(delivery_interceptor)
374 end
375
bd5ed65 risk danger olson Update ActionMailer so it treats ActionView the same way that ActionCont...
technoweenie authored
376 def mailer_name
377 @mailer_name ||= name.underscore
378 end
0750304 Mikel Lindsaar Migrated over to Mail doing delivery.
mikel authored
379 attr_writer :mailer_name
380 alias :controller_path :mailer_name
81c416b José Valim More refactoring on ActionMailer::Base.
josevalim authored
381
e5ab4b0 Jeremy Kemper Convert to class_attribute
jeremy authored
382 def default(value = nil)
383 self.default_params = default_params.merge(value).freeze if value
384 default_params
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored
385 end
386
59f1df1 Jamis Buck Update/extend ActionMailer documentation (rdoc)
jamis authored
387 # Receives a raw email, parses it into an email object, decodes it,
388 # instantiates a new mailer, and passes the email object to the mailer
98dc582 Pratik Merge docrails.
lifo authored
389 # object's +receive+ method. If you want your mailer to be able to
390 # process incoming messages, you'll need to implement a +receive+
bb2c7b4 Mikel Lindsaar Updating Action Mailer documentation
mikel authored
391 # method that accepts the raw email string as a parameter:
59f1df1 Jamis Buck Update/extend ActionMailer documentation (rdoc)
jamis authored
392 #
393 # class MyMailer < ActionMailer::Base
394 # def receive(mail)
395 # ...
396 # end
397 # end
704daad José Valim Ensure we just send Ruby Stdlib objects in ActionMailer notifications.
josevalim authored
398 def receive(raw_mail)
731d439 Justin George Change event namespace ordering to most-significant first [#4504 state:r...
jaggederest authored
399 ActiveSupport::Notifications.instrument("receive.action_mailer") do |payload|
704daad José Valim Ensure we just send Ruby Stdlib objects in ActionMailer notifications.
josevalim authored
400 mail = Mail.new(raw_mail)
401 set_payload_for_mail(payload, mail)
2a6bc12 José Valim Add subscriber to ActionMailer.
josevalim authored
402 new.receive(mail)
403 end
eda1719 Jamis Buck ActionMailer::Base.deliver(email) had been accidentally removed, but was...
jamis authored
404 end
405
bb2c7b4 Mikel Lindsaar Updating Action Mailer documentation
mikel authored
406 # Wraps an email delivery inside of Active Support Notifications instrumentation. This
de65c82 Rizwan Reza Changes call backs to callbacks.
rizwanreza authored
407 # method is actually called by the <tt>Mail::Message</tt> object itself through a callback
bb2c7b4 Mikel Lindsaar Updating Action Mailer documentation
mikel authored
408 # when you call <tt>:deliver</tt> on the Mail::Message, calling +deliver_mail+ directly
409 # and passing a Mail::Message will do nothing except tell the logger you sent the email.
e4a989e Added delivery_handler method to mail and implemented in ActionMailer to...
José Valim and Mikel Lindsaar authored
410 def deliver_mail(mail) #:nodoc:
731d439 Justin George Change event namespace ordering to most-significant first [#4504 state:r...
jaggederest authored
411 ActiveSupport::Notifications.instrument("deliver.action_mailer") do |payload|
258ca14 Delegated ActionMailer::Base.deliveries to Mail.deliveries, added callba...
José Valim and Mikel Lindsaar authored
412 self.set_payload_for_mail(payload, mail)
ace7497 Got AM working with Mail yield on delivery_handler and updated tests
José Valim and Mikel Lindsaar authored
413 yield # Let Mail do the delivery actions
258ca14 Delegated ActionMailer::Base.deliveries to Mail.deliveries, added callba...
José Valim and Mikel Lindsaar authored
414 end
415 end
416
ad8dc5a Mikel Lindsaar Should use standard ruby signature for respond_to
mikel authored
417 def respond_to?(method, include_private = false) #:nodoc:
99f960a Handle some TODOs and deprecations.
José Valim and Mikel Lindsaar authored
418 super || action_methods.include?(method.to_s)
419 end
420
421 protected
422
704daad José Valim Ensure we just send Ruby Stdlib objects in ActionMailer notifications.
josevalim authored
423 def set_payload_for_mail(payload, mail) #:nodoc:
e8c9cac Aaron Patterson self is implied, so remove self
tenderlove authored
424 payload[:mailer] = name
c905fce José Valim Add message_id to AM payload and don't send bcc and cc if they were not ...
josevalim authored
425 payload[:message_id] = mail.message_id
426 payload[:subject] = mail.subject
427 payload[:to] = mail.to
428 payload[:from] = mail.from
429 payload[:bcc] = mail.bcc if mail.bcc.present?
430 payload[:cc] = mail.cc if mail.cc.present?
431 payload[:date] = mail.date
432 payload[:mail] = mail.encoded
704daad José Valim Ensure we just send Ruby Stdlib objects in ActionMailer notifications.
josevalim authored
433 end
f30d73b Add new class delivery method API.
José Valim and Mikel Lindsaar authored
434
99f960a Handle some TODOs and deprecations.
José Valim and Mikel Lindsaar authored
435 def method_missing(method, *args) #:nodoc:
4d7b2ee Aaron Patterson dry up method missing
tenderlove authored
436 return super unless respond_to?(method)
437 new(method, *args).message
f30d73b Add new class delivery method API.
José Valim and Mikel Lindsaar authored
438 end
eda1719 Jamis Buck ActionMailer::Base.deliver(email) had been accidentally removed, but was...
jamis authored
439 end
440
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored
441 attr_internal :message
442
6ba9446 Make implicit and explicit templates pass through the same part creation...
José Valim and Mikel Lindsaar authored
443 # Instantiate a new mailer object. If +method_name+ is not +nil+, the mailer
444 # will be initialized according to the named method. If not, the mailer will
445 # remain uninitialized (useful when you only need to invoke the "receive"
446 # method, for instance).
447 def initialize(method_name=nil, *args)
448 super()
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored
449 @_message = Mail.new
6ba9446 Make implicit and explicit templates pass through the same part creation...
José Valim and Mikel Lindsaar authored
450 process(method_name, *args) if method_name
451 end
452
3fc609e José Valim Fix ActionMailer test broken in 99d54599215c2a8cea7e57f609e8e578043d71b2
josevalim authored
453 def process(*args) #:nodoc:
454 lookup_context.skip_default_locale!
455 super
456 end
457
972efa1 José Valim Deprecate the old mailer API that was not deprecated yet.
josevalim authored
458 def mailer_name
459 self.class.mailer_name
460 end
461
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
462 # Allows you to pass random and unusual headers to the new +Mail::Message+ object
463 # which will add them to itself.
458f571 Yehuda Katz Remove the need for a special action_mailer.url_for initializer that loa...
wycats authored
464 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
465 # headers['X-Special-Domain-Specific-Header'] = "SecretValue"
458f571 Yehuda Katz Remove the need for a special action_mailer.url_for initializer that loa...
wycats authored
466 #
9520166 Mikel Lindsaar Fixed up being able to pass random headers in with headers, or mail. Al...
mikel authored
467 # You can also pass a hash into headers of header field names and values, which
468 # will then be set on the Mail::Message object:
458f571 Yehuda Katz Remove the need for a special action_mailer.url_for initializer that loa...
wycats authored
469 #
05c4ad9 Tidy up tests and docs.
José Valim and Mikel Lindsaar authored
470 # headers 'X-Special-Domain-Specific-Header' => "SecretValue",
471 # 'In-Reply-To' => incoming.message_id
458f571 Yehuda Katz Remove the need for a special action_mailer.url_for initializer that loa...
wycats authored
472 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
473 # The resulting Mail::Message will have the following in it's header:
458f571 Yehuda Katz Remove the need for a special action_mailer.url_for initializer that loa...
wycats authored
474 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
475 # X-Special-Domain-Specific-Header: SecretValue
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored
476 def headers(args=nil)
477 if args
9520166 Mikel Lindsaar Fixed up being able to pass random headers in with headers, or mail. Al...
mikel authored
478 @_message.headers(args)
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored
479 else
480 @_message
481 end
482 end
c34cfcc Mikel Lindsaar Created mail method for new API
mikel authored
483
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
484 # Allows you to add attachments to an email, like so:
458f571 Yehuda Katz Remove the need for a special action_mailer.url_for initializer that loa...
wycats authored
485 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
486 # mail.attachments['filename.jpg'] = File.read('/path/to/filename.jpg')
458f571 Yehuda Katz Remove the need for a special action_mailer.url_for initializer that loa...
wycats authored
487 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
488 # If you do this, then Mail will take the file name and work out the mime type
458f571 Yehuda Katz Remove the need for a special action_mailer.url_for initializer that loa...
wycats authored
489 # set the Content-Type, Content-Disposition, Content-Transfer-Encoding and
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
490 # base64 encode the contents of the attachment all for you.
458f571 Yehuda Katz Remove the need for a special action_mailer.url_for initializer that loa...
wycats authored
491 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
492 # You can also specify overrides if you want by passing a hash instead of a string:
458f571 Yehuda Katz Remove the need for a special action_mailer.url_for initializer that loa...
wycats authored
493 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
494 # mail.attachments['filename.jpg'] = {:mime_type => 'application/x-gzip',
495 # :content => File.read('/path/to/filename.jpg')}
458f571 Yehuda Katz Remove the need for a special action_mailer.url_for initializer that loa...
wycats authored
496 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
497 # If you want to use a different encoding than Base64, you can pass an encoding in,
498 # but then it is up to you to pass in the content pre-encoded, and don't expect
499 # Mail to know how to decode this data:
458f571 Yehuda Katz Remove the need for a special action_mailer.url_for initializer that loa...
wycats authored
500 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
501 # file_content = SpecialEncode(File.read('/path/to/filename.jpg'))
502 # mail.attachments['filename.jpg'] = {:mime_type => 'application/x-gzip',
503 # :encoding => 'SpecialEncoding',
504 # :content => file_content }
458f571 Yehuda Katz Remove the need for a special action_mailer.url_for initializer that loa...
wycats authored
505 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
506 # You can also search for specific attachments:
458f571 Yehuda Katz Remove the need for a special action_mailer.url_for initializer that loa...
wycats authored
507 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
508 # # By Filename
755af49 Xavier Noria edit pass to apply API guideline wrt the use of "# =>" in example code
fxn authored
509 # mail.attachments['filename.jpg'] # => Mail::Part object or nil
458f571 Yehuda Katz Remove the need for a special action_mailer.url_for initializer that loa...
wycats authored
510 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
511 # # or by index
755af49 Xavier Noria edit pass to apply API guideline wrt the use of "# =>" in example code
fxn authored
512 # mail.attachments[0] # => Mail::Part (first attachment)
458f571 Yehuda Katz Remove the need for a special action_mailer.url_for initializer that loa...
wycats authored
513 #
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored
514 def attachments
515 @_message.attachments
516 end
dcb9253 Add basic template rendering to new DSL.
José Valim and Mikel Lindsaar authored
517
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
518 # The main method that creates the message and renders the email templates. There are
519 # two ways to call this method, with a block, or without a block.
458f571 Yehuda Katz Remove the need for a special action_mailer.url_for initializer that loa...
wycats authored
520 #
6589976 Remove old files, add some information to docs and improve test suite.
José Valim and Mikel Lindsaar authored
521 # Both methods accept a headers hash. This hash allows you to specify the most used headers
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
522 # in an email message, these are:
458f571 Yehuda Katz Remove the need for a special action_mailer.url_for initializer that loa...
wycats authored
523 #
058f7fe Mikel Lindsaar Cleaning up Action Mailer spelling with and without the space
mikel authored
524 # * <tt>:subject</tt> - The subject of the message, if this is omitted, Action Mailer will
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
525 # ask the Rails I18n class for a translated <tt>:subject</tt> in the scope of
526 # <tt>[:actionmailer, mailer_scope, action_name]</tt> or if this is missing, will translate the
527 # humanized version of the <tt>action_name</tt>
528 # * <tt>:to</tt> - Who the message is destined for, can be a string of addresses, or an array
529 # of addresses.
0b05acd Mikel Lindsaar Implementing class level :defaults hash, instead of delivers_from et al
mikel authored
530 # * <tt>:from</tt> - Who the message is from
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
531 # * <tt>:cc</tt> - Who you would like to Carbon-Copy on this email, can be a string of addresses,
532 # or an array of addresses.
533 # * <tt>:bcc</tt> - Who you would like to Blind-Carbon-Copy on this email, can be a string of
534 # addresses, or an array of addresses.
535 # * <tt>:reply_to</tt> - Who to set the Reply-To header of the email to.
536 # * <tt>:date</tt> - The date to say the email was sent on.
458f571 Yehuda Katz Remove the need for a special action_mailer.url_for initializer that loa...
wycats authored
537 #
538 # You can set default values for any of the above headers (except :date) by using the <tt>default</tt>
0b05acd Mikel Lindsaar Implementing class level :defaults hash, instead of delivers_from et al
mikel authored
539 # class method:
458f571 Yehuda Katz Remove the need for a special action_mailer.url_for initializer that loa...
wycats authored
540 #
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored
541 # class Notifier < ActionMailer::Base
452bb1e Jeremy Kemper Rename 'defaults' class method to 'default' to reflect that it's a decla...
jeremy authored
542 # self.default :from => 'no-reply@test.lindsaar.net',
543 # :bcc => 'email_logger@test.lindsaar.net',
544 # :reply_to => 'bounces@test.lindsaar.net'
0b05acd Mikel Lindsaar Implementing class level :defaults hash, instead of delivers_from et al
mikel authored
545 # end
458f571 Yehuda Katz Remove the need for a special action_mailer.url_for initializer that loa...
wycats authored
546 #
52c56f9 Greg Hurrell docs: note that mail() accepts arbitrary headers
wincent authored
547 # If you need other headers not listed above, you can either pass them in
548 # as part of the headers hash or use the <tt>headers['name'] = value</tt>
549 # method.
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
550 #
6589976 Remove old files, add some information to docs and improve test suite.
José Valim and Mikel Lindsaar authored
551 # When a <tt>:return_path</tt> is specified as header, that value will be used as the 'envelope from'
5d0d4d8 Sebastian Martinez Remove extra white spaces on ActionMailer docs.
smartinez87 authored
552 # address for the Mail message. Setting this is useful when you want delivery notifications
553 # sent to a different address than the one in <tt>:from</tt>. Mail will actually use the
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
554 # <tt>:return_path</tt> in preference to the <tt>:sender</tt> in preference to the <tt>:from</tt>
555 # field for the 'envelope from' value.
556 #
458f571 Yehuda Katz Remove the need for a special action_mailer.url_for initializer that loa...
wycats authored
557 # If you do not pass a block to the +mail+ method, it will find all templates in the
be35a15 José Valim Allow to choose the template path and template name used in implicit ren...
josevalim authored
558 # view paths using by default the mailer name and the method name that it is being
559 # called from, it will then create parts for each of these templates intelligently,
560 # making educated guesses on correct content type and sequence, and return a fully
561 # prepared Mail::Message ready to call <tt>:deliver</tt> on to send.
562 #
563 # For example:
564 #
565 # class Notifier < ActionMailer::Base
566 # default :from => 'no-reply@test.lindsaar.net',
567 #
568 # def welcome
569 # mail(:to => 'mikel@test.lindsaar.net')
570 # end
571 # end
572 #
573 # Will look for all templates at "app/views/notifier" with name "welcome". However, those
574 # can be customized:
575 #
576 # mail(:template_path => 'notifications', :template_name => 'another')
577 #
578 # And now it will look for all templates at "app/views/notifications" with name "another".
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
579 #
580 # If you do pass a block, you can render specific templates of your choice:
458f571 Yehuda Katz Remove the need for a special action_mailer.url_for initializer that loa...
wycats authored
581 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
582 # mail(:to => 'mikel@test.lindsaar.net') do |format|
583 # format.text
584 # format.html
585 # end
458f571 Yehuda Katz Remove the need for a special action_mailer.url_for initializer that loa...
wycats authored
586 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
587 # You can even render text directly without using a template:
458f571 Yehuda Katz Remove the need for a special action_mailer.url_for initializer that loa...
wycats authored
588 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
589 # mail(:to => 'mikel@test.lindsaar.net') do |format|
590 # format.text { render :text => "Hello Mikel!" }
591 # format.html { render :text => "<h1>Hello Mikel!</h1>" }
592 # end
458f571 Yehuda Katz Remove the need for a special action_mailer.url_for initializer that loa...
wycats authored
593 #
74a5889 Refactor content type setting, added tests to ensure boundary exists on ...
José Valim and Mikel Lindsaar authored
594 # Which will render a <tt>multipart/alternative</tt> email with <tt>text/plain</tt> and
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
595 # <tt>text/html</tt> parts.
6589976 Remove old files, add some information to docs and improve test suite.
José Valim and Mikel Lindsaar authored
596 #
597 # The block syntax also allows you to customize the part headers if desired:
598 #
599 # mail(:to => 'mikel@test.lindsaar.net') do |format|
600 # format.text(:content_transfer_encoding => "base64")
601 # format.html
602 # end
603 #
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored
604 def mail(headers={}, &block)
605 # Guard flag to prevent both the old and the new API from firing
606 # Should be removed when old API is removed
607 @mail_was_called = true
608 m = @_message
258ca14 Delegated ActionMailer::Base.deliveries to Mail.deliveries, added callba...
José Valim and Mikel Lindsaar authored
609
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored
610 # At the beginning, do not consider class default for parts order neither content_type
611 content_type = headers[:content_type]
612 parts_order = headers[:parts_order]
1cd5592 First work on implicit multipart.
José Valim and Mikel Lindsaar authored
613
08b07b6 Mikel Lindsaar Adding ability to pass proc's to the ActionMailer class default method
mikel authored
614 # Call all the procs (if any)
615 default_values = self.class.default.merge(self.class.default) do |k,v|
ceaa100 Mikel Lindsaar Adding ability for the procs to be called within the instance, allows yo...
mikel authored
616 v.respond_to?(:call) ? v.bind(self).call : v
08b07b6 Mikel Lindsaar Adding ability to pass proc's to the ActionMailer class default method
mikel authored
617 end
458f571 Yehuda Katz Remove the need for a special action_mailer.url_for initializer that loa...
wycats authored
618
b5f9a9f José Valim Move set_fields! to the old API module.
josevalim authored
619 # Handle defaults
08b07b6 Mikel Lindsaar Adding ability to pass proc's to the ActionMailer class default method
mikel authored
620 headers = headers.reverse_merge(default_values)
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored
621 headers[:subject] ||= default_i18n_subject
b5f9a9f José Valim Move set_fields! to the old API module.
josevalim authored
622
623 # Apply charset at the beginning so all fields are properly quoted
624 m.charset = charset = headers[:charset]
625
626 # Set configure delivery behavior
627 wrap_delivery_behavior!(headers.delete(:delivery_method))
628
629 # Assign all headers except parts_order, content_type and body
b4fd5e6 José Valim template_name and template_path should not be added to mail headers.
josevalim authored
630 assignable = headers.except(:parts_order, :content_type, :body, :template_name, :template_path)
b5f9a9f José Valim Move set_fields! to the old API module.
josevalim authored
631 assignable.each { |k, v| m[k] = v }
951397b Get implicit multipart and attachments working together.
José Valim and Mikel Lindsaar authored
632
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored
633 # Render the templates and blocks
39a1b06 Deprecate old defaults API.
José Valim and Mikel Lindsaar authored
634 responses, explicit_order = collect_responses_and_parts_order(headers, &block)
b5f9a9f José Valim Move set_fields! to the old API module.
josevalim authored
635 create_parts_from_responses(m, responses)
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored
636
b5f9a9f José Valim Move set_fields! to the old API module.
josevalim authored
637 # Setup content type, reapply charset and handle parts order
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored
638 m.content_type = set_content_type(m, content_type, headers[:content_type])
951397b Get implicit multipart and attachments working together.
José Valim and Mikel Lindsaar authored
639 m.charset = charset
640
e7e4ed4 Set sort order for explicit parts from the collector's template sequence
José Valim and Mikel Lindsaar authored
641 if m.multipart?
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored
642 parts_order ||= explicit_order || headers[:parts_order]
643 m.body.set_sort_order(parts_order)
951397b Get implicit multipart and attachments working together.
José Valim and Mikel Lindsaar authored
644 m.body.sort_parts!
645 end
bb9d71f Move class methods to deprecated stuff.
José Valim and Mikel Lindsaar authored
646
c34cfcc Mikel Lindsaar Created mail method for new API
mikel authored
647 m
648 end
649
6ba9446 Make implicit and explicit templates pass through the same part creation...
José Valim and Mikel Lindsaar authored
650 protected
651
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored
652 def set_content_type(m, user_content_type, class_default)
74a5889 Refactor content type setting, added tests to ensure boundary exists on ...
José Valim and Mikel Lindsaar authored
653 params = m.content_type_parameters || {}
654 case
655 when user_content_type.present?
656 user_content_type
657 when m.has_attachments?
311d99e Mikel Lindsaar Adding inline attachment support to ActionMailer
mikel authored
658 if m.attachments.detect { |a| a.inline? }
659 ["multipart", "related", params]
660 else
661 ["multipart", "mixed", params]
662 end
74a5889 Refactor content type setting, added tests to ensure boundary exists on ...
José Valim and Mikel Lindsaar authored
663 when m.multipart?
664 ["multipart", "alternative", params]
665 else
b6b3db6 Mikel Lindsaar Fixed bug on HTML only emails getting set to text/plain
mikel authored
666 m.content_type || class_default
74a5889 Refactor content type setting, added tests to ensure boundary exists on ...
José Valim and Mikel Lindsaar authored
667 end
668 end
669
082e299 Sebastian Martinez docs for ActionMailer::Base.default_i18n_subject
smartinez87 authored
670 # Translates the +subject+ using Rails I18n class under <tt>[:actionmailer, mailer_scope, action_name]</tt> scope.
671 # If it does not find a translation for the +subject+ under the specified scope it will default to a
672 # humanized version of the <tt>action_name</tt>.
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored
673 def default_i18n_subject #:nodoc:
5c3ef8c Refactor subject with i18n.
José Valim and Mikel Lindsaar authored
674 mailer_scope = self.class.mailer_name.gsub('/', '.')
30eaecb José Valim subject is automatically looked up on I18n using mailer_name and action_...
josevalim authored
675 I18n.t(:subject, :scope => [mailer_scope, action_name], :default => action_name.humanize)
5c3ef8c Refactor subject with i18n.
José Valim and Mikel Lindsaar authored
676 end
677
39a1b06 Deprecate old defaults API.
José Valim and Mikel Lindsaar authored
678 def collect_responses_and_parts_order(headers) #:nodoc:
679 responses, parts_order = [], nil
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored
680
681 if block_given?
a09e992 José Valim Ensure details are frozen after @details_keys lookup. The implementation...
josevalim authored
682 collector = ActionMailer::Collector.new(lookup_context) { render(action_name) }
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored
683 yield(collector)
39a1b06 Deprecate old defaults API.
José Valim and Mikel Lindsaar authored
684 parts_order = collector.responses.map { |r| r[:content_type] }
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored
685 responses = collector.responses
686 elsif headers[:body]
687 responses << {
be35a15 José Valim Allow to choose the template path and template name used in implicit ren...
josevalim authored
688 :body => headers.delete(:body),
452bb1e Jeremy Kemper Rename 'defaults' class method to 'default' to reflect that it's a decla...
jeremy authored
689 :content_type => self.class.default[:content_type] || "text/plain"
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored
690 }
691 else
be35a15 José Valim Allow to choose the template path and template name used in implicit ren...
josevalim authored
692 templates_path = headers.delete(:template_path) || self.class.mailer_name
693 templates_name = headers.delete(:template_name) || action_name
694
695 each_template(templates_path, templates_name) do |template|
f28d856 José Valim Improve performance of the rendering stack by freezing formats as a sign...
josevalim authored
696 self.formats = template.formats
697
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored
698 responses << {
2a12686 José Valim Allow anything that responds to render to be given as :template and use ...
josevalim authored
699 :body => render(:template => template),
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored
700 :content_type => template.mime_type.to_s
701 }
702 end
703 end
704
39a1b06 Deprecate old defaults API.
José Valim and Mikel Lindsaar authored
705 [responses, parts_order]
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored
706 end
707
be35a15 José Valim Allow to choose the template path and template name used in implicit ren...
josevalim authored
708 def each_template(paths, name, &block) #:nodoc:
7c568fd Yehuda Katz A bunch of cleanup on the inherited template patch
wycats authored
709 templates = lookup_context.find_all(name, Array.wrap(paths))
710 templates.uniq_by { |t| t.formats }.each(&block)
99f960a Handle some TODOs and deprecations.
José Valim and Mikel Lindsaar authored
711 end
712
b5f9a9f José Valim Move set_fields! to the old API module.
josevalim authored
713 def create_parts_from_responses(m, responses) #:nodoc:
6ba9446 Make implicit and explicit templates pass through the same part creation...
José Valim and Mikel Lindsaar authored
714 if responses.size == 1 && !m.has_attachments?
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored
715 responses[0].each { |k,v| m[k] = v }
74a5889 Refactor content type setting, added tests to ensure boundary exists on ...
José Valim and Mikel Lindsaar authored
716 elsif responses.size > 1 && m.has_attachments?
6ba9446 Make implicit and explicit templates pass through the same part creation...
José Valim and Mikel Lindsaar authored
717 container = Mail::Part.new
74a5889 Refactor content type setting, added tests to ensure boundary exists on ...
José Valim and Mikel Lindsaar authored
718 container.content_type = "multipart/alternative"
b5f9a9f José Valim Move set_fields! to the old API module.
josevalim authored
719 responses.each { |r| insert_part(container, r, m.charset) }
6ba9446 Make implicit and explicit templates pass through the same part creation...
José Valim and Mikel Lindsaar authored
720 m.add_part(container)
721 else
b5f9a9f José Valim Move set_fields! to the old API module.
josevalim authored
722 responses.each { |r| insert_part(m, r, m.charset) }
6ba9446 Make implicit and explicit templates pass through the same part creation...
José Valim and Mikel Lindsaar authored
723 end
359caef Jamis Buck A very thorough refactoring, resulting in new mail property setters and ...
jamis authored
724 end
725
6ba9446 Make implicit and explicit templates pass through the same part creation...
José Valim and Mikel Lindsaar authored
726 def insert_part(container, response, charset) #:nodoc:
727 response[:charset] ||= charset
728 part = Mail::Part.new(response)
729 container.add_part(part)
359caef Jamis Buck A very thorough refactoring, resulting in new mail property setters and ...
jamis authored
730 end
3fad0cd David Heinemeier Hansson Added support for charsets for both subject and body. The default charse...
dhh authored
731
ef5dada Natalie Weizenbaum Only run load hooks once a file has been fully loaded.
nex3 authored
732 ActiveSupport.run_load_hooks(:action_mailer, self)
db045db David Heinemeier Hansson Initial
dhh authored
733 end
734 end
Something went wrong with that request. Please try again.