Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 806 lines (754 sloc) 34.232 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
7c0e3b8 @vijaydev remove nodoc [ci skip]
vijaydev authored
10 module ActionMailer
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored
11 # Action Mailer allows you to send email from your application using a mailer model and views.
db045db @dhh Initial
dhh authored
12 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca 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 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca 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
96f290e @Locke23rus Update actionmailer with new hash syntax.
Locke23rus authored
26 # default from: 'no-reply@example.com',
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
96f290e @Locke23rus Update actionmailer with new hash syntax.
Locke23rus authored
31 # mail(to: recipient.email_address_with_name,
32 # bcc: ["bcc@example.com", "Order Watcher <watcher@example.com>"])
0f0213f @siong1987 minor spacing fix in code example in ActionMailer::Base.
siong1987 authored
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 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca 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 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca 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>
3762362 @mikel Updating readme for ActionMailer::Base
mikel authored
43 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored
44 # * <tt>headers[]=</tt> - Allows you to specify any header field in your email such
45 # as <tt>headers['X-No-Spam'] = 'True'</tt>. Note, while most fields like <tt>To:</tt>
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,
48 # you need to set it to nil first so that Mail knows you are replacing it and not adding
daad445 @neerajdotname itsy bitsy changes to ActionMailer documentation
neerajdotname authored
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 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca 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>
9520166 @mikel Fixed up being able to pass random headers in with headers, or mail. …
mikel authored
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 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored
56 # The hash passed to the mail method allows you to specify any header that a Mail::Message
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 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored
59 # The mail method, if not passed a block, will inspect your views and send all the views with
60 # the same name as the method, so the above action would send the +welcome.text.erb+ view
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 #
96f290e @Locke23rus Update actionmailer with new hash syntax.
Locke23rus 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 #
96f290e @Locke23rus Update actionmailer with new hash syntax.
Locke23rus authored
72 # mail(to: user.email) do |format|
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored
73 # format.text(:content_transfer_encoding => "base64")
6589976 Remove old files, add some information to docs and improve test suite.
José Valim and Mikel Lindsaar authored
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 #
96f290e @Locke23rus Update actionmailer with new hash syntax.
Locke23rus 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
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored
81 # format.html { render "some_other_template" }
6589976 Remove old files, add some information to docs and improve test suite.
José Valim and Mikel Lindsaar authored
82 # end
83 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored
84 # = Mailer views
20bd4bd @dhh Updated docs and otherwise
dhh authored
85 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca 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 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca 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
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 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored
93 # Variables defined in the model are accessible as instance variables in the view.
0a407bc ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, …
Marcel Molina authored
94 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored
95 # Emails by default are sent in plain text, so a sample view for our model example might look like this:
0a407bc ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, …
Marcel Molina authored
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!
96f290e @Locke23rus Update actionmailer with new hash syntax.
Locke23rus 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 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca 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 %>!
96f290e @Locke23rus Update actionmailer with new hash syntax.
Locke23rus 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 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored
111 # = Generating URLs
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Infl…
josh authored
112 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored
113 # URLs can be generated in mailer views using <tt>url_for</tt> or named routes. Unlike controllers from
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 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca 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 #
96f290e @Locke23rus Update actionmailer with new hash syntax.
Locke23rus 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 #
96f290e @Locke23rus Update actionmailer with new hash syntax.
Locke23rus authored
123 # <%= users_url(host: "example.com") %>
4809dcc * Remove default_url_options from mailer generator
Cody Fauser authored
124 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
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
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 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored
129 # It is also possible to set a default host that will be used in all mailers by setting the <tt>:host</tt>
130 # option as a configuration option in <tt>config/application.rb</tt>:
4809dcc * Remove default_url_options from mailer generator
Cody Fauser authored
131 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored
132 # config.action_mailer.default_url_options = { :host => "example.com" }
20bd4bd @dhh Updated docs and otherwise
dhh authored
133 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored
134 # When you decide to set a default <tt>:host</tt> for your mailers, then you need to make sure to use the
135 # <tt>:only_path => false</tt> option when using <tt>url_for</tt>. Since the <tt>url_for</tt> view helper
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 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored
139 # = Sending mail
20bd4bd @dhh Updated docs and otherwise
dhh authored
140 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored
141 # Once a mailer action and template are defined, you can deliver your message or create it and save it
142 # for delivery later:
0a407bc ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, …
Marcel Molina authored
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 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca 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 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
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
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 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca 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 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca 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 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca 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')
96f290e @Locke23rus Update actionmailer with new hash syntax.
Locke23rus 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 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored
182 # Which will (if it had both a <tt>welcome.text.erb</tt> and <tt>welcome.text.html.erb</tt>
183 # template in the view directory), send a complete <tt>multipart/mixed</tt> email with two parts,
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 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca 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:
45b1045 @dmathieu raise an error if no implicit mailer template could be found
dmathieu authored
190 #
191 # class ApplicationMailer < ActionMailer::Base
192 # def welcome(recipient)
193 # attachments['free_book.pdf'] = File.read('path/to/file.pdf')
96f290e @Locke23rus Update actionmailer with new hash syntax.
Locke23rus authored
194 # mail(to: recipient, subject: "New account information", body: "")
45b1045 @dmathieu raise an error if no implicit mailer template could be found
dmathieu authored
195 # end
196 # end
197 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored
198 # = Inline Attachments
b451de0 @spastorino Deletes trailing whitespaces (over text files only find * -type f -ex…
spastorino authored
199 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored
200 # You can also specify that a file should be displayed inline with other HTML. This is useful
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')
96f290e @Locke23rus Update actionmailer with new hash syntax.
Locke23rus authored
206 # mail(to: recipient, subject: "Here is what we look like")
3762362 @mikel Updating readme for ActionMailer::Base
mikel authored
207 # end
208 # end
b451de0 @spastorino Deletes trailing whitespaces (over text files only find * -type f -ex…
spastorino authored
209 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored
210 # And then to reference the image in the view, you create a <tt>welcome.html.erb</tt> file and
211 # make a call to +image_tag+ passing in the attachment you want to display and then call
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 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca 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 #
96f290e @Locke23rus Update actionmailer with new hash syntax.
Locke23rus 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 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored
224 # = Observing and Intercepting Mails
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
225 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored
226 # Action Mailer provides hooks into the Mail observer and interceptor methods. These allow you to
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 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored
229 # An observer class must implement the <tt>:delivered_email(message)</tt> method which will be
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 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored
232 # An interceptor class must implement the <tt>:delivering_email(message)</tt> method which will be
233 # called before the email is sent, allowing you to make modifications to the email before it hits
234 # the delivery agents. Your class should make any needed modifications directly to the passed
235 # in Mail::Message instance.
20bd4bd @dhh Updated docs and otherwise
dhh authored
236 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored
237 # = Default Hash
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
238 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored
239 # Action Mailer provides some intelligent defaults for your emails, these are usually specified in a
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
96f290e @Locke23rus Update actionmailer with new hash syntax.
Locke23rus authored
243 # default sender: 'system@example.com'
fb30feb @mikel Adding more docs to ActionMailer
mikel authored
244 # end
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
245 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca 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 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca 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 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored
254 # <tt>parts_order</tt> and <tt>charset</tt> are not actually valid <tt>Mail::Message</tt> header fields,
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 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored
257 # As you can pass in any header, you need to either quote the header as a string, or pass it in as
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',
96f290e @Locke23rus Update actionmailer with new hash syntax.
Locke23rus authored
262 # content_description: 'This is a description'
fb30feb @mikel Adding more docs to ActionMailer
mikel authored
263 # end
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
264 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored
265 # Finally, Action Mailer also supports passing <tt>Proc</tt> objects into the default hash, so you
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 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored
278 # Note that the proc is evaluated right at the start of the mail message generation, so if you
279 # set something in the defaults using a proc, and then set the same thing inside of your
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 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca 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>:
3009c63 @carlosantoniodasilva Improve docs, changelog and release notes for Action Mailer default_o…
carlosantoniodasilva authored
284 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored
285 # config.action_mailer.default_options = { from: "no-reply@example.org" }
3009c63 @carlosantoniodasilva Improve docs, changelog and release notes for Action Mailer default_o…
carlosantoniodasilva authored
286 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored
287 # = Callbacks
4f28c4f @jsl Add ability to define callbacks in ActionMailer using AbstractControl…
jsl authored
288 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored
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:
4f28c4f @jsl Add ability to define callbacks in ActionMailer using AbstractControl…
jsl authored
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!
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored
303 # attachments.inline["footer.jpg"] = File.read('/path/to/filename.jpg')
4f28c4f @jsl Add ability to define callbacks in ActionMailer using AbstractControl…
jsl authored
304 # end
305 # end
306 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored
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.
4f28c4f @jsl Add ability to define callbacks in ActionMailer using AbstractControl…
jsl authored
310 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored
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.
4f28c4f @jsl Add ability to define callbacks in ActionMailer using AbstractControl…
jsl authored
313 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored
314 # = Configuration options
c927aa0 @dhh Updated documentation
dhh authored
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 #
3b7947e @vijaydev Merge branch 'master' of github.com:lifo/docrails
vijaydev authored
367 # * <tt>queue</> - The queue that will be used to deliver the mail. The queue should expect a job that responds to <tt>run</tt>.
4964d3b @josevalim Make ActionMailer::Base inherit from AbstractController::Base
josevalim authored
368 class Base < AbstractController::Base
dbcf01e @mikel Removing quoting.rb, upgrade to 2.1.3.6, changing all utf-8 reference…
mikel authored
369 include DeliveryMethods
f30d73b Add new class delivery method API.
José Valim and Mikel Lindsaar authored
370 abstract!
371
c03c40b @josevalim Expose a _render_partial hook as thhe _render_template one and make u…
josevalim authored
372 include AbstractController::Logger
83f4d86 @dhh Rename the RenderingController module to just plain Rendering
dhh authored
373 include AbstractController::Rendering
a9751a7 @josevalim Refactor ActionMailer layout and remove legacy one.
josevalim authored
374 include AbstractController::Layouts
684c2dc @josevalim Remove ActionMailer helpers and rely on AbstractController one.
josevalim authored
375 include AbstractController::Helpers
48a3985 @josevalim Also include translation in ActionMailer.
josevalim authored
376 include AbstractController::Translation
08baa34 @dhh Extract assets paths and make them available to Action Mailer as well
dhh authored
377 include AbstractController::AssetPaths
4f28c4f @jsl Add ability to define callbacks in ActionMailer using AbstractControl…
jsl authored
378 include AbstractController::Callbacks
359caef @jamis A very thorough refactoring, resulting in new mail property setters a…
jamis authored
379
7d86235 @lest get rid of using instance_variable_names method from AS
lest authored
380 self.protected_instance_variables = [:@_action_has_layout]
d42bb68 @josevalim More updates to ivars list.
josevalim authored
381
9f2d1a1 @fxn spurious space I saw in passing
fxn authored
382 helper ActionMailer::MailHelper
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
383
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored
384 private_class_method :new #:nodoc:
db045db @dhh Initial
dhh authored
385
e5ab4b0 @jeremy Convert to class_attribute
jeremy authored
386 class_attribute :default_params
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored
387 self.default_params = {
96f290e @Locke23rus Update actionmailer with new hash syntax.
Locke23rus authored
388 mime_version: "1.0",
389 charset: "UTF-8",
390 content_type: "text/plain",
391 parts_order: [ "text/plain", "text/enriched", "text/html" ]
e5ab4b0 @jeremy Convert to class_attribute
jeremy authored
392 }.freeze
e1c1318 Added delivers_from.
José Valim and Mikel Lindsaar authored
393
45537f0 @rafaelfranca Allow users to configure the queue for the mailers
rafaelfranca authored
394 class_attribute :queue
2a30150 @jeremy Use synchronous queue by default. Separate queued message delivery jo…
jeremy authored
395 self.queue = ActiveSupport::SynchronousQueue.new
45537f0 @rafaelfranca Allow users to configure the queue for the mailers
rafaelfranca authored
396
eda1719 @jamis ActionMailer::Base.deliver(email) had been accidentally removed, but …
jamis authored
397 class << self
284ca81 @joshk remove AM delegating register_observer and register_interceptor to Ma…
joshk authored
398 # Register one or more Observers which will be notified when mail is delivered.
399 def register_observers(*observers)
400 observers.flatten.compact.each { |observer| register_observer(observer) }
401 end
402
403 # Register one or more Interceptors which will be called before mail is sent.
404 def register_interceptors(*interceptors)
405 interceptors.flatten.compact.each { |interceptor| register_interceptor(interceptor) }
406 end
407
408 # Register an Observer which will be notified when mail is delivered.
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored
409 # Either a class or a string can be passed in as the Observer. If a string is passed in
410 # it will be <tt>constantize</tt>d.
284ca81 @joshk remove AM delegating register_observer and register_interceptor to Ma…
joshk authored
411 def register_observer(observer)
cb9e501 @joshk AM register_interceptor and register_observer only constantize if the…
joshk authored
412 delivery_observer = (observer.is_a?(String) ? observer.constantize : observer)
284ca81 @joshk remove AM delegating register_observer and register_interceptor to Ma…
joshk authored
413 Mail.register_observer(delivery_observer)
414 end
415
a467983 @vijaydev fix typo
vijaydev authored
416 # Register an Interceptor which will be called before mail is sent.
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored
417 # Either a class or a string can be passed in as the Interceptor. If a string is passed in
418 # it will be <tt>constantize</tt>d.
284ca81 @joshk remove AM delegating register_observer and register_interceptor to Ma…
joshk authored
419 def register_interceptor(interceptor)
cb9e501 @joshk AM register_interceptor and register_observer only constantize if the…
joshk authored
420 delivery_interceptor = (interceptor.is_a?(String) ? interceptor.constantize : interceptor)
284ca81 @joshk remove AM delegating register_observer and register_interceptor to Ma…
joshk authored
421 Mail.register_interceptor(delivery_interceptor)
422 end
423
bd5ed65 @technoweenie Update ActionMailer so it treats ActionView the same way that ActionC…
technoweenie authored
424 def mailer_name
c17d200 @lest mailer can be anonymous
lest authored
425 @mailer_name ||= anonymous? ? "anonymous" : name.underscore
bd5ed65 @technoweenie Update ActionMailer so it treats ActionView the same way that ActionC…
technoweenie authored
426 end
0750304 @mikel Migrated over to Mail doing delivery.
mikel authored
427 attr_writer :mailer_name
428 alias :controller_path :mailer_name
81c416b @josevalim More refactoring on ActionMailer::Base.
josevalim authored
429
e5ab4b0 @jeremy Convert to class_attribute
jeremy authored
430 def default(value = nil)
431 self.default_params = default_params.merge(value).freeze if value
432 default_params
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored
433 end
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored
434 # Allows to set defaults through app configuration:
3009c63 @carlosantoniodasilva Improve docs, changelog and release notes for Action Mailer default_o…
carlosantoniodasilva authored
435 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored
436 # config.action_mailer.default_options = { from: "no-reply@example.org" }
edaa2c4 @paneq Introduce config.action_mailer.default_from=
paneq authored
437 alias :default_options= :default
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored
438
59f1df1 @jamis Update/extend ActionMailer documentation (rdoc)
jamis authored
439 # Receives a raw email, parses it into an email object, decodes it,
440 # instantiates a new mailer, and passes the email object to the mailer
98dc582 @lifo Merge docrails.
lifo authored
441 # object's +receive+ method. If you want your mailer to be able to
442 # process incoming messages, you'll need to implement a +receive+
bb2c7b4 @mikel Updating Action Mailer documentation
mikel authored
443 # method that accepts the raw email string as a parameter:
59f1df1 @jamis Update/extend ActionMailer documentation (rdoc)
jamis authored
444 #
445 # class MyMailer < ActionMailer::Base
446 # def receive(mail)
447 # ...
448 # end
449 # end
704daad @josevalim Ensure we just send Ruby Stdlib objects in ActionMailer notifications.
josevalim authored
450 def receive(raw_mail)
731d439 @jaggederest Change event namespace ordering to most-significant first [#4504 stat…
jaggederest authored
451 ActiveSupport::Notifications.instrument("receive.action_mailer") do |payload|
704daad @josevalim Ensure we just send Ruby Stdlib objects in ActionMailer notifications.
josevalim authored
452 mail = Mail.new(raw_mail)
453 set_payload_for_mail(payload, mail)
2a6bc12 @josevalim Add subscriber to ActionMailer.
josevalim authored
454 new.receive(mail)
455 end
eda1719 @jamis ActionMailer::Base.deliver(email) had been accidentally removed, but …
jamis authored
456 end
457
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored
458 # Wraps an email delivery inside of Active Support Notifications instrumentation. This
459 # method is actually called by the <tt>Mail::Message</tt> object itself through a callback
460 # when you call <tt>:deliver</tt> on the Mail::Message, calling +deliver_mail+ directly
461 # and passing a Mail::Message will do nothing except tell the logger you sent the email.
462 def deliver_mail(mail) #:nodoc:
731d439 @jaggederest Change event namespace ordering to most-significant first [#4504 stat…
jaggederest authored
463 ActiveSupport::Notifications.instrument("deliver.action_mailer") do |payload|
c176397 @sachin87 some modifications in action_mailer/base.rb
sachin87 authored
464 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
465 yield # Let Mail do the delivery actions
258ca14 Delegated ActionMailer::Base.deliveries to Mail.deliveries, added cal…
José Valim and Mikel Lindsaar authored
466 end
467 end
468
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored
469 def respond_to?(method, include_private = false) #:nodoc:
99f960a Handle some TODOs and deprecations.
José Valim and Mikel Lindsaar authored
470 super || action_methods.include?(method.to_s)
471 end
472
473 protected
474
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored
475 def set_payload_for_mail(payload, mail) #:nodoc:
e8c9cac @tenderlove self is implied, so remove self
tenderlove authored
476 payload[:mailer] = name
c905fce @josevalim Add message_id to AM payload and don't send bcc and cc if they were n…
josevalim authored
477 payload[:message_id] = mail.message_id
478 payload[:subject] = mail.subject
479 payload[:to] = mail.to
480 payload[:from] = mail.from
481 payload[:bcc] = mail.bcc if mail.bcc.present?
482 payload[:cc] = mail.cc if mail.cc.present?
483 payload[:date] = mail.date
484 payload[:mail] = mail.encoded
704daad @josevalim Ensure we just send Ruby Stdlib objects in ActionMailer notifications.
josevalim authored
485 end
f30d73b Add new class delivery method API.
José Valim and Mikel Lindsaar authored
486
34b23e7 @spastorino Action Mailer async flag is true by default using a Synchronous impl
spastorino authored
487 def method_missing(method_name, *args)
488 if action_methods.include?(method_name.to_s)
489 QueuedMessage.new(queue, self, method_name, *args)
490 else
491 super
492 end
493 end
eda1719 @jamis ActionMailer::Base.deliver(email) had been accidentally removed, but …
jamis authored
494 end
495
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored
496 attr_internal :message
497
6ba9446 Make implicit and explicit templates pass through the same part creat…
José Valim and Mikel Lindsaar authored
498 # Instantiate a new mailer object. If +method_name+ is not +nil+, the mailer
499 # will be initialized according to the named method. If not, the mailer will
500 # remain uninitialized (useful when you only need to invoke the "receive"
501 # method, for instance).
502 def initialize(method_name=nil, *args)
503 super()
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored
504 @_message = Mail.new
6ba9446 Make implicit and explicit templates pass through the same part creat…
José Valim and Mikel Lindsaar authored
505 process(method_name, *args) if method_name
506 end
507
3fc609e @josevalim Fix ActionMailer test broken in 99d54599215c2a8cea7e57f609e8e578043d71b2
josevalim authored
508 def process(*args) #:nodoc:
509 lookup_context.skip_default_locale!
b786f06 @senny Do not render views when mail() isn't called. (NullMail refactoring)
senny authored
510
511 generated_mail = super
512 unless generated_mail
513 @_message = NullMail.new
514 end
515 end
516
517 class NullMail #:nodoc:
518 def body; '' end
519
520 def method_missing(*args)
521 nil
522 end
3fc609e @josevalim Fix ActionMailer test broken in 99d54599215c2a8cea7e57f609e8e578043d71b2
josevalim authored
523 end
524
972efa1 @josevalim Deprecate the old mailer API that was not deprecated yet.
josevalim authored
525 def mailer_name
526 self.class.mailer_name
527 end
528
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored
529 # Allows you to pass random and unusual headers to the new <tt>Mail::Message</tt> object
530 # which will add them to itself.
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
531 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored
532 # headers['X-Special-Domain-Specific-Header'] = "SecretValue"
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
533 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored
534 # You can also pass a hash into headers of header field names and values, which
535 # 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
536 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored
537 # headers 'X-Special-Domain-Specific-Header' => "SecretValue",
05c4ad9 Tidy up tests and docs.
José Valim and Mikel Lindsaar authored
538 # 'In-Reply-To' => incoming.message_id
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
539 #
ff44c33 @mark-rushakoff Fix it's -> its
mark-rushakoff authored
540 # 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
541 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
542 # X-Special-Domain-Specific-Header: SecretValue
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored
543 def headers(args=nil)
544 if args
9520166 @mikel Fixed up being able to pass random headers in with headers, or mail. …
mikel authored
545 @_message.headers(args)
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored
546 else
547 @_message
548 end
549 end
c34cfcc @mikel Created mail method for new API
mikel authored
550
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
551 # 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
552 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
553 # 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
554 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored
555 # If you do this, then Mail will take the file name and work out the mime type
556 # set the Content-Type, Content-Disposition, Content-Transfer-Encoding and
557 # 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
558 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored
559 # 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
560 #
96f290e @Locke23rus Update actionmailer with new hash syntax.
Locke23rus authored
561 # mail.attachments['filename.jpg'] = {mime_type: 'application/x-gzip',
562 # content: File.read('/path/to/filename.jpg')}
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
563 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored
564 # If you want to use a different encoding than Base64, you can pass an encoding in,
565 # but then it is up to you to pass in the content pre-encoded, and don't expect
566 # Mail to know how to decode this data:
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 # file_content = SpecialEncode(File.read('/path/to/filename.jpg'))
96f290e @Locke23rus Update actionmailer with new hash syntax.
Locke23rus authored
569 # mail.attachments['filename.jpg'] = {mime_type: 'application/x-gzip',
570 # encoding: 'SpecialEncoding',
571 # content: file_content }
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
572 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
573 # You can also search for specific attachments:
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
574 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
575 # # By Filename
755af49 @fxn edit pass to apply API guideline wrt the use of "# =>" in example code
fxn authored
576 # 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
577 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
578 # # or by index
755af49 @fxn edit pass to apply API guideline wrt the use of "# =>" in example code
fxn authored
579 # mail.attachments[0] # => Mail::Part (first attachment)
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored
580 #
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored
581 def attachments
582 @_message.attachments
583 end
dcb9253 Add basic template rendering to new DSL.
José Valim and Mikel Lindsaar authored
584
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored
585 # The main method that creates the message and renders the email templates. There are
586 # two ways to call this method, with a block, or without a block.
587 #
588 # Both methods accept a headers hash. This hash allows you to specify the most used headers
589 # in an email message, these are:
590 #
591 # * <tt>:subject</tt> - The subject of the message, if this is omitted, Action Mailer will
592 # ask the Rails I18n class for a translated <tt>:subject</tt> in the scope of
593 # <tt>[mailer_scope, action_name]</tt> or if this is missing, will translate the
594 # humanized version of the <tt>action_name</tt>
595 # * <tt>:to</tt> - Who the message is destined for, can be a string of addresses, or an array
596 # of addresses.
597 # * <tt>:from</tt> - Who the message is from
598 # * <tt>:cc</tt> - Who you would like to Carbon-Copy on this email, can be a string of addresses,
599 # or an array of addresses.
600 # * <tt>:bcc</tt> - Who you would like to Blind-Carbon-Copy on this email, can be a string of
601 # addresses, or an array of addresses.
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
602 # * <tt>:reply_to</tt> - Who to set the Reply-To header of the email to.
603 # * <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
604 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored
605 # You can set default values for any of the above headers (except :date) by using the <tt>default</tt>
606 # class method:
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
607 #
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored
608 # class Notifier < ActionMailer::Base
96f290e @Locke23rus Update actionmailer with new hash syntax.
Locke23rus authored
609 # self.default from: 'no-reply@test.lindsaar.net',
610 # bcc: 'email_logger@test.lindsaar.net',
611 # reply_to: 'bounces@test.lindsaar.net'
0b05acd @mikel Implementing class level :defaults hash, instead of delivers_from et al
mikel authored
612 # end
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
613 #
52c56f9 @wincent docs: note that mail() accepts arbitrary headers
wincent authored
614 # If you need other headers not listed above, you can either pass them in
615 # as part of the headers hash or use the <tt>headers['name'] = value</tt>
616 # method.
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
617 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored
618 # When a <tt>:return_path</tt> is specified as header, that value will be used as the 'envelope from'
619 # address for the Mail message. Setting this is useful when you want delivery notifications
620 # sent to a different address than the one in <tt>:from</tt>. Mail will actually use the
621 # <tt>:return_path</tt> in preference to the <tt>:sender</tt> in preference to the <tt>:from</tt>
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
622 # field for the 'envelope from' value.
623 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored
624 # If you do not pass a block to the +mail+ method, it will find all templates in the
625 # view paths using by default the mailer name and the method name that it is being
626 # called from, it will then create parts for each of these templates intelligently,
627 # making educated guesses on correct content type and sequence, and return a fully
628 # prepared Mail::Message ready to call <tt>:deliver</tt> on to send.
be35a15 @josevalim Allow to choose the template path and template name used in implicit …
josevalim authored
629 #
630 # For example:
631 #
632 # class Notifier < ActionMailer::Base
96f290e @Locke23rus Update actionmailer with new hash syntax.
Locke23rus authored
633 # default from: 'no-reply@test.lindsaar.net',
be35a15 @josevalim Allow to choose the template path and template name used in implicit …
josevalim authored
634 #
635 # def welcome
96f290e @Locke23rus Update actionmailer with new hash syntax.
Locke23rus authored
636 # mail(to: 'mikel@test.lindsaar.net')
be35a15 @josevalim Allow to choose the template path and template name used in implicit …
josevalim authored
637 # end
638 # end
639 #
45b1045 @dmathieu raise an error if no implicit mailer template could be found
dmathieu authored
640 # Will look for all templates at "app/views/notifier" with name "welcome".
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored
641 # If no welcome template exists, it will raise an ActionView::MissingTemplate error.
45b1045 @dmathieu raise an error if no implicit mailer template could be found
dmathieu authored
642 #
643 # However, those can be customized:
be35a15 @josevalim Allow to choose the template path and template name used in implicit …
josevalim authored
644 #
96f290e @Locke23rus Update actionmailer with new hash syntax.
Locke23rus authored
645 # mail(template_path: 'notifications', template_name: 'another')
be35a15 @josevalim Allow to choose the template path and template name used in implicit …
josevalim authored
646 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored
647 # 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
648 #
649 # 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
650 #
96f290e @Locke23rus Update actionmailer with new hash syntax.
Locke23rus authored
651 # mail(to: 'mikel@test.lindsaar.net') do |format|
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
652 # format.text
653 # format.html
654 # end
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
655 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
656 # 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
657 #
96f290e @Locke23rus Update actionmailer with new hash syntax.
Locke23rus authored
658 # mail(to: 'mikel@test.lindsaar.net') do |format|
659 # format.text { render text: "Hello Mikel!" }
660 # format.html { render text: "<h1>Hello Mikel!</h1>" }
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored
661 # end
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
662 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored
663 # Which will render a <tt>multipart/alternative</tt> email with <tt>text/plain</tt> and
664 # <tt>text/html</tt> parts.
6589976 Remove old files, add some information to docs and improve test suite.
José Valim and Mikel Lindsaar authored
665 #
666 # The block syntax also allows you to customize the part headers if desired:
667 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored
668 # mail(:to => 'mikel@test.lindsaar.net') do |format|
96f290e @Locke23rus Update actionmailer with new hash syntax.
Locke23rus authored
669 # format.text(content_transfer_encoding: "base64")
6589976 Remove old files, add some information to docs and improve test suite.
José Valim and Mikel Lindsaar authored
670 # format.html
671 # end
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored
672 #
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored
673 def mail(headers={}, &block)
674 m = @_message
258ca14 Delegated ActionMailer::Base.deliveries to Mail.deliveries, added cal…
José Valim and Mikel Lindsaar authored
675
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored
676 # At the beginning, do not consider class default for parts order neither content_type
677 content_type = headers[:content_type]
678 parts_order = headers[:parts_order]
1cd5592 First work on implicit multipart.
José Valim and Mikel Lindsaar authored
679
08b07b6 @mikel Adding ability to pass proc's to the ActionMailer class default method
mikel authored
680 # Call all the procs (if any)
c176397 @sachin87 some modifications in action_mailer/base.rb
sachin87 authored
681 class_default = self.class.default
682 default_values = class_default.merge(class_default) do |k,v|
3fbc042 @lest Use instance_eval instead of Proc#bind
lest authored
683 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
684 end
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored
685
b5f9a9f @josevalim Move set_fields! to the old API module.
josevalim authored
686 # Handle defaults
08b07b6 @mikel Adding ability to pass proc's to the ActionMailer class default method
mikel authored
687 headers = headers.reverse_merge(default_values)
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored
688 headers[:subject] ||= default_i18n_subject
b5f9a9f @josevalim Move set_fields! to the old API module.
josevalim authored
689
690 # Apply charset at the beginning so all fields are properly quoted
691 m.charset = charset = headers[:charset]
692
693 # Set configure delivery behavior
8fc8763 @asanghi Allow delivery method options to be set per mail instance
asanghi authored
694 wrap_delivery_behavior!(headers.delete(:delivery_method),headers.delete(:delivery_method_options))
b5f9a9f @josevalim Move set_fields! to the old API module.
josevalim authored
695
696 # 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
697 assignable = headers.except(:parts_order, :content_type, :body, :template_name, :template_path)
b5f9a9f @josevalim Move set_fields! to the old API module.
josevalim authored
698 assignable.each { |k, v| m[k] = v }
951397b Get implicit multipart and attachments working together.
José Valim and Mikel Lindsaar authored
699
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored
700 # Render the templates and blocks
39a1b06 Deprecate old defaults API.
José Valim and Mikel Lindsaar authored
701 responses, explicit_order = collect_responses_and_parts_order(headers, &block)
b5f9a9f @josevalim Move set_fields! to the old API module.
josevalim authored
702 create_parts_from_responses(m, responses)
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored
703
b5f9a9f @josevalim Move set_fields! to the old API module.
josevalim authored
704 # Setup content type, reapply charset and handle parts order
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored
705 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
706 m.charset = charset
707
e7e4ed4 Set sort order for explicit parts from the collector's template sequence
José Valim and Mikel Lindsaar authored
708 if m.multipart?
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored
709 parts_order ||= explicit_order || headers[:parts_order]
710 m.body.set_sort_order(parts_order)
951397b Get implicit multipart and attachments working together.
José Valim and Mikel Lindsaar authored
711 m.body.sort_parts!
712 end
bb9d71f Move class methods to deprecated stuff.
José Valim and Mikel Lindsaar authored
713
c34cfcc @mikel Created mail method for new API
mikel authored
714 m
715 end
716
6ba9446 Make implicit and explicit templates pass through the same part creat…
José Valim and Mikel Lindsaar authored
717 protected
718
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored
719 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
720 params = m.content_type_parameters || {}
721 case
722 when user_content_type.present?
723 user_content_type
724 when m.has_attachments?
311d99e @mikel Adding inline attachment support to ActionMailer
mikel authored
725 if m.attachments.detect { |a| a.inline? }
726 ["multipart", "related", params]
727 else
728 ["multipart", "mixed", params]
729 end
74a5889 Refactor content type setting, added tests to ensure boundary exists …
José Valim and Mikel Lindsaar authored
730 when m.multipart?
731 ["multipart", "alternative", params]
732 else
b6b3db6 @mikel Fixed bug on HTML only emails getting set to text/plain
mikel authored
733 m.content_type || class_default
74a5889 Refactor content type setting, added tests to ensure boundary exists …
José Valim and Mikel Lindsaar authored
734 end
735 end
736
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored
737 # Translates the +subject+ using Rails I18n class under <tt>[mailer_scope, action_name]</tt> scope.
738 # If it does not find a translation for the +subject+ under the specified scope it will default to a
739 # humanized version of the <tt>action_name</tt>.
740 def default_i18n_subject #:nodoc:
2d8396f @jurriaan Updated/changed useless tr/gsubs
jurriaan authored
741 mailer_scope = self.class.mailer_name.tr('/', '.')
96f290e @Locke23rus Update actionmailer with new hash syntax.
Locke23rus authored
742 I18n.t(:subject, scope: [mailer_scope, action_name], default: action_name.humanize)
5c3ef8c Refactor subject with i18n.
José Valim and Mikel Lindsaar authored
743 end
744
39a1b06 Deprecate old defaults API.
José Valim and Mikel Lindsaar authored
745 def collect_responses_and_parts_order(headers) #:nodoc:
746 responses, parts_order = [], nil
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored
747
748 if block_given?
a09e992 @josevalim Ensure details are frozen after @details_keys lookup. The implementat…
josevalim authored
749 collector = ActionMailer::Collector.new(lookup_context) { render(action_name) }
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored
750 yield(collector)
39a1b06 Deprecate old defaults API.
José Valim and Mikel Lindsaar authored
751 parts_order = collector.responses.map { |r| r[:content_type] }
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored
752 responses = collector.responses
753 elsif headers[:body]
754 responses << {
96f290e @Locke23rus Update actionmailer with new hash syntax.
Locke23rus authored
755 body: headers.delete(:body),
756 content_type: self.class.default[:content_type] || "text/plain"
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored
757 }
758 else
be35a15 @josevalim Allow to choose the template path and template name used in implicit …
josevalim authored
759 templates_path = headers.delete(:template_path) || self.class.mailer_name
760 templates_name = headers.delete(:template_name) || action_name
761
762 each_template(templates_path, templates_name) do |template|
f28d856 @josevalim Improve performance of the rendering stack by freezing formats as a s…
josevalim authored
763 self.formats = template.formats
764
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored
765 responses << {
96f290e @Locke23rus Update actionmailer with new hash syntax.
Locke23rus authored
766 body: render(template: template),
767 content_type: template.type.to_s
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored
768 }
769 end
770 end
771
39a1b06 Deprecate old defaults API.
José Valim and Mikel Lindsaar authored
772 [responses, parts_order]
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored
773 end
774
be35a15 @josevalim Allow to choose the template path and template name used in implicit …
josevalim authored
775 def each_template(paths, name, &block) #:nodoc:
3438f6c @rafaelfranca Array.wrap is no longer needed here
rafaelfranca authored
776 templates = lookup_context.find_all(name, Array(paths))
45b1045 @dmathieu raise an error if no implicit mailer template could be found
dmathieu authored
777 if templates.empty?
778 raise ActionView::MissingTemplate.new([paths], name, [paths], false, 'mailer')
779 else
780 templates.uniq { |t| t.formats }.each(&block)
781 end
99f960a Handle some TODOs and deprecations.
José Valim and Mikel Lindsaar authored
782 end
783
b5f9a9f @josevalim Move set_fields! to the old API module.
josevalim authored
784 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
785 if responses.size == 1 && !m.has_attachments?
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored
786 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
787 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
788 container = Mail::Part.new
74a5889 Refactor content type setting, added tests to ensure boundary exists …
José Valim and Mikel Lindsaar authored
789 container.content_type = "multipart/alternative"
b5f9a9f @josevalim Move set_fields! to the old API module.
josevalim authored
790 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
791 m.add_part(container)
792 else
b5f9a9f @josevalim Move set_fields! to the old API module.
josevalim authored
793 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
794 end
359caef @jamis A very thorough refactoring, resulting in new mail property setters a…
jamis authored
795 end
796
6ba9446 Make implicit and explicit templates pass through the same part creat…
José Valim and Mikel Lindsaar authored
797 def insert_part(container, response, charset) #:nodoc:
798 response[:charset] ||= charset
799 part = Mail::Part.new(response)
800 container.add_part(part)
359caef @jamis A very thorough refactoring, resulting in new mail property setters a…
jamis authored
801 end
3fad0cd @dhh Added support for charsets for both subject and body. The default cha…
dhh authored
802
ef5dada @nex3 Only run load hooks once a file has been fully loaded.
nex3 authored
803 ActiveSupport.run_load_hooks(:action_mailer, self)
db045db @dhh Initial
dhh authored
804 end
edaa2c4 @paneq Introduce config.action_mailer.default_from=
paneq authored
805 end
Something went wrong with that request. Please try again.