Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 796 lines (747 sloc) 34.203 kB
616ebb8 @josevalim Remove unused code paths and require mail only when it's needed.
josevalim authored
1 require 'mail'
34b23e7 @spastorino Action Mailer async flag is true by default using a Synchronous impl
spastorino authored
2 require 'action_mailer/queued_message'
c985a0e Add some tests to collector with templates and any.
José Valim and Mikel Lindsaar authored
3 require 'action_mailer/collector'
284ca81 @joshk remove AM delegating register_observer and register_interceptor to Ma…
joshk authored
4 require 'active_support/core_ext/string/inflections'
0f8a6eb @sikachu Fix missing requires in Action Mailer
sikachu authored
5 require 'active_support/core_ext/hash/except'
c17d200 @lest mailer can be anonymous
lest authored
6 require 'active_support/core_ext/module/anonymous'
2a30150 @jeremy Use synchronous queue by default. Separate queued message delivery jo…
jeremy authored
7 require 'active_support/queueing'
6788db8 @josevalim Move Rails::LogSubscriber to ActiveSupport::LogSubscriber, allowing f…
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 @dhh Fixed docs
dhh authored
10 module ActionMailer #:nodoc:
98dc582 @lifo Merge docrails.
lifo authored
11 # Action Mailer allows you to send email from your application using a mailer model and views.
db045db @dhh Initial
dhh authored
12 #
0a407bc ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, …
Marcel Molina authored
13 # = Mailer Models
20bd4bd @dhh Updated docs and otherwise
dhh authored
14 #
98dc582 @lifo Merge docrails.
lifo authored
15 # To use Action Mailer, you need to create a mailer model.
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Infl…
josh authored
16 #
f44a0b1 @romdi 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, …
Marcel Molina authored
18 #
c291195 @seebq Updates ActionMailer Base summary and fixes space in code example.
seebq authored
19 # The generated model inherits from <tt>ActionMailer::Base</tt>. A mailer model defines methods
20 # used to generate an email message. In these methods, you can setup variables to be used in
21 # the mailer views, options on the mail itself such as the <tt>:from</tt> address, and attachments.
0a407bc ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, …
Marcel Molina authored
22 #
23 # Examples:
24 #
0f0213f @siong1987 minor spacing fix in code example in ActionMailer::Base.
siong1987 authored
25 # class Notifier < ActionMailer::Base
26 # default :from => 'no-reply@example.com',
c291195 @seebq Updates ActionMailer Base summary and fixes space in code example.
seebq authored
27 # :return_path => 'system@example.com'
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
28 #
0f0213f @siong1987 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 @wycats Remove the need for a special action_mailer.url_for initializer that …
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 @wycats Remove the need for a special action_mailer.url_for initializer that …
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 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 Updating Action Mailer documentation
mikel authored
44 # * <tt>headers[]=</tt> - Allows you to specify any header field in your email such
daad445 @neerajdotname 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 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 @neerajdotname 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 Fixed up being able to pass random headers in with headers, or mail. …
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 @neerajdotname itsy bitsy changes to ActionMailer documentation
neerajdotname authored
54 # * <tt>mail</tt> - Allows you to specify email to be sent.
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
55 #
9520166 @mikel Fixed up being able to pass random headers in with headers, or mail. …
mikel authored
56 # The hash passed to the mail method allows you to specify any header that a Mail::Message
bb2c7b4 @mikel 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
b62c549 @jasonfox The name for the plain text template in Rails3 appears to be method.t…
jasonfox authored
60 # the same name as the method, so the above action would send the +welcome.text.erb+ view
bb2c7b4 @mikel Updating Action Mailer documentation
mikel authored
61 # file as well as the +welcome.text.html.erb+ view file in a +multipart/alternative+ email.
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
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 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
64 #
c125116 @dchelimsky 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 @dhh Updated docs and otherwise
dhh authored
69 #
daad445 @neerajdotname 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 @dchelimsky 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 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 @dchelimsky 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 @dhh 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 @wycats Remove the need for a special action_mailer.url_for initializer that …
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
b62c549 @jasonfox The name for the plain text template in Rails3 appears to be method.t…
jasonfox authored
91 # <tt>app/views/notifier/welcome.text.erb</tt> would be used to generate the email.
0a407bc ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, …
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 @dhh 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!
80f1d40 @avakhov update ActionMailer example using last truncate helper method signature
avakhov authored
103 # <%= truncate(@note.body, :length => 25) %>
ee70d1b @josevalim adv_attr_accessors in ActionMailer are not sent to the views, use the…
josevalim authored
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 @josevalim adv_attr_accessors in ActionMailer are not sent to the views, use the…
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 %>!
80f1d40 @avakhov update ActionMailer example using last truncate helper method signature
avakhov authored
108 # <%= truncate(@note.body, :length => 25) %>
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Infl…
josh authored
109 #
20bd4bd @dhh Updated docs and otherwise
dhh authored
110 #
4809dcc * Remove default_url_options from mailer generator
Cody Fauser authored
111 # = Generating URLs
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Infl…
josh authored
112 #
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
113 # URLs can be generated in mailer views using <tt>url_for</tt> or named routes. Unlike controllers from
bb2c7b4 @mikel 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 @dhh 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 @josh Prefer string core_ext inflector methods over directly accessing Infl…
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 @dhh 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 @josh Prefer string core_ext inflector methods over directly accessing Infl…
josh authored
122 #
4809dcc * Remove default_url_options from mailer generator
Cody Fauser authored
123 # <%= users_url(:host => "example.com") %>
124 #
3438f6c @rafaelfranca Array.wrap is no longer needed here
rafaelfranca authored
125 # You should use the <tt>named_route_url</tt> style (which generates absolute URLs) and avoid using the
126 # <tt>named_route_path</tt> style (which generates relative URLs), since clients reading the mail will
1f4fb6f @mjankowski elaborate details on why to use _url instead of _path in mailers
mjankowski authored
127 # have no concept of a current URL from which to determine a relative path.
4809dcc * Remove default_url_options from mailer generator
Cody Fauser authored
128 #
bb2c7b4 @mikel Updating Action Mailer documentation
mikel authored
129 # It is also possible to set a default host that will be used in all mailers by setting the <tt>:host</tt>
ab62aa1 @jeroenvandijk Mention that ActionMailer::Base.default_url_options is now deprecated
jeroenvandijk authored
130 # option as a configuration option in <tt>config/application.rb</tt>:
4809dcc * Remove default_url_options from mailer generator
Cody Fauser authored
131 #
132 # config.action_mailer.default_url_options = { :host => "example.com" }
20bd4bd @dhh Updated docs and otherwise
dhh authored
133 #
4f433bc @mjankowski clarify why the only_path => false option is needed when default :hos…
mjankowski authored
134 # When you decide to set a default <tt>:host</tt> for your mailers, then you need to make sure to use the
3438f6c @rafaelfranca Array.wrap is no longer needed here
rafaelfranca authored
135 # <tt>:only_path => false</tt> option when using <tt>url_for</tt>. Since the <tt>url_for</tt> view helper
4f433bc @mjankowski clarify why the only_path => false option is needed when default :hos…
mjankowski authored
136 # will generate relative URLs by default when a <tt>:host</tt> option isn't explicitly provided, passing
137 # <tt>:only_path => false</tt> will ensure that absolute URLs are generated.
20bd4bd @dhh Updated docs and otherwise
dhh authored
138 #
139 # = Sending mail
140 #
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Infl…
josh authored
141 # 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, …
Marcel Molina authored
142 # for delivery later:
143 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
144 # Notifier.welcome(david).deliver # sends the email
145 # mail = Notifier.welcome(david) # => a Mail::Message object
146 # mail.deliver # sends the email
0a407bc ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, …
Marcel Molina authored
147 #
bb2c7b4 @mikel Updating Action Mailer documentation
mikel authored
148 # You never instantiate your mailer class. Rather, you just call the method you defined on the class itself.
20bd4bd @dhh Updated docs and otherwise
dhh authored
149 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
150 # = Multipart Emails
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Infl…
josh authored
151 #
3438f6c @rafaelfranca Array.wrap is no longer needed here
rafaelfranca authored
152 # Multipart messages can also be used implicitly because Action Mailer will automatically detect and use
153 # multipart templates, where each template is named after the name of the action, followed by the content
f3db04f @mjankowski grammar (missing "a") and formatting
mjankowski authored
154 # type. Each such detected template will be added as a separate part to the message.
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Infl…
josh authored
155 #
daad445 @neerajdotname itsy bitsy changes to ActionMailer documentation
neerajdotname authored
156 # For example, if the following templates exist:
b62c549 @jasonfox The name for the plain text template in Rails3 appears to be method.t…
jasonfox authored
157 # * signup_notification.text.erb
21187c0 @dhh Apply the rest of Chads patch
dhh authored
158 # * signup_notification.text.html.erb
159 # * signup_notification.text.xml.builder
6589976 Remove old files, add some information to docs and improve test suite.
José Valim and Mikel Lindsaar authored
160 # * signup_notification.text.yaml.erb
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Infl…
josh authored
161 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
162 # Each would be rendered and added as a separate part to the message, with the corresponding content
163 # type. The content type for the entire message is automatically set to <tt>multipart/alternative</tt>,
164 # which indicates that the email contains multiple different representations of the same email
165 # body. The same instance variables defined in the action are passed to all email templates.
359caef @jamis A very thorough refactoring, resulting in new mail property setters a…
jamis authored
166 #
46f30f9 @lifo Merge documentation changes from docrails.
lifo authored
167 # Implicit template rendering is not performed if any attachments or parts have been added to the email.
168 # This means that you'll have to manually add each part to the email and set the content type of the email
169 # to <tt>multipart/alternative</tt>.
20bd4bd @dhh Updated docs and otherwise
dhh authored
170 #
0a407bc ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, …
Marcel Molina authored
171 # = Attachments
20bd4bd @dhh Updated docs and otherwise
dhh authored
172 #
daad445 @neerajdotname itsy bitsy changes to ActionMailer documentation
neerajdotname authored
173 # Sending attachment in emails is easy:
0a407bc ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, …
Marcel Molina authored
174 #
175 # class ApplicationMailer < ActionMailer::Base
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
176 # def welcome(recipient)
3762362 @mikel Updating readme for ActionMailer::Base
mikel authored
177 # attachments['free_book.pdf'] = File.read('path/to/file.pdf')
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
178 # mail(:to => recipient, :subject => "New account information")
db045db @dhh Initial
dhh authored
179 # end
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Infl…
josh authored
180 # end
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
181 #
b62c549 @jasonfox The name for the plain text template in Rails3 appears to be method.t…
jasonfox authored
182 # Which will (if it had both a <tt>welcome.text.erb</tt> and <tt>welcome.text.html.erb</tt>
ccf9577 @dolzenko Fix a bunch of minor spelling mistakes
dolzenko authored
183 # template in the view directory), send a complete <tt>multipart/mixed</tt> email with two parts,
bb2c7b4 @mikel Updating Action Mailer documentation
mikel authored
184 # the first part being a <tt>multipart/alternative</tt> with the text and HTML email parts inside,
185 # and the second being a <tt>application/pdf</tt> with a Base64 encoded copy of the file.pdf book
186 # with the filename +free_book.pdf+.
c927aa0 @dhh Updated documentation
dhh authored
187 #
45b1045 @dmathieu raise an error if no implicit mailer template could be found
dmathieu authored
188 # If you need to send attachments with no content, you need to create an empty view for it,
189 # or add an empty body parameter like this:
190 #
191 # class ApplicationMailer < ActionMailer::Base
192 # def welcome(recipient)
193 # attachments['free_book.pdf'] = File.read('path/to/file.pdf')
194 # mail(:to => recipient, :subject => "New account information", :body => "")
195 # end
196 # end
197 #
3762362 @mikel Updating readme for ActionMailer::Base
mikel authored
198 # = Inline Attachments
b451de0 @spastorino Deletes trailing whitespaces (over text files only find * -type f -ex…
spastorino authored
199 #
200 # You can also specify that a file should be displayed inline with other HTML. This is useful
daad445 @neerajdotname itsy bitsy changes to ActionMailer documentation
neerajdotname authored
201 # if you want to display a corporate logo or a photo.
b451de0 @spastorino Deletes trailing whitespaces (over text files only find * -type f -ex…
spastorino authored
202 #
3762362 @mikel Updating readme for ActionMailer::Base
mikel authored
203 # class ApplicationMailer < ActionMailer::Base
204 # def welcome(recipient)
205 # attachments.inline['photo.png'] = File.read('path/to/photo.png')
206 # mail(:to => recipient, :subject => "Here is what we look like")
207 # end
208 # end
b451de0 @spastorino Deletes trailing whitespaces (over text files only find * -type f -ex…
spastorino authored
209 #
3762362 @mikel Updating readme for ActionMailer::Base
mikel authored
210 # And then to reference the image in the view, you create a <tt>welcome.html.erb</tt> file and
b451de0 @spastorino Deletes trailing whitespaces (over text files only find * -type f -ex…
spastorino authored
211 # make a call to +image_tag+ passing in the attachment you want to display and then call
3762362 @mikel Updating readme for ActionMailer::Base
mikel authored
212 # +url+ on the attachment to get the relative content id path for the image source:
b451de0 @spastorino Deletes trailing whitespaces (over text files only find * -type f -ex…
spastorino authored
213 #
3762362 @mikel Updating readme for ActionMailer::Base
mikel authored
214 # <h1>Please Don't Cringe</h1>
b451de0 @spastorino Deletes trailing whitespaces (over text files only find * -type f -ex…
spastorino authored
215 #
3762362 @mikel Updating readme for ActionMailer::Base
mikel authored
216 # <%= image_tag attachments['photo.png'].url -%>
b451de0 @spastorino Deletes trailing whitespaces (over text files only find * -type f -ex…
spastorino authored
217 #
f17159b @fxn edit pass: the names of Rails components have a space, ie, "Active Re…
fxn authored
218 # As we are using Action View's +image_tag+ method, you can pass in any other options you want:
b451de0 @spastorino Deletes trailing whitespaces (over text files only find * -type f -ex…
spastorino authored
219 #
3762362 @mikel Updating readme for ActionMailer::Base
mikel authored
220 # <h1>Please Don't Cringe</h1>
b451de0 @spastorino Deletes trailing whitespaces (over text files only find * -type f -ex…
spastorino authored
221 #
3762362 @mikel Updating readme for ActionMailer::Base
mikel authored
222 # <%= image_tag attachments['photo.png'].url, :alt => 'Our Photo', :class => 'photo' -%>
b451de0 @spastorino Deletes trailing whitespaces (over text files only find * -type f -ex…
spastorino authored
223 #
cefc136 @mikel Adding options to register observers and interceptors through ActionM…
mikel authored
224 # = Observing and Intercepting Mails
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
225 #
5d0d4d8 @smartinez87 Remove extra white spaces on ActionMailer docs.
smartinez87 authored
226 # Action Mailer provides hooks into the Mail observer and interceptor methods. These allow you to
5acf76d @pacoguzman Add action_mailer observer and interceptors configuration options
pacoguzman authored
227 # register classes that are called during the mail delivery life cycle.
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
228 #
5acf76d @pacoguzman Add action_mailer observer and interceptors configuration options
pacoguzman authored
229 # An observer class must implement the <tt>:delivered_email(message)</tt> method which will be
cefc136 @mikel Adding options to register observers and interceptors through ActionM…
mikel authored
230 # called once for every email sent after the email has been sent.
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
231 #
5acf76d @pacoguzman Add action_mailer observer and interceptors configuration options
pacoguzman authored
232 # An interceptor class must implement the <tt>:delivering_email(message)</tt> method which will be
cefc136 @mikel Adding options to register observers and interceptors through ActionM…
mikel authored
233 # called before the email is sent, allowing you to make modifications to the email before it hits
5acf76d @pacoguzman Add action_mailer observer and interceptors configuration options
pacoguzman authored
234 # the delivery agents. Your class should make any needed modifications directly to the passed
cefc136 @mikel Adding options to register observers and interceptors through ActionM…
mikel authored
235 # in Mail::Message instance.
20bd4bd @dhh Updated docs and otherwise
dhh authored
236 #
fb30feb @mikel Adding more docs to ActionMailer
mikel authored
237 # = Default Hash
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
238 #
058f7fe @mikel Cleaning up Action Mailer spelling with and without the space
mikel authored
239 # Action Mailer provides some intelligent defaults for your emails, these are usually specified in a
fb30feb @mikel Adding more docs to ActionMailer
mikel authored
240 # default method inside the class definition:
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
241 #
fb30feb @mikel Adding more docs to ActionMailer
mikel authored
242 # class Notifier < ActionMailer::Base
243 # default :sender => 'system@example.com'
244 # end
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
245 #
ad8e1ba @chuyeow Fix missing word in ActionMailer::Base documentation.
chuyeow authored
246 # You can pass in any header value that a <tt>Mail::Message</tt> accepts. Out of the box,
247 # <tt>ActionMailer::Base</tt> sets the following:
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
248 #
fb30feb @mikel Adding more docs to ActionMailer
mikel authored
249 # * <tt>:mime_version => "1.0"</tt>
250 # * <tt>:charset => "UTF-8",</tt>
251 # * <tt>:content_type => "text/plain",</tt>
252 # * <tt>:parts_order => [ "text/plain", "text/enriched", "text/html" ]</tt>
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
253 #
fb30feb @mikel Adding more docs to ActionMailer
mikel authored
254 # <tt>parts_order</tt> and <tt>charset</tt> are not actually valid <tt>Mail::Message</tt> header fields,
058f7fe @mikel Cleaning up Action Mailer spelling with and without the space
mikel authored
255 # but Action Mailer translates them appropriately and sets the correct values.
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
256 #
fb30feb @mikel Adding more docs to ActionMailer
mikel authored
257 # As you can pass in any header, you need to either quote the header as a string, or pass it in as
b72cd29 @mikel Fixing spelling
mikel authored
258 # an underscored symbol, so the following will work:
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
259 #
fb30feb @mikel Adding more docs to ActionMailer
mikel authored
260 # class Notifier < ActionMailer::Base
261 # default 'Content-Transfer-Encoding' => '7bit',
262 # :content_description => 'This is a description'
263 # end
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
264 #
058f7fe @mikel Cleaning up Action Mailer spelling with and without the space
mikel authored
265 # Finally, Action Mailer also supports passing <tt>Proc</tt> objects into the default hash, so you
fb30feb @mikel Adding more docs to ActionMailer
mikel authored
266 # can define methods that evaluate as the message is being generated:
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
267 #
fb30feb @mikel Adding more docs to ActionMailer
mikel authored
268 # class Notifier < ActionMailer::Base
269 # default 'X-Special-Header' => Proc.new { my_method }
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
270 #
fb30feb @mikel Adding more docs to ActionMailer
mikel authored
271 # private
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
272 #
fb30feb @mikel Adding more docs to ActionMailer
mikel authored
273 # def my_method
274 # 'some complex call'
275 # end
276 # end
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
277 #
fb30feb @mikel Adding more docs to ActionMailer
mikel authored
278 # Note that the proc is evaluated right at the start of the mail message generation, so if you
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
279 # set something in the defaults using a proc, and then set the same thing inside of your
fb30feb @mikel Adding more docs to ActionMailer
mikel authored
280 # mailer method, it will get over written by the mailer method.
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
281 #
3009c63 @carlosantoniodasilva Improve docs, changelog and release notes for Action Mailer default_o…
carlosantoniodasilva authored
282 # It is also possible to set these default options that will be used in all mailers through
283 # the <tt>default_options=</tt> configuration in <tt>config/application.rb</tt>:
284 #
285 # config.action_mailer.default_options = { from: "no-reply@example.org" }
286 #
4f28c4f @jsl Add ability to define callbacks in ActionMailer using AbstractControl…
jsl authored
287 # = Callbacks
288 #
289 # You can specify callbacks using before_filter and after_filter for configuring your messages.
290 # This may be useful, for example, when you want to add default inline attachments for all
291 # messages sent out by a certain mailer class:
292 #
293 # class Notifier < ActionMailer::Base
294 # before_filter :add_inline_attachment!
295 #
296 # def welcome
297 # mail
298 # end
299 #
300 # private
301 #
302 # def add_inline_attachment!
303 # attachments.inline["footer.jpg"] = File.read('/path/to/filename.jpg')
304 # end
305 # end
306 #
307 # Callbacks in ActionMailer are implemented using AbstractController::Callbacks, so you
308 # can define and configure callbacks in the same manner that you would use callbacks in
309 # classes that inherit from ActionController::Base.
310 #
311 # Note that unless you have a specific reason to do so, you should prefer using before_filter
312 # rather than after_filter in your ActionMailer classes so that headers are parsed properly.
313 #
c927aa0 @dhh Updated documentation
dhh authored
314 # = Configuration options
315 #
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
316 # These options are specified on the class level, like
e968acc @radar Update ActionMailer documentation to not use deprecated template_root…
radar authored
317 # <tt>ActionMailer::Base.raise_delivery_errors = true</tt>
c927aa0 @dhh Updated documentation
dhh authored
318 #
fb30feb @mikel Adding more docs to ActionMailer
mikel authored
319 # * <tt>default</tt> - You can pass this in at a class level as well as within the class itself as
320 # per the above section.
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
321 #
c927aa0 @dhh Updated documentation
dhh authored
322 # * <tt>logger</tt> - the logger is used for generating information on the mailing run if available.
323 # Can be set to nil for no logging. Compatible with both Ruby's own Logger and Log4r loggers.
324 #
64092de @fxn Improve documentation coverage and markup
fxn authored
325 # * <tt>smtp_settings</tt> - Allows detailed configuration for <tt>:smtp</tt> delivery method:
bb2c7b4 @mikel Updating Action Mailer documentation
mikel authored
326 # * <tt>:address</tt> - Allows you to use a remote mail server. Just change it from its default
327 # "localhost" setting.
dc4eec1 @lifo Merge docrails:
lifo authored
328 # * <tt>:port</tt> - On the off chance that your mail server doesn't run on port 25, you can change it.
329 # * <tt>:domain</tt> - If you need to specify a HELO domain, you can do it here.
330 # * <tt>:user_name</tt> - If your mail server requires authentication, set the username in this setting.
331 # * <tt>:password</tt> - If your mail server requires authentication, set the password in this setting.
bb2c7b4 @mikel Updating Action Mailer documentation
mikel authored
332 # * <tt>:authentication</tt> - If your mail server requires authentication, you need to specify the
333 # authentication type here.
5a898e1 Explain actionamailer authentication types
Peter Baker authored
334 # This is a symbol and one of <tt>:plain</tt> (will send the password in the clear), <tt>:login</tt> (will
3457db7 @dalibor Correct spelling for Base64 in action_mailer
dalibor authored
335 # send password Base64 encoded) or <tt>:cram_md5</tt> (combines a Challenge/Response mechanism to exchange
5a898e1 Explain actionamailer authentication types
Peter Baker authored
336 # information and a cryptographic Message Digest 5 algorithm to hash important information)
bb2c7b4 @mikel Updating Action Mailer documentation
mikel authored
337 # * <tt>:enable_starttls_auto</tt> - When set to true, detects if STARTTLS is enabled in your SMTP server
338 # and starts to use it.
d500ad3 @joshk Removed deprecated ActionMailer API and related tests
joshk authored
339 # * <tt>:openssl_verify_mode</tt> - When using TLS, you can set how OpenSSL checks the certificate. This is
340 # really useful if you need to validate a self-signed and/or a wildcard certificate. You can use the name
341 # of an OpenSSL verify constant ('none', 'peer', 'client_once','fail_if_no_peer_cert') or directly the
a1639ad @flop Undocumented :openssl_verify_mode option for smtp_settings
flop authored
342 # constant (OpenSSL::SSL::VERIFY_NONE, OpenSSL::SSL::VERIFY_PEER,...).
c927aa0 @dhh Updated documentation
dhh authored
343 #
46f30f9 @lifo Merge documentation changes from docrails.
lifo authored
344 # * <tt>sendmail_settings</tt> - Allows you to override options for the <tt>:sendmail</tt> delivery method.
345 # * <tt>:location</tt> - The location of the sendmail executable. Defaults to <tt>/usr/sbin/sendmail</tt>.
b72cd29 @mikel Fixing spelling
mikel authored
346 # * <tt>:arguments</tt> - The command line arguments. Defaults to <tt>-i -t</tt> with <tt>-f sender@address</tt>
bb2c7b4 @mikel Updating Action Mailer documentation
mikel authored
347 # added automatically before the message is sent.
dc4eec1 @lifo Merge docrails:
lifo authored
348 #
fbe6c3c @edavis10 Adds a :file delivery_method to save email to a file on disk
edavis10 authored
349 # * <tt>file_settings</tt> - Allows you to override options for the <tt>:file</tt> delivery method.
bb2c7b4 @mikel Updating Action Mailer documentation
mikel authored
350 # * <tt>:location</tt> - The directory into which emails will be written. Defaults to the application
351 # <tt>tmp/mails</tt>.
fbe6c3c @edavis10 Adds a :file delivery_method to save email to a file on disk
edavis10 authored
352 #
dc4eec1 @lifo Merge docrails:
lifo authored
353 # * <tt>raise_delivery_errors</tt> - Whether or not errors should be raised if the email fails to be delivered.
c927aa0 @dhh Updated documentation
dhh authored
354 #
bb2c7b4 @mikel Updating Action Mailer documentation
mikel authored
355 # * <tt>delivery_method</tt> - Defines a delivery method. Possible values are <tt>:smtp</tt> (default),
356 # <tt>:sendmail</tt>, <tt>:test</tt>, and <tt>:file</tt>. Or you may provide a custom delivery method
a4726d3 @dmathieu just specify what's to be done, not what's not to be.
dmathieu authored
357 # object e.g. MyOwnDeliveryMethodClass. See the Mail gem documentation on the interface you need to
bb2c7b4 @mikel Updating Action Mailer documentation
mikel authored
358 # implement for a custom delivery agent.
c927aa0 @dhh Updated documentation
dhh authored
359 #
bb2c7b4 @mikel Updating Action Mailer documentation
mikel authored
360 # * <tt>perform_deliveries</tt> - Determines whether emails are actually sent from Action Mailer when you
5d0d4d8 @smartinez87 Remove extra white spaces on ActionMailer docs.
smartinez87 authored
361 # call <tt>.deliver</tt> on an mail message or on an Action Mailer method. This is on by default but can
bb2c7b4 @mikel Updating Action Mailer documentation
mikel authored
362 # be turned off to aid in functional testing.
c927aa0 @dhh Updated documentation
dhh authored
363 #
bb2c7b4 @mikel Updating Action Mailer documentation
mikel authored
364 # * <tt>deliveries</tt> - Keeps an array of all the emails sent out through the Action Mailer with
365 # <tt>delivery_method :test</tt>. Most useful for unit and functional testing.
af56c80 @dhh Updated documentation
dhh authored
366 #
a25b5f6 @rafaelfranca Updating the documentation to ActionMailer::Base.queue
rafaelfranca authored
367 # * <tt>queue</> - The queue that will be used to deliver the mail. The queue should expect a job that
368 # responds to <tt>run</tt>
369 #
4964d3b @josevalim Make ActionMailer::Base inherit from AbstractController::Base
josevalim authored
370 class Base < AbstractController::Base
dbcf01e @mikel Removing quoting.rb, upgrade to 2.1.3.6, changing all utf-8 reference…
mikel authored
371 include DeliveryMethods
f30d73b Add new class delivery method API.
José Valim and Mikel Lindsaar authored
372 abstract!
373
c03c40b @josevalim Expose a _render_partial hook as thhe _render_template one and make u…
josevalim authored
374 include AbstractController::Logger
83f4d86 @dhh Rename the RenderingController module to just plain Rendering
dhh authored
375 include AbstractController::Rendering
a9751a7 @josevalim Refactor ActionMailer layout and remove legacy one.
josevalim authored
376 include AbstractController::Layouts
684c2dc @josevalim Remove ActionMailer helpers and rely on AbstractController one.
josevalim authored
377 include AbstractController::Helpers
48a3985 @josevalim Also include translation in ActionMailer.
josevalim authored
378 include AbstractController::Translation
08baa34 @dhh Extract assets paths and make them available to Action Mailer as well
dhh authored
379 include AbstractController::AssetPaths
4f28c4f @jsl Add ability to define callbacks in ActionMailer using AbstractControl…
jsl authored
380 include AbstractController::Callbacks
359caef @jamis A very thorough refactoring, resulting in new mail property setters a…
jamis authored
381
7d86235 @lest get rid of using instance_variable_names method from AS
lest authored
382 self.protected_instance_variables = [:@_action_has_layout]
d42bb68 @josevalim More updates to ivars list.
josevalim authored
383
972efa1 @josevalim Deprecate the old mailer API that was not deprecated yet.
josevalim authored
384 helper ActionMailer::MailHelper
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
385
c927aa0 @dhh Updated documentation
dhh authored
386 private_class_method :new #:nodoc:
db045db @dhh Initial
dhh authored
387
e5ab4b0 @jeremy Convert to class_attribute
jeremy authored
388 class_attribute :default_params
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored
389 self.default_params = {
390 :mime_version => "1.0",
dbcf01e @mikel Removing quoting.rb, upgrade to 2.1.3.6, changing all utf-8 reference…
mikel authored
391 :charset => "UTF-8",
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored
392 :content_type => "text/plain",
393 :parts_order => [ "text/plain", "text/enriched", "text/html" ]
e5ab4b0 @jeremy Convert to class_attribute
jeremy authored
394 }.freeze
e1c1318 Added delivers_from.
José Valim and Mikel Lindsaar authored
395
45537f0 @rafaelfranca Allow users to configure the queue for the mailers
rafaelfranca authored
396 class_attribute :queue
2a30150 @jeremy Use synchronous queue by default. Separate queued message delivery jo…
jeremy authored
397 self.queue = ActiveSupport::SynchronousQueue.new
45537f0 @rafaelfranca Allow users to configure the queue for the mailers
rafaelfranca authored
398
eda1719 @jamis ActionMailer::Base.deliver(email) had been accidentally removed, but …
jamis authored
399 class << self
284ca81 @joshk remove AM delegating register_observer and register_interceptor to Ma…
joshk authored
400 # Register one or more Observers which will be notified when mail is delivered.
401 def register_observers(*observers)
402 observers.flatten.compact.each { |observer| register_observer(observer) }
403 end
404
405 # Register one or more Interceptors which will be called before mail is sent.
406 def register_interceptors(*interceptors)
407 interceptors.flatten.compact.each { |interceptor| register_interceptor(interceptor) }
408 end
409
410 # Register an Observer which will be notified when mail is delivered.
411 # Either a class or a string can be passed in as the Observer. If a string is passed in
412 # it will be <tt>constantize</tt>d.
413 def register_observer(observer)
cb9e501 @joshk AM register_interceptor and register_observer only constantize if the…
joshk authored
414 delivery_observer = (observer.is_a?(String) ? observer.constantize : observer)
284ca81 @joshk remove AM delegating register_observer and register_interceptor to Ma…
joshk authored
415 Mail.register_observer(delivery_observer)
416 end
417
a467983 @vijaydev fix typo
vijaydev authored
418 # Register an Interceptor which will be called before mail is sent.
9a67a11 @siong1987 minor typo in the rdoc about Interceptor.
siong1987 authored
419 # Either a class or a string can be passed in as the Interceptor. If a string is passed in
284ca81 @joshk remove AM delegating register_observer and register_interceptor to Ma…
joshk authored
420 # it will be <tt>constantize</tt>d.
421 def register_interceptor(interceptor)
cb9e501 @joshk AM register_interceptor and register_observer only constantize if the…
joshk authored
422 delivery_interceptor = (interceptor.is_a?(String) ? interceptor.constantize : interceptor)
284ca81 @joshk remove AM delegating register_observer and register_interceptor to Ma…
joshk authored
423 Mail.register_interceptor(delivery_interceptor)
424 end
425
bd5ed65 @technoweenie Update ActionMailer so it treats ActionView the same way that ActionC…
technoweenie authored
426 def mailer_name
c17d200 @lest mailer can be anonymous
lest authored
427 @mailer_name ||= anonymous? ? "anonymous" : name.underscore
bd5ed65 @technoweenie Update ActionMailer so it treats ActionView the same way that ActionC…
technoweenie authored
428 end
0750304 @mikel Migrated over to Mail doing delivery.
mikel authored
429 attr_writer :mailer_name
430 alias :controller_path :mailer_name
81c416b @josevalim More refactoring on ActionMailer::Base.
josevalim authored
431
e5ab4b0 @jeremy Convert to class_attribute
jeremy authored
432 def default(value = nil)
433 self.default_params = default_params.merge(value).freeze if value
434 default_params
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored
435 end
3009c63 @carlosantoniodasilva Improve docs, changelog and release notes for Action Mailer default_o…
carlosantoniodasilva authored
436 # Allows to set defaults through app configuration:
437 #
438 # config.action_mailer.default_options = { from: "no-reply@example.org" }
edaa2c4 @paneq Introduce config.action_mailer.default_from=
paneq authored
439 alias :default_options= :default
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored
440
59f1df1 @jamis Update/extend ActionMailer documentation (rdoc)
jamis authored
441 # Receives a raw email, parses it into an email object, decodes it,
442 # instantiates a new mailer, and passes the email object to the mailer
98dc582 @lifo Merge docrails.
lifo authored
443 # object's +receive+ method. If you want your mailer to be able to
444 # process incoming messages, you'll need to implement a +receive+
bb2c7b4 @mikel Updating Action Mailer documentation
mikel authored
445 # method that accepts the raw email string as a parameter:
59f1df1 @jamis Update/extend ActionMailer documentation (rdoc)
jamis authored
446 #
447 # class MyMailer < ActionMailer::Base
448 # def receive(mail)
449 # ...
450 # end
451 # end
704daad @josevalim Ensure we just send Ruby Stdlib objects in ActionMailer notifications.
josevalim authored
452 def receive(raw_mail)
731d439 @jaggederest Change event namespace ordering to most-significant first [#4504 stat…
jaggederest authored
453 ActiveSupport::Notifications.instrument("receive.action_mailer") do |payload|
704daad @josevalim Ensure we just send Ruby Stdlib objects in ActionMailer notifications.
josevalim authored
454 mail = Mail.new(raw_mail)
455 set_payload_for_mail(payload, mail)
2a6bc12 @josevalim Add subscriber to ActionMailer.
josevalim authored
456 new.receive(mail)
457 end
eda1719 @jamis ActionMailer::Base.deliver(email) had been accidentally removed, but …
jamis authored
458 end
459
bb2c7b4 @mikel Updating Action Mailer documentation
mikel authored
460 # Wraps an email delivery inside of Active Support Notifications instrumentation. This
de65c82 @rizwanreza Changes call backs to callbacks.
rizwanreza authored
461 # method is actually called by the <tt>Mail::Message</tt> object itself through a callback
bb2c7b4 @mikel Updating Action Mailer documentation
mikel authored
462 # when you call <tt>:deliver</tt> on the Mail::Message, calling +deliver_mail+ directly
463 # 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…
José Valim and Mikel Lindsaar authored
464 def deliver_mail(mail) #:nodoc:
731d439 @jaggederest Change event namespace ordering to most-significant first [#4504 stat…
jaggederest authored
465 ActiveSupport::Notifications.instrument("deliver.action_mailer") do |payload|
c176397 @sachin87 some modifications in action_mailer/base.rb
sachin87 authored
466 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
467 yield # Let Mail do the delivery actions
258ca14 Delegated ActionMailer::Base.deliveries to Mail.deliveries, added cal…
José Valim and Mikel Lindsaar authored
468 end
469 end
470
ad8dc5a @mikel Should use standard ruby signature for respond_to
mikel authored
471 def respond_to?(method, include_private = false) #:nodoc:
99f960a Handle some TODOs and deprecations.
José Valim and Mikel Lindsaar authored
472 super || action_methods.include?(method.to_s)
473 end
474
475 protected
476
704daad @josevalim Ensure we just send Ruby Stdlib objects in ActionMailer notifications.
josevalim authored
477 def set_payload_for_mail(payload, mail) #:nodoc:
e8c9cac @tenderlove self is implied, so remove self
tenderlove authored
478 payload[:mailer] = name
c905fce @josevalim Add message_id to AM payload and don't send bcc and cc if they were n…
josevalim authored
479 payload[:message_id] = mail.message_id
480 payload[:subject] = mail.subject
481 payload[:to] = mail.to
482 payload[:from] = mail.from
483 payload[:bcc] = mail.bcc if mail.bcc.present?
484 payload[:cc] = mail.cc if mail.cc.present?
485 payload[:date] = mail.date
486 payload[:mail] = mail.encoded
704daad @josevalim Ensure we just send Ruby Stdlib objects in ActionMailer notifications.
josevalim authored
487 end
f30d73b Add new class delivery method API.
José Valim and Mikel Lindsaar authored
488
34b23e7 @spastorino Action Mailer async flag is true by default using a Synchronous impl
spastorino authored
489 def method_missing(method_name, *args)
490 if action_methods.include?(method_name.to_s)
491 QueuedMessage.new(queue, self, method_name, *args)
492 else
493 super
494 end
495 end
eda1719 @jamis ActionMailer::Base.deliver(email) had been accidentally removed, but …
jamis authored
496 end
497
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored
498 attr_internal :message
499
6ba9446 Make implicit and explicit templates pass through the same part creat…
José Valim and Mikel Lindsaar authored
500 # Instantiate a new mailer object. If +method_name+ is not +nil+, the mailer
501 # will be initialized according to the named method. If not, the mailer will
502 # remain uninitialized (useful when you only need to invoke the "receive"
503 # method, for instance).
504 def initialize(method_name=nil, *args)
505 super()
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored
506 @_message = Mail.new
6ba9446 Make implicit and explicit templates pass through the same part creat…
José Valim and Mikel Lindsaar authored
507 process(method_name, *args) if method_name
508 end
509
3fc609e @josevalim Fix ActionMailer test broken in 99d54599215c2a8cea7e57f609e8e578043d71b2
josevalim authored
510 def process(*args) #:nodoc:
511 lookup_context.skip_default_locale!
512 super
513 end
514
972efa1 @josevalim Deprecate the old mailer API that was not deprecated yet.
josevalim authored
515 def mailer_name
516 self.class.mailer_name
517 end
518
8cc4159 @mark-rushakoff Use <tt>Foo::Bar</tt> instead of +Foo::Bar+
mark-rushakoff authored
519 # Allows you to pass random and unusual headers to the new <tt>Mail::Message</tt> object
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
520 # which will add them to itself.
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
521 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
522 # headers['X-Special-Domain-Specific-Header'] = "SecretValue"
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
523 #
9520166 @mikel Fixed up being able to pass random headers in with headers, or mail. …
mikel authored
524 # You can also pass a hash into headers of header field names and values, which
525 # will then be set on the Mail::Message object:
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
526 #
05c4ad9 Tidy up tests and docs.
José Valim and Mikel Lindsaar authored
527 # headers 'X-Special-Domain-Specific-Header' => "SecretValue",
528 # 'In-Reply-To' => incoming.message_id
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
529 #
ff44c33 @mark-rushakoff Fix it's -> its
mark-rushakoff authored
530 # The resulting Mail::Message will have the following in its header:
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
531 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
532 # X-Special-Domain-Specific-Header: SecretValue
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored
533 def headers(args=nil)
534 if args
9520166 @mikel Fixed up being able to pass random headers in with headers, or mail. …
mikel authored
535 @_message.headers(args)
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored
536 else
537 @_message
538 end
539 end
c34cfcc @mikel Created mail method for new API
mikel authored
540
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
541 # Allows you to add attachments to an email, like so:
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
542 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
543 # mail.attachments['filename.jpg'] = File.read('/path/to/filename.jpg')
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
544 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
545 # If you do this, then Mail will take the file name and work out the mime type
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
546 # set the Content-Type, Content-Disposition, Content-Transfer-Encoding and
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
547 # base64 encode the contents of the attachment all for you.
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
548 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
549 # You can also specify overrides if you want by passing a hash instead of a string:
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
550 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
551 # mail.attachments['filename.jpg'] = {:mime_type => 'application/x-gzip',
552 # :content => File.read('/path/to/filename.jpg')}
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
553 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
554 # If you want to use a different encoding than Base64, you can pass an encoding in,
555 # but then it is up to you to pass in the content pre-encoded, and don't expect
556 # Mail to know how to decode this data:
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
557 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
558 # file_content = SpecialEncode(File.read('/path/to/filename.jpg'))
559 # mail.attachments['filename.jpg'] = {:mime_type => 'application/x-gzip',
560 # :encoding => 'SpecialEncoding',
561 # :content => file_content }
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
562 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
563 # You can also search for specific attachments:
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
564 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
565 # # By Filename
755af49 @fxn edit pass to apply API guideline wrt the use of "# =>" in example code
fxn authored
566 # mail.attachments['filename.jpg'] # => Mail::Part object or nil
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
567 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
568 # # or by index
755af49 @fxn edit pass to apply API guideline wrt the use of "# =>" in example code
fxn authored
569 # mail.attachments[0] # => Mail::Part (first attachment)
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
570 #
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored
571 def attachments
572 @_message.attachments
573 end
dcb9253 Add basic template rendering to new DSL.
José Valim and Mikel Lindsaar authored
574
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
575 # The main method that creates the message and renders the email templates. There are
576 # two ways to call this method, with a block, or without a block.
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
577 #
6589976 Remove old files, add some information to docs and improve test suite.
José Valim and Mikel Lindsaar authored
578 # 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
579 # in an email message, these are:
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
580 #
058f7fe @mikel Cleaning up Action Mailer spelling with and without the space
mikel authored
581 # * <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
582 # ask the Rails I18n class for a translated <tt>:subject</tt> in the scope of
66880cf @Odaeus Correct ActionMailer subject i18n lookup scope.
Odaeus authored
583 # <tt>[mailer_scope, action_name]</tt> or if this is missing, will translate the
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
584 # humanized version of the <tt>action_name</tt>
585 # * <tt>:to</tt> - Who the message is destined for, can be a string of addresses, or an array
586 # of addresses.
0b05acd @mikel Implementing class level :defaults hash, instead of delivers_from et al
mikel authored
587 # * <tt>:from</tt> - Who the message is from
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
588 # * <tt>:cc</tt> - Who you would like to Carbon-Copy on this email, can be a string of addresses,
589 # or an array of addresses.
590 # * <tt>:bcc</tt> - Who you would like to Blind-Carbon-Copy on this email, can be a string of
591 # addresses, or an array of addresses.
592 # * <tt>:reply_to</tt> - Who to set the Reply-To header of the email to.
593 # * <tt>:date</tt> - The date to say the email was sent on.
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
594 #
595 # You can set default values for any of the above headers (except :date) by using the <tt>default</tt>
0b05acd @mikel Implementing class level :defaults hash, instead of delivers_from et al
mikel authored
596 # class method:
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
597 #
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored
598 # class Notifier < ActionMailer::Base
452bb1e @jeremy Rename 'defaults' class method to 'default' to reflect that it's a de…
jeremy authored
599 # self.default :from => 'no-reply@test.lindsaar.net',
600 # :bcc => 'email_logger@test.lindsaar.net',
601 # :reply_to => 'bounces@test.lindsaar.net'
0b05acd @mikel Implementing class level :defaults hash, instead of delivers_from et al
mikel authored
602 # end
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
603 #
52c56f9 @wincent docs: note that mail() accepts arbitrary headers
wincent authored
604 # If you need other headers not listed above, you can either pass them in
605 # as part of the headers hash or use the <tt>headers['name'] = value</tt>
606 # method.
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
607 #
6589976 Remove old files, add some information to docs and improve test suite.
José Valim and Mikel Lindsaar authored
608 # When a <tt>:return_path</tt> is specified as header, that value will be used as the 'envelope from'
5d0d4d8 @smartinez87 Remove extra white spaces on ActionMailer docs.
smartinez87 authored
609 # address for the Mail message. Setting this is useful when you want delivery notifications
610 # 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
611 # <tt>:return_path</tt> in preference to the <tt>:sender</tt> in preference to the <tt>:from</tt>
612 # field for the 'envelope from' value.
613 #
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
614 # If you do not pass a block to the +mail+ method, it will find all templates in the
be35a15 @josevalim Allow to choose the template path and template name used in implicit …
josevalim authored
615 # view paths using by default the mailer name and the method name that it is being
616 # called from, it will then create parts for each of these templates intelligently,
617 # making educated guesses on correct content type and sequence, and return a fully
618 # prepared Mail::Message ready to call <tt>:deliver</tt> on to send.
619 #
620 # For example:
621 #
622 # class Notifier < ActionMailer::Base
623 # default :from => 'no-reply@test.lindsaar.net',
624 #
625 # def welcome
626 # mail(:to => 'mikel@test.lindsaar.net')
627 # end
628 # end
629 #
45b1045 @dmathieu raise an error if no implicit mailer template could be found
dmathieu authored
630 # Will look for all templates at "app/views/notifier" with name "welcome".
631 # If no welcome template exists, it will raise an ActionView::MissingTemplate error.
632 #
633 # However, those can be customized:
be35a15 @josevalim Allow to choose the template path and template name used in implicit …
josevalim authored
634 #
635 # mail(:template_path => 'notifications', :template_name => 'another')
636 #
637 # 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
638 #
639 # If you do pass a block, you can render specific templates of your choice:
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
640 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
641 # mail(:to => 'mikel@test.lindsaar.net') do |format|
642 # format.text
643 # format.html
644 # end
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
645 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
646 # You can even render text directly without using a template:
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
647 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
648 # mail(:to => 'mikel@test.lindsaar.net') do |format|
649 # format.text { render :text => "Hello Mikel!" }
650 # format.html { render :text => "<h1>Hello Mikel!</h1>" }
651 # end
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
652 #
74a5889 Refactor content type setting, added tests to ensure boundary exists …
José Valim and Mikel Lindsaar authored
653 # 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
654 # <tt>text/html</tt> parts.
6589976 Remove old files, add some information to docs and improve test suite.
José Valim and Mikel Lindsaar authored
655 #
656 # The block syntax also allows you to customize the part headers if desired:
657 #
658 # mail(:to => 'mikel@test.lindsaar.net') do |format|
659 # format.text(:content_transfer_encoding => "base64")
660 # format.html
661 # end
662 #
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored
663 def mail(headers={}, &block)
664 m = @_message
258ca14 Delegated ActionMailer::Base.deliveries to Mail.deliveries, added cal…
José Valim and Mikel Lindsaar authored
665
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored
666 # At the beginning, do not consider class default for parts order neither content_type
667 content_type = headers[:content_type]
668 parts_order = headers[:parts_order]
1cd5592 First work on implicit multipart.
José Valim and Mikel Lindsaar authored
669
08b07b6 @mikel Adding ability to pass proc's to the ActionMailer class default method
mikel authored
670 # Call all the procs (if any)
c176397 @sachin87 some modifications in action_mailer/base.rb
sachin87 authored
671 class_default = self.class.default
672 default_values = class_default.merge(class_default) do |k,v|
3fbc042 @lest Use instance_eval instead of Proc#bind
lest authored
673 v.respond_to?(:to_proc) ? instance_eval(&v) : v
08b07b6 @mikel Adding ability to pass proc's to the ActionMailer class default method
mikel authored
674 end
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
675
b5f9a9f @josevalim Move set_fields! to the old API module.
josevalim authored
676 # Handle defaults
08b07b6 @mikel Adding ability to pass proc's to the ActionMailer class default method
mikel authored
677 headers = headers.reverse_merge(default_values)
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored
678 headers[:subject] ||= default_i18n_subject
b5f9a9f @josevalim Move set_fields! to the old API module.
josevalim authored
679
680 # Apply charset at the beginning so all fields are properly quoted
681 m.charset = charset = headers[:charset]
682
683 # Set configure delivery behavior
8fc8763 @asanghi Allow delivery method options to be set per mail instance
asanghi authored
684 wrap_delivery_behavior!(headers.delete(:delivery_method),headers.delete(:delivery_method_options))
b5f9a9f @josevalim Move set_fields! to the old API module.
josevalim authored
685
686 # Assign all headers except parts_order, content_type and body
b4fd5e6 @josevalim template_name and template_path should not be added to mail headers.
josevalim authored
687 assignable = headers.except(:parts_order, :content_type, :body, :template_name, :template_path)
b5f9a9f @josevalim Move set_fields! to the old API module.
josevalim authored
688 assignable.each { |k, v| m[k] = v }
951397b Get implicit multipart and attachments working together.
José Valim and Mikel Lindsaar authored
689
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored
690 # Render the templates and blocks
39a1b06 Deprecate old defaults API.
José Valim and Mikel Lindsaar authored
691 responses, explicit_order = collect_responses_and_parts_order(headers, &block)
b5f9a9f @josevalim Move set_fields! to the old API module.
josevalim authored
692 create_parts_from_responses(m, responses)
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored
693
b5f9a9f @josevalim Move set_fields! to the old API module.
josevalim authored
694 # Setup content type, reapply charset and handle parts order
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored
695 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
696 m.charset = charset
697
e7e4ed4 Set sort order for explicit parts from the collector's template sequence
José Valim and Mikel Lindsaar authored
698 if m.multipart?
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored
699 parts_order ||= explicit_order || headers[:parts_order]
700 m.body.set_sort_order(parts_order)
951397b Get implicit multipart and attachments working together.
José Valim and Mikel Lindsaar authored
701 m.body.sort_parts!
702 end
bb9d71f Move class methods to deprecated stuff.
José Valim and Mikel Lindsaar authored
703
c34cfcc @mikel Created mail method for new API
mikel authored
704 m
705 end
706
6ba9446 Make implicit and explicit templates pass through the same part creat…
José Valim and Mikel Lindsaar authored
707 protected
708
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored
709 def set_content_type(m, user_content_type, class_default)
74a5889 Refactor content type setting, added tests to ensure boundary exists …
José Valim and Mikel Lindsaar authored
710 params = m.content_type_parameters || {}
711 case
712 when user_content_type.present?
713 user_content_type
714 when m.has_attachments?
311d99e @mikel Adding inline attachment support to ActionMailer
mikel authored
715 if m.attachments.detect { |a| a.inline? }
716 ["multipart", "related", params]
717 else
718 ["multipart", "mixed", params]
719 end
74a5889 Refactor content type setting, added tests to ensure boundary exists …
José Valim and Mikel Lindsaar authored
720 when m.multipart?
721 ["multipart", "alternative", params]
722 else
b6b3db6 @mikel Fixed bug on HTML only emails getting set to text/plain
mikel authored
723 m.content_type || class_default
74a5889 Refactor content type setting, added tests to ensure boundary exists …
José Valim and Mikel Lindsaar authored
724 end
725 end
726
11b67b3 @indrekj fix default_i18n_subject comment in ActionMailer::Base
indrekj authored
727 # Translates the +subject+ using Rails I18n class under <tt>[mailer_scope, action_name]</tt> scope.
082e299 @smartinez87 docs for ActionMailer::Base.default_i18n_subject
smartinez87 authored
728 # If it does not find a translation for the +subject+ under the specified scope it will default to a
729 # humanized version of the <tt>action_name</tt>.
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored
730 def default_i18n_subject #:nodoc:
2d8396f @jurriaan Updated/changed useless tr/gsubs
jurriaan authored
731 mailer_scope = self.class.mailer_name.tr('/', '.')
30eaecb @josevalim subject is automatically looked up on I18n using mailer_name and acti…
josevalim authored
732 I18n.t(:subject, :scope => [mailer_scope, action_name], :default => action_name.humanize)
5c3ef8c Refactor subject with i18n.
José Valim and Mikel Lindsaar authored
733 end
734
39a1b06 Deprecate old defaults API.
José Valim and Mikel Lindsaar authored
735 def collect_responses_and_parts_order(headers) #:nodoc:
736 responses, parts_order = [], nil
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored
737
738 if block_given?
a09e992 @josevalim Ensure details are frozen after @details_keys lookup. The implementat…
josevalim authored
739 collector = ActionMailer::Collector.new(lookup_context) { render(action_name) }
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored
740 yield(collector)
39a1b06 Deprecate old defaults API.
José Valim and Mikel Lindsaar authored
741 parts_order = collector.responses.map { |r| r[:content_type] }
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored
742 responses = collector.responses
743 elsif headers[:body]
744 responses << {
be35a15 @josevalim Allow to choose the template path and template name used in implicit …
josevalim authored
745 :body => headers.delete(:body),
452bb1e @jeremy Rename 'defaults' class method to 'default' to reflect that it's a de…
jeremy authored
746 :content_type => self.class.default[:content_type] || "text/plain"
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored
747 }
748 else
be35a15 @josevalim Allow to choose the template path and template name used in implicit …
josevalim authored
749 templates_path = headers.delete(:template_path) || self.class.mailer_name
750 templates_name = headers.delete(:template_name) || action_name
751
752 each_template(templates_path, templates_name) do |template|
f28d856 @josevalim Improve performance of the rendering stack by freezing formats as a s…
josevalim authored
753 self.formats = template.formats
754
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored
755 responses << {
2a12686 @josevalim Allow anything that responds to render to be given as :template and u…
josevalim authored
756 :body => render(:template => template),
167f250 @kennyj Fixes warnings when executing rake test in ActionMailer. Related to 5…
kennyj authored
757 :content_type => template.type.to_s
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored
758 }
759 end
760 end
761
39a1b06 Deprecate old defaults API.
José Valim and Mikel Lindsaar authored
762 [responses, parts_order]
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored
763 end
764
be35a15 @josevalim Allow to choose the template path and template name used in implicit …
josevalim authored
765 def each_template(paths, name, &block) #:nodoc:
3438f6c @rafaelfranca Array.wrap is no longer needed here
rafaelfranca authored
766 templates = lookup_context.find_all(name, Array(paths))
45b1045 @dmathieu raise an error if no implicit mailer template could be found
dmathieu authored
767 if templates.empty?
768 raise ActionView::MissingTemplate.new([paths], name, [paths], false, 'mailer')
769 else
770 templates.uniq { |t| t.formats }.each(&block)
771 end
99f960a Handle some TODOs and deprecations.
José Valim and Mikel Lindsaar authored
772 end
773
b5f9a9f @josevalim Move set_fields! to the old API module.
josevalim authored
774 def create_parts_from_responses(m, responses) #:nodoc:
6ba9446 Make implicit and explicit templates pass through the same part creat…
José Valim and Mikel Lindsaar authored
775 if responses.size == 1 && !m.has_attachments?
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored
776 responses[0].each { |k,v| m[k] = v }
74a5889 Refactor content type setting, added tests to ensure boundary exists …
José Valim and Mikel Lindsaar authored
777 elsif responses.size > 1 && m.has_attachments?
6ba9446 Make implicit and explicit templates pass through the same part creat…
José Valim and Mikel Lindsaar authored
778 container = Mail::Part.new
74a5889 Refactor content type setting, added tests to ensure boundary exists …
José Valim and Mikel Lindsaar authored
779 container.content_type = "multipart/alternative"
b5f9a9f @josevalim Move set_fields! to the old API module.
josevalim authored
780 responses.each { |r| insert_part(container, r, m.charset) }
6ba9446 Make implicit and explicit templates pass through the same part creat…
José Valim and Mikel Lindsaar authored
781 m.add_part(container)
782 else
b5f9a9f @josevalim Move set_fields! to the old API module.
josevalim authored
783 responses.each { |r| insert_part(m, r, m.charset) }
6ba9446 Make implicit and explicit templates pass through the same part creat…
José Valim and Mikel Lindsaar authored
784 end
359caef @jamis A very thorough refactoring, resulting in new mail property setters a…
jamis authored
785 end
786
6ba9446 Make implicit and explicit templates pass through the same part creat…
José Valim and Mikel Lindsaar authored
787 def insert_part(container, response, charset) #:nodoc:
788 response[:charset] ||= charset
789 part = Mail::Part.new(response)
790 container.add_part(part)
359caef @jamis A very thorough refactoring, resulting in new mail property setters a…
jamis authored
791 end
3fad0cd @dhh Added support for charsets for both subject and body. The default cha…
dhh authored
792
ef5dada @nex3 Only run load hooks once a file has been fully loaded.
nex3 authored
793 ActiveSupport.run_load_hooks(:action_mailer, self)
db045db @dhh Initial
dhh authored
794 end
edaa2c4 @paneq Introduce config.action_mailer.default_from=
paneq authored
795 end
Something went wrong with that request. Please try again.