Skip to content
Newer
Older
100644 795 lines (744 sloc) 33 KB
616ebb8 @josevalim Remove unused code paths and require mail only when it's needed.
josevalim authored Dec 28, 2009
1 require 'mail'
c985a0e Add some tests to collector with templates and any.
José Valim and Mikel Lindsaar authored Jan 23, 2010
2 require 'action_mailer/collector'
284ca81 @joshk remove AM delegating register_observer and register_interceptor to Ma…
joshk authored Apr 2, 2011
3 require 'active_support/core_ext/string/inflections'
0f8a6eb @sikachu Fix missing requires in Action Mailer
sikachu authored Apr 14, 2011
4 require 'active_support/core_ext/hash/except'
c17d200 @lest mailer can be anonymous
lest authored May 13, 2012
5 require 'active_support/core_ext/module/anonymous'
6788db8 @josevalim Move Rails::LogSubscriber to ActiveSupport::LogSubscriber, allowing f…
josevalim authored Jun 24, 2010
6 require 'action_mailer/log_subscriber'
a63caa4 Get tests to run (with failures) without old base around
Yehuda Katz + Carl Lerche authored Jun 15, 2009
7
7c0e3b8 @vijaydev remove nodoc [ci skip]
vijaydev authored Sep 21, 2012
8 module ActionMailer
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
9 # Action Mailer allows you to send email from your application using a mailer model and views.
db045db @dhh Initial
dhh authored Nov 24, 2004
10 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
11 # = Mailer Models
20bd4bd @dhh Updated docs and otherwise
dhh authored Sep 2, 2006
12 #
98dc582 @lifo Merge docrails.
lifo authored May 25, 2008
13 # 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 May 14, 2008
14 #
f44a0b1 @romdi fix usage examples and more to use new invocations
romdi authored Feb 6, 2010
15 # $ rails generate mailer Notifier
0a407bc ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, …
Marcel Molina authored May 10, 2006
16 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
17 # The generated model inherits from <tt>ActionMailer::Base</tt>. A mailer model defines methods
18 # used to generate an email message. In these methods, you can setup variables to be used in
19 # 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 May 10, 2006
20 #
0f0213f @siong1987 minor spacing fix in code example in ActionMailer::Base.
siong1987 authored May 28, 2011
21 # class Notifier < ActionMailer::Base
96f290e @Locke23rus Update actionmailer with new hash syntax.
Locke23rus authored Oct 7, 2012
22 # default from: 'no-reply@example.com',
23 # return_path: 'system@example.com'
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
24 #
0f0213f @siong1987 minor spacing fix in code example in ActionMailer::Base.
siong1987 authored May 28, 2011
25 # def welcome(recipient)
26 # @account = recipient
96f290e @Locke23rus Update actionmailer with new hash syntax.
Locke23rus authored Oct 7, 2012
27 # mail(to: recipient.email_address_with_name,
28 # bcc: ["bcc@example.com", "Order Watcher <watcher@example.com>"])
0f0213f @siong1987 minor spacing fix in code example in ActionMailer::Base.
siong1987 authored May 28, 2011
29 # end
30 # end
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
31 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
32 # 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 May 15, 2010
33 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
34 # * <tt>attachments[]=</tt> - Allows you to add attachments to your email in an intuitive
35 # 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 Jan 26, 2010
36 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
37 # * <tt>attachments.inline[]=</tt> - Allows you to add an inline attachment to your email
38 # in the same manner as <tt>attachments[]=</tt>
3762362 @mikel Updating readme for ActionMailer::Base
mikel authored Jun 7, 2010
39 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
40 # * <tt>headers[]=</tt> - Allows you to specify any header field in your email such
41 # as <tt>headers['X-No-Spam'] = 'True'</tt>. Note, while most fields like <tt>To:</tt>
42 # <tt>From:</tt> can only appear once in an email header, other fields like <tt>X-Anything</tt>
43 # can appear multiple times. If you want to change a field that can appear multiple times,
44 # you need to set it to nil first so that Mail knows you are replacing it and not adding
daad445 itsy bitsy changes to ActionMailer documentation
Neeraj Singh authored Jul 28, 2010
45 # 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 Jan 26, 2010
46 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
47 # * <tt>headers(hash)</tt> - Allows you to specify multiple headers in your email such
48 # 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 Jan 27, 2010
49 #
daad445 itsy bitsy changes to ActionMailer documentation
Neeraj Singh authored Jul 29, 2010
50 # * <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 May 15, 2010
51 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
52 # The hash passed to the mail method allows you to specify any header that a Mail::Message
53 # will accept (any valid Email header including optional fields).
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
54 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
55 # The mail method, if not passed a block, will inspect your views and send all the views with
56 # the same name as the method, so the above action would send the +welcome.text.erb+ view
57 # 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 May 15, 2010
58 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
59 # 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 May 15, 2010
60 #
96f290e @Locke23rus Update actionmailer with new hash syntax.
Locke23rus authored Oct 7, 2012
61 # mail(to: user.email) do |format|
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
62 # format.text
63 # format.html
64 # end
20bd4bd @dhh Updated docs and otherwise
dhh authored Sep 2, 2006
65 #
daad445 itsy bitsy changes to ActionMailer documentation
Neeraj Singh authored Jul 29, 2010
66 # 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 Jan 26, 2010
67 #
96f290e @Locke23rus Update actionmailer with new hash syntax.
Locke23rus authored Oct 7, 2012
68 # mail(to: user.email) do |format|
8659212 @AvnerCohen Actionmailer to 1.9 hash syntax
AvnerCohen authored Nov 8, 2012
69 # 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 Jan 26, 2010
70 # format.html
71 # end
72 #
bb2c7b4 @mikel Updating Action Mailer documentation
mikel authored Jan 29, 2010
73 # 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 Jan 26, 2010
74 #
96f290e @Locke23rus Update actionmailer with new hash syntax.
Locke23rus authored Oct 7, 2012
75 # 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 Jan 26, 2010
76 # format.text
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
77 # 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 Jan 26, 2010
78 # end
79 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
80 # = Mailer views
20bd4bd @dhh Updated docs and otherwise
dhh authored Sep 2, 2006
81 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
82 # Like Action Controller, each mailer class has a corresponding view directory in which each
83 # 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 May 15, 2010
84 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
85 # To define a template to be used with a mailing, create an <tt>.erb</tt> file with the same
86 # name as the method in your mailer model. For example, in the mailer defined above, the template at
87 # <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 May 10, 2006
88 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
89 # 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 May 10, 2006
90 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
91 # 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 May 10, 2006
92 #
93 # Hi <%= @account.name %>,
94 # Thanks for joining our service! Please check back often.
95 #
20bd4bd @dhh Updated docs and otherwise
dhh authored Sep 2, 2006
96 # You can even use Action Pack helpers in these views. For example:
97 #
98 # You got a new note!
96f290e @Locke23rus Update actionmailer with new hash syntax.
Locke23rus authored Oct 7, 2012
99 # <%= truncate(@note.body, length: 25) %>
ee70d1b @josevalim adv_attr_accessors in ActionMailer are not sent to the views, use the…
josevalim authored Dec 25, 2009
100 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
101 # 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 Dec 25, 2009
102 #
6589976 Remove old files, add some information to docs and improve test suite.
José Valim and Mikel Lindsaar authored Jan 26, 2010
103 # You got a new note from <%= message.from %>!
96f290e @Locke23rus Update actionmailer with new hash syntax.
Locke23rus authored Oct 7, 2012
104 # <%= truncate(@note.body, length: 25) %>
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Infl…
josh authored May 14, 2008
105 #
20bd4bd @dhh Updated docs and otherwise
dhh authored Sep 2, 2006
106 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
107 # = Generating URLs
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Infl…
josh authored May 14, 2008
108 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
109 # URLs can be generated in mailer views using <tt>url_for</tt> or named routes. Unlike controllers from
110 # Action Pack, the mailer instance doesn't have any context about the incoming request, so you'll need
111 # to provide all of the details needed to generate a URL.
20bd4bd @dhh Updated docs and otherwise
dhh authored Sep 2, 2006
112 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
113 # 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 May 14, 2008
114 #
96f290e @Locke23rus Update actionmailer with new hash syntax.
Locke23rus authored Oct 7, 2012
115 # <%= url_for(host: "example.com", controller: "welcome", action: "greeting") %>
20bd4bd @dhh Updated docs and otherwise
dhh authored Sep 2, 2006
116 #
4809dcc * Remove default_url_options from mailer generator
Cody Fauser authored Apr 21, 2008
117 # 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 May 14, 2008
118 #
96f290e @Locke23rus Update actionmailer with new hash syntax.
Locke23rus authored Oct 7, 2012
119 # <%= users_url(host: "example.com") %>
4809dcc * Remove default_url_options from mailer generator
Cody Fauser authored Apr 21, 2008
120 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
121 # You should use the <tt>named_route_url</tt> style (which generates absolute URLs) and avoid using the
122 # <tt>named_route_path</tt> style (which generates relative URLs), since clients reading the mail will
123 # 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 Apr 21, 2008
124 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
125 # It is also possible to set a default host that will be used in all mailers by setting the <tt>:host</tt>
126 # option as a configuration option in <tt>config/application.rb</tt>:
4809dcc * Remove default_url_options from mailer generator
Cody Fauser authored Apr 21, 2008
127 #
8659212 @AvnerCohen Actionmailer to 1.9 hash syntax
AvnerCohen authored Nov 8, 2012
128 # config.action_mailer.default_url_options = { host: "example.com" }
20bd4bd @dhh Updated docs and otherwise
dhh authored Sep 2, 2006
129 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
130 # When you decide to set a default <tt>:host</tt> for your mailers, then you need to make sure to use the
8659212 @AvnerCohen Actionmailer to 1.9 hash syntax
AvnerCohen authored Nov 8, 2012
131 # <tt>only_path: false</tt> option when using <tt>url_for</tt>. Since the <tt>url_for</tt> view helper
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
132 # will generate relative URLs by default when a <tt>:host</tt> option isn't explicitly provided, passing
8659212 @AvnerCohen Actionmailer to 1.9 hash syntax
AvnerCohen authored Nov 8, 2012
133 # <tt>only_path: false</tt> will ensure that absolute URLs are generated.
20bd4bd @dhh Updated docs and otherwise
dhh authored Sep 2, 2006
134 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
135 # = Sending mail
20bd4bd @dhh Updated docs and otherwise
dhh authored Sep 2, 2006
136 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
137 # Once a mailer action and template are defined, you can deliver your message or create it and save it
138 # for delivery later:
0a407bc ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, …
Marcel Molina authored May 10, 2006
139 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
140 # Notifier.welcome(david).deliver # sends the email
141 # mail = Notifier.welcome(david) # => a Mail::Message object
142 # mail.deliver # sends the email
0a407bc ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, …
Marcel Molina authored May 10, 2006
143 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
144 # 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 Sep 2, 2006
145 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
146 # = Multipart Emails
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Infl…
josh authored May 14, 2008
147 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
148 # Multipart messages can also be used implicitly because Action Mailer will automatically detect and use
149 # multipart templates, where each template is named after the name of the action, followed by the content
150 # 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 May 14, 2008
151 #
daad445 itsy bitsy changes to ActionMailer documentation
Neeraj Singh authored Jul 29, 2010
152 # 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 Jun 15, 2011
153 # * signup_notification.text.erb
21187c0 @dhh Apply the rest of Chads patch
dhh authored Feb 21, 2007
154 # * signup_notification.text.html.erb
155 # * signup_notification.text.xml.builder
6589976 Remove old files, add some information to docs and improve test suite.
José Valim and Mikel Lindsaar authored Jan 26, 2010
156 # * signup_notification.text.yaml.erb
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Infl…
josh authored May 14, 2008
157 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
158 # Each would be rendered and added as a separate part to the message, with the corresponding content
159 # type. The content type for the entire message is automatically set to <tt>multipart/alternative</tt>,
160 # which indicates that the email contains multiple different representations of the same email
161 # 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 May 29, 2005
162 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
163 # Implicit template rendering is not performed if any attachments or parts have been added to the email.
164 # This means that you'll have to manually add each part to the email and set the content type of the email
165 # to <tt>multipart/alternative</tt>.
20bd4bd @dhh Updated docs and otherwise
dhh authored Sep 2, 2006
166 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
167 # = Attachments
20bd4bd @dhh Updated docs and otherwise
dhh authored Sep 2, 2006
168 #
daad445 itsy bitsy changes to ActionMailer documentation
Neeraj Singh authored Jul 29, 2010
169 # Sending attachment in emails is easy:
0a407bc ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, …
Marcel Molina authored May 10, 2006
170 #
171 # class ApplicationMailer < ActionMailer::Base
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
172 # def welcome(recipient)
3762362 @mikel Updating readme for ActionMailer::Base
mikel authored Jun 8, 2010
173 # attachments['free_book.pdf'] = File.read('path/to/file.pdf')
96f290e @Locke23rus Update actionmailer with new hash syntax.
Locke23rus authored Oct 7, 2012
174 # mail(to: recipient, subject: "New account information")
db045db @dhh Initial
dhh authored Nov 24, 2004
175 # end
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Infl…
josh authored May 14, 2008
176 # end
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
177 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
178 # Which will (if it had both a <tt>welcome.text.erb</tt> and <tt>welcome.text.html.erb</tt>
179 # template in the view directory), send a complete <tt>multipart/mixed</tt> email with two parts,
180 # the first part being a <tt>multipart/alternative</tt> with the text and HTML email parts inside,
181 # and the second being a <tt>application/pdf</tt> with a Base64 encoded copy of the file.pdf book
182 # with the filename +free_book.pdf+.
c927aa0 @dhh Updated documentation
dhh authored Dec 16, 2004
183 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
184 # If you need to send attachments with no content, you need to create an empty view for it,
185 # or add an empty body parameter like this:
45b1045 @dmathieu raise an error if no implicit mailer template could be found
dmathieu authored Jun 20, 2012
186 #
187 # class ApplicationMailer < ActionMailer::Base
188 # def welcome(recipient)
189 # attachments['free_book.pdf'] = File.read('path/to/file.pdf')
96f290e @Locke23rus Update actionmailer with new hash syntax.
Locke23rus authored Oct 7, 2012
190 # mail(to: recipient, subject: "New account information", body: "")
45b1045 @dmathieu raise an error if no implicit mailer template could be found
dmathieu authored Jun 20, 2012
191 # end
192 # end
193 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
194 # = Inline Attachments
b451de0 @spastorino Deletes trailing whitespaces (over text files only find * -type f -ex…
spastorino authored Aug 14, 2010
195 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
196 # You can also specify that a file should be displayed inline with other HTML. This is useful
197 # 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 Aug 14, 2010
198 #
3762362 @mikel Updating readme for ActionMailer::Base
mikel authored Jun 8, 2010
199 # class ApplicationMailer < ActionMailer::Base
200 # def welcome(recipient)
201 # attachments.inline['photo.png'] = File.read('path/to/photo.png')
96f290e @Locke23rus Update actionmailer with new hash syntax.
Locke23rus authored Oct 7, 2012
202 # mail(to: recipient, subject: "Here is what we look like")
3762362 @mikel Updating readme for ActionMailer::Base
mikel authored Jun 8, 2010
203 # end
204 # end
b451de0 @spastorino Deletes trailing whitespaces (over text files only find * -type f -ex…
spastorino authored Aug 14, 2010
205 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
206 # And then to reference the image in the view, you create a <tt>welcome.html.erb</tt> file and
207 # make a call to +image_tag+ passing in the attachment you want to display and then call
208 # +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 Aug 14, 2010
209 #
3762362 @mikel Updating readme for ActionMailer::Base
mikel authored Jun 8, 2010
210 # <h1>Please Don't Cringe</h1>
b451de0 @spastorino Deletes trailing whitespaces (over text files only find * -type f -ex…
spastorino authored Aug 14, 2010
211 #
3762362 @mikel Updating readme for ActionMailer::Base
mikel authored Jun 8, 2010
212 # <%= image_tag attachments['photo.png'].url -%>
b451de0 @spastorino Deletes trailing whitespaces (over text files only find * -type f -ex…
spastorino authored Aug 14, 2010
213 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
214 # 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 Aug 14, 2010
215 #
3762362 @mikel Updating readme for ActionMailer::Base
mikel authored Jun 8, 2010
216 # <h1>Please Don't Cringe</h1>
b451de0 @spastorino Deletes trailing whitespaces (over text files only find * -type f -ex…
spastorino authored Aug 14, 2010
217 #
96f290e @Locke23rus Update actionmailer with new hash syntax.
Locke23rus authored Oct 7, 2012
218 # <%= 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 Aug 14, 2010
219 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
220 # = Observing and Intercepting Mails
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
221 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
222 # Action Mailer provides hooks into the Mail observer and interceptor methods. These allow you to
223 # 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 May 15, 2010
224 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
225 # An observer class must implement the <tt>:delivered_email(message)</tt> method which will be
226 # 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 May 15, 2010
227 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
228 # An interceptor class must implement the <tt>:delivering_email(message)</tt> method which will be
229 # called before the email is sent, allowing you to make modifications to the email before it hits
230 # the delivery agents. Your class should make any needed modifications directly to the passed
231 # in Mail::Message instance.
20bd4bd @dhh Updated docs and otherwise
dhh authored Sep 2, 2006
232 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
233 # = Default Hash
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
234 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
235 # Action Mailer provides some intelligent defaults for your emails, these are usually specified in a
236 # default method inside the class definition:
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
237 #
fb30feb @mikel Adding more docs to ActionMailer
mikel authored May 2, 2010
238 # class Notifier < ActionMailer::Base
96f290e @Locke23rus Update actionmailer with new hash syntax.
Locke23rus authored Oct 7, 2012
239 # default sender: 'system@example.com'
fb30feb @mikel Adding more docs to ActionMailer
mikel authored May 2, 2010
240 # end
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
241 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
242 # You can pass in any header value that a <tt>Mail::Message</tt> accepts. Out of the box,
243 # <tt>ActionMailer::Base</tt> sets the following:
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
244 #
8659212 @AvnerCohen Actionmailer to 1.9 hash syntax
AvnerCohen authored Nov 8, 2012
245 # * <tt>mime_version: "1.0"</tt>
246 # * <tt>charset: "UTF-8",</tt>
247 # * <tt>content_type: "text/plain",</tt>
248 # * <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 May 15, 2010
249 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
250 # <tt>parts_order</tt> and <tt>charset</tt> are not actually valid <tt>Mail::Message</tt> header fields,
251 # 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 May 15, 2010
252 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
253 # As you can pass in any header, you need to either quote the header as a string, or pass it in as
254 # an underscored symbol, so the following will work:
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
255 #
fb30feb @mikel Adding more docs to ActionMailer
mikel authored May 2, 2010
256 # class Notifier < ActionMailer::Base
257 # default 'Content-Transfer-Encoding' => '7bit',
96f290e @Locke23rus Update actionmailer with new hash syntax.
Locke23rus authored Oct 7, 2012
258 # content_description: 'This is a description'
fb30feb @mikel Adding more docs to ActionMailer
mikel authored May 2, 2010
259 # end
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
260 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
261 # Finally, Action Mailer also supports passing <tt>Proc</tt> objects into the default hash, so you
262 # 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 May 15, 2010
263 #
fb30feb @mikel Adding more docs to ActionMailer
mikel authored May 2, 2010
264 # class Notifier < ActionMailer::Base
265 # default 'X-Special-Header' => Proc.new { my_method }
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
266 #
fb30feb @mikel Adding more docs to ActionMailer
mikel authored May 2, 2010
267 # private
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
268 #
fb30feb @mikel Adding more docs to ActionMailer
mikel authored May 2, 2010
269 # def my_method
270 # 'some complex call'
271 # end
272 # end
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
273 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
274 # Note that the proc is evaluated right at the start of the mail message generation, so if you
275 # set something in the defaults using a proc, and then set the same thing inside of your
276 # 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 May 15, 2010
277 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
278 # It is also possible to set these default options that will be used in all mailers through
279 # 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 Jul 6, 2012
280 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
281 # 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 Jul 7, 2012
282 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
283 # = Callbacks
4f28c4f @jsl Add ability to define callbacks in ActionMailer using AbstractControl…
jsl authored Mar 10, 2012
284 #
4ec7493 use _action callbacks in actionmailer
Francesco Rodriguez authored Dec 8, 2012
285 # You can specify callbacks using before_action and after_action for configuring your messages.
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
286 # This may be useful, for example, when you want to add default inline attachments for all
287 # messages sent out by a certain mailer class:
4f28c4f @jsl Add ability to define callbacks in ActionMailer using AbstractControl…
jsl authored Mar 10, 2012
288 #
289 # class Notifier < ActionMailer::Base
4ec7493 use _action callbacks in actionmailer
Francesco Rodriguez authored Dec 8, 2012
290 # before_action :add_inline_attachment!
4f28c4f @jsl Add ability to define callbacks in ActionMailer using AbstractControl…
jsl authored Mar 10, 2012
291 #
292 # def welcome
293 # mail
294 # end
295 #
296 # private
297 #
298 # def add_inline_attachment!
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
299 # attachments.inline["footer.jpg"] = File.read('/path/to/filename.jpg')
4f28c4f @jsl Add ability to define callbacks in ActionMailer using AbstractControl…
jsl authored Mar 10, 2012
300 # end
301 # end
302 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
303 # Callbacks in ActionMailer are implemented using AbstractController::Callbacks, so you
304 # can define and configure callbacks in the same manner that you would use callbacks in
305 # classes that inherit from ActionController::Base.
4f28c4f @jsl Add ability to define callbacks in ActionMailer using AbstractControl…
jsl authored Mar 10, 2012
306 #
4ec7493 use _action callbacks in actionmailer
Francesco Rodriguez authored Dec 8, 2012
307 # Note that unless you have a specific reason to do so, you should prefer using before_action
308 # rather than after_action in your ActionMailer classes so that headers are parsed properly.
4f28c4f @jsl Add ability to define callbacks in ActionMailer using AbstractControl…
jsl authored Mar 10, 2012
309 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
310 # = Configuration options
c927aa0 @dhh Updated documentation
dhh authored Dec 16, 2004
311 #
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
312 # These options are specified on the class level, like
e968acc @radar Update ActionMailer documentation to not use deprecated template_root…
radar authored Nov 26, 2010
313 # <tt>ActionMailer::Base.raise_delivery_errors = true</tt>
c927aa0 @dhh Updated documentation
dhh authored Dec 16, 2004
314 #
4d6a314 use default_options= instead of default to avoid confusion
Francesco Rodriguez authored Dec 9, 2012
315 # * <tt>default_options</tt> - You can pass this in at a class level as well as within the class itself as
fb30feb @mikel Adding more docs to ActionMailer
mikel authored May 2, 2010
316 # per the above section.
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
317 #
c927aa0 @dhh Updated documentation
dhh authored Dec 16, 2004
318 # * <tt>logger</tt> - the logger is used for generating information on the mailing run if available.
319 # Can be set to nil for no logging. Compatible with both Ruby's own Logger and Log4r loggers.
320 #
64092de @fxn Improve documentation coverage and markup
fxn authored May 2, 2008
321 # * <tt>smtp_settings</tt> - Allows detailed configuration for <tt>:smtp</tt> delivery method:
bb2c7b4 @mikel Updating Action Mailer documentation
mikel authored Jan 29, 2010
322 # * <tt>:address</tt> - Allows you to use a remote mail server. Just change it from its default
323 # "localhost" setting.
dc4eec1 @lifo Merge docrails:
lifo authored May 9, 2008
324 # * <tt>:port</tt> - On the off chance that your mail server doesn't run on port 25, you can change it.
325 # * <tt>:domain</tt> - If you need to specify a HELO domain, you can do it here.
326 # * <tt>:user_name</tt> - If your mail server requires authentication, set the username in this setting.
327 # * <tt>:password</tt> - If your mail server requires authentication, set the password in this setting.
bb2c7b4 @mikel Updating Action Mailer documentation
mikel authored Jan 29, 2010
328 # * <tt>:authentication</tt> - If your mail server requires authentication, you need to specify the
329 # authentication type here.
5a898e1 Explain actionamailer authentication types
Peter Baker authored Oct 14, 2010
330 # 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 Mar 3, 2011
331 # send password Base64 encoded) or <tt>:cram_md5</tt> (combines a Challenge/Response mechanism to exchange
5a898e1 Explain actionamailer authentication types
Peter Baker authored Oct 14, 2010
332 # information and a cryptographic Message Digest 5 algorithm to hash important information)
bb2c7b4 @mikel Updating Action Mailer documentation
mikel authored Jan 29, 2010
333 # * <tt>:enable_starttls_auto</tt> - When set to true, detects if STARTTLS is enabled in your SMTP server
334 # and starts to use it.
d500ad3 @joshk Removed deprecated ActionMailer API and related tests
joshk authored May 24, 2011
335 # * <tt>:openssl_verify_mode</tt> - When using TLS, you can set how OpenSSL checks the certificate. This is
336 # really useful if you need to validate a self-signed and/or a wildcard certificate. You can use the name
a145c1b @avakhov Cosmetic fixes in AM::Base docs. Missed spaces in OpenSSL constants e…
avakhov authored Apr 23, 2013
337 # of an OpenSSL verify constant ('none', 'peer', 'client_once', 'fail_if_no_peer_cert') or directly the
338 # constant (OpenSSL::SSL::VERIFY_NONE, OpenSSL::SSL::VERIFY_PEER, ...).
c927aa0 @dhh Updated documentation
dhh authored Dec 16, 2004
339 #
46f30f9 @lifo Merge documentation changes from docrails.
lifo authored May 16, 2008
340 # * <tt>sendmail_settings</tt> - Allows you to override options for the <tt>:sendmail</tt> delivery method.
341 # * <tt>:location</tt> - The location of the sendmail executable. Defaults to <tt>/usr/sbin/sendmail</tt>.
b72cd29 @mikel Fixing spelling
mikel authored Jan 18, 2011
342 # * <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 Jan 29, 2010
343 # added automatically before the message is sent.
dc4eec1 @lifo Merge docrails:
lifo authored May 9, 2008
344 #
fbe6c3c @edavis10 Adds a :file delivery_method to save email to a file on disk
edavis10 authored Aug 7, 2009
345 # * <tt>file_settings</tt> - Allows you to override options for the <tt>:file</tt> delivery method.
bb2c7b4 @mikel Updating Action Mailer documentation
mikel authored Jan 29, 2010
346 # * <tt>:location</tt> - The directory into which emails will be written. Defaults to the application
347 # <tt>tmp/mails</tt>.
fbe6c3c @edavis10 Adds a :file delivery_method to save email to a file on disk
edavis10 authored Aug 8, 2009
348 #
dc4eec1 @lifo Merge docrails:
lifo authored May 9, 2008
349 # * <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 Dec 16, 2004
350 #
bb2c7b4 @mikel Updating Action Mailer documentation
mikel authored Jan 29, 2010
351 # * <tt>delivery_method</tt> - Defines a delivery method. Possible values are <tt>:smtp</tt> (default),
352 # <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 Jun 20, 2012
353 # object e.g. MyOwnDeliveryMethodClass. See the Mail gem documentation on the interface you need to
bb2c7b4 @mikel Updating Action Mailer documentation
mikel authored Jan 29, 2010
354 # implement for a custom delivery agent.
c927aa0 @dhh Updated documentation
dhh authored Dec 16, 2004
355 #
bb2c7b4 @mikel Updating Action Mailer documentation
mikel authored Jan 29, 2010
356 # * <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 May 23, 2011
357 # 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 Jan 29, 2010
358 # be turned off to aid in functional testing.
c927aa0 @dhh Updated documentation
dhh authored Dec 16, 2004
359 #
bb2c7b4 @mikel Updating Action Mailer documentation
mikel authored Jan 29, 2010
360 # * <tt>deliveries</tt> - Keeps an array of all the emails sent out through the Action Mailer with
361 # <tt>delivery_method :test</tt>. Most useful for unit and functional testing.
4964d3b @josevalim Make ActionMailer::Base inherit from AbstractController::Base
josevalim authored Dec 22, 2009
362 class Base < AbstractController::Base
dbcf01e @mikel Removing quoting.rb, upgrade to 2.1.3.6, changing all utf-8 reference…
mikel authored Apr 8, 2010
363 include DeliveryMethods
f30d73b Add new class delivery method API.
José Valim and Mikel Lindsaar authored Jan 24, 2010
364 abstract!
365
c03c40b @josevalim Expose a _render_partial hook as thhe _render_template one and make u…
josevalim authored Dec 31, 2009
366 include AbstractController::Logger
83f4d86 @dhh Rename the RenderingController module to just plain Rendering
dhh authored Dec 20, 2009
367 include AbstractController::Rendering
a9751a7 @josevalim Refactor ActionMailer layout and remove legacy one.
josevalim authored Oct 17, 2009
368 include AbstractController::Layouts
684c2dc @josevalim Remove ActionMailer helpers and rely on AbstractController one.
josevalim authored Oct 18, 2009
369 include AbstractController::Helpers
48a3985 @josevalim Also include translation in ActionMailer.
josevalim authored Jan 26, 2010
370 include AbstractController::Translation
08baa34 @dhh Extract assets paths and make them available to Action Mailer as well
dhh authored Jun 2, 2010
371 include AbstractController::AssetPaths
4f28c4f @jsl Add ability to define callbacks in ActionMailer using AbstractControl…
jsl authored Mar 10, 2012
372 include AbstractController::Callbacks
359caef @jamis A very thorough refactoring, resulting in new mail property setters a…
jamis authored May 29, 2005
373
7d86235 @lest get rid of using instance_variable_names method from AS
lest authored Jan 7, 2012
374 self.protected_instance_variables = [:@_action_has_layout]
d42bb68 @josevalim More updates to ivars list.
josevalim authored May 6, 2011
375
9f2d1a1 @fxn spurious space I saw in passing
fxn authored Sep 18, 2012
376 helper ActionMailer::MailHelper
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
377
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
378 private_class_method :new #:nodoc:
db045db @dhh Initial
dhh authored Nov 24, 2004
379
e5ab4b0 @jeremy Convert to class_attribute
jeremy authored Jan 31, 2010
380 class_attribute :default_params
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored Jan 26, 2010
381 self.default_params = {
96f290e @Locke23rus Update actionmailer with new hash syntax.
Locke23rus authored Oct 7, 2012
382 mime_version: "1.0",
383 charset: "UTF-8",
384 content_type: "text/plain",
385 parts_order: [ "text/plain", "text/enriched", "text/html" ]
e5ab4b0 @jeremy Convert to class_attribute
jeremy authored Feb 1, 2010
386 }.freeze
e1c1318 Added delivers_from.
José Valim and Mikel Lindsaar authored Jan 25, 2010
387
eda1719 @jamis ActionMailer::Base.deliver(email) had been accidentally removed, but …
jamis authored Jul 31, 2005
388 class << self
284ca81 @joshk remove AM delegating register_observer and register_interceptor to Ma…
joshk authored Apr 2, 2011
389 # Register one or more Observers which will be notified when mail is delivered.
390 def register_observers(*observers)
391 observers.flatten.compact.each { |observer| register_observer(observer) }
392 end
393
394 # Register one or more Interceptors which will be called before mail is sent.
395 def register_interceptors(*interceptors)
396 interceptors.flatten.compact.each { |interceptor| register_interceptor(interceptor) }
397 end
398
399 # Register an Observer which will be notified when mail is delivered.
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
400 # Either a class or a string can be passed in as the Observer. If a string is passed in
401 # it will be <tt>constantize</tt>d.
284ca81 @joshk remove AM delegating register_observer and register_interceptor to Ma…
joshk authored Apr 2, 2011
402 def register_observer(observer)
cb9e501 @joshk AM register_interceptor and register_observer only constantize if the…
joshk authored Apr 4, 2011
403 delivery_observer = (observer.is_a?(String) ? observer.constantize : observer)
284ca81 @joshk remove AM delegating register_observer and register_interceptor to Ma…
joshk authored Apr 2, 2011
404 Mail.register_observer(delivery_observer)
405 end
406
a467983 @vijaydev fix typo
vijaydev authored Jun 8, 2011
407 # Register an Interceptor which will be called before mail is sent.
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
408 # Either a class or a string can be passed in as the Interceptor. If a string is passed in
409 # it will be <tt>constantize</tt>d.
284ca81 @joshk remove AM delegating register_observer and register_interceptor to Ma…
joshk authored Apr 2, 2011
410 def register_interceptor(interceptor)
cb9e501 @joshk AM register_interceptor and register_observer only constantize if the…
joshk authored Apr 4, 2011
411 delivery_interceptor = (interceptor.is_a?(String) ? interceptor.constantize : interceptor)
284ca81 @joshk remove AM delegating register_observer and register_interceptor to Ma…
joshk authored Apr 2, 2011
412 Mail.register_interceptor(delivery_interceptor)
413 end
414
bd5ed65 @technoweenie Update ActionMailer so it treats ActionView the same way that ActionC…
technoweenie authored Nov 26, 2007
415 def mailer_name
c17d200 @lest mailer can be anonymous
lest authored May 13, 2012
416 @mailer_name ||= anonymous? ? "anonymous" : name.underscore
bd5ed65 @technoweenie Update ActionMailer so it treats ActionView the same way that ActionC…
technoweenie authored Nov 26, 2007
417 end
0750304 @mikel Migrated over to Mail doing delivery.
mikel authored Jan 16, 2010
418 attr_writer :mailer_name
419 alias :controller_path :mailer_name
81c416b @josevalim More refactoring on ActionMailer::Base.
josevalim authored Oct 28, 2009
420
e5ab4b0 @jeremy Convert to class_attribute
jeremy authored Feb 1, 2010
421 def default(value = nil)
422 self.default_params = default_params.merge(value).freeze if value
423 default_params
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored Jan 26, 2010
424 end
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
425 # Allows to set defaults through app configuration:
3009c63 @carlosantoniodasilva Improve docs, changelog and release notes for Action Mailer default_o…
carlosantoniodasilva authored Jul 7, 2012
426 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
427 # config.action_mailer.default_options = { from: "no-reply@example.org" }
edaa2c4 @paneq Introduce config.action_mailer.default_from=
paneq authored Jun 15, 2012
428 alias :default_options= :default
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored Jan 26, 2010
429
59f1df1 @jamis Update/extend ActionMailer documentation (rdoc)
jamis authored Oct 16, 2005
430 # Receives a raw email, parses it into an email object, decodes it,
431 # instantiates a new mailer, and passes the email object to the mailer
98dc582 @lifo Merge docrails.
lifo authored May 25, 2008
432 # object's +receive+ method. If you want your mailer to be able to
433 # process incoming messages, you'll need to implement a +receive+
bb2c7b4 @mikel Updating Action Mailer documentation
mikel authored Jan 29, 2010
434 # method that accepts the raw email string as a parameter:
59f1df1 @jamis Update/extend ActionMailer documentation (rdoc)
jamis authored Oct 16, 2005
435 #
436 # class MyMailer < ActionMailer::Base
437 # def receive(mail)
438 # ...
439 # end
440 # end
704daad @josevalim Ensure we just send Ruby Stdlib objects in ActionMailer notifications.
josevalim authored Jan 15, 2010
441 def receive(raw_mail)
731d439 @jaggederest Change event namespace ordering to most-significant first [#4504 stat…
jaggederest authored Apr 27, 2010
442 ActiveSupport::Notifications.instrument("receive.action_mailer") do |payload|
704daad @josevalim Ensure we just send Ruby Stdlib objects in ActionMailer notifications.
josevalim authored Jan 15, 2010
443 mail = Mail.new(raw_mail)
444 set_payload_for_mail(payload, mail)
2a6bc12 @josevalim Add subscriber to ActionMailer.
josevalim authored Jan 13, 2010
445 new.receive(mail)
446 end
eda1719 @jamis ActionMailer::Base.deliver(email) had been accidentally removed, but …
jamis authored Jul 31, 2005
447 end
448
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
449 # Wraps an email delivery inside of Active Support Notifications instrumentation. This
450 # method is actually called by the <tt>Mail::Message</tt> object itself through a callback
451 # when you call <tt>:deliver</tt> on the Mail::Message, calling +deliver_mail+ directly
452 # and passing a Mail::Message will do nothing except tell the logger you sent the email.
453 def deliver_mail(mail) #:nodoc:
731d439 @jaggederest Change event namespace ordering to most-significant first [#4504 stat…
jaggederest authored Apr 28, 2010
454 ActiveSupport::Notifications.instrument("deliver.action_mailer") do |payload|
c176397 @sachin87 some modifications in action_mailer/base.rb
sachin87 authored Jan 22, 2012
455 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 Jan 25, 2010
456 yield # Let Mail do the delivery actions
258ca14 Delegated ActionMailer::Base.deliveries to Mail.deliveries, added cal…
José Valim and Mikel Lindsaar authored Jan 24, 2010
457 end
458 end
459
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
460 def respond_to?(method, include_private = false) #:nodoc:
99f960a Handle some TODOs and deprecations.
José Valim and Mikel Lindsaar authored Jan 24, 2010
461 super || action_methods.include?(method.to_s)
462 end
463
464 protected
465
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
466 def set_payload_for_mail(payload, mail) #:nodoc:
e8c9cac @tenderlove self is implied, so remove self
tenderlove authored Sep 29, 2010
467 payload[:mailer] = name
c905fce @josevalim Add message_id to AM payload and don't send bcc and cc if they were n…
josevalim authored Jan 15, 2010
468 payload[:message_id] = mail.message_id
469 payload[:subject] = mail.subject
470 payload[:to] = mail.to
471 payload[:from] = mail.from
472 payload[:bcc] = mail.bcc if mail.bcc.present?
473 payload[:cc] = mail.cc if mail.cc.present?
474 payload[:date] = mail.date
475 payload[:mail] = mail.encoded
704daad @josevalim Ensure we just send Ruby Stdlib objects in ActionMailer notifications.
josevalim authored Jan 15, 2010
476 end
f30d73b Add new class delivery method API.
José Valim and Mikel Lindsaar authored Jan 24, 2010
477
34b23e7 @spastorino Action Mailer async flag is true by default using a Synchronous impl
spastorino authored Sep 10, 2012
478 def method_missing(method_name, *args)
f9da785 @jeremy Move background jobs to the 'jobs' branch until fully baked. Not ship…
jeremy authored Dec 21, 2012
479 if respond_to?(method_name)
480 new(method_name, *args).message
34b23e7 @spastorino Action Mailer async flag is true by default using a Synchronous impl
spastorino authored Sep 10, 2012
481 else
482 super
483 end
484 end
eda1719 @jamis ActionMailer::Base.deliver(email) had been accidentally removed, but …
jamis authored Jul 31, 2005
485 end
486
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored Jan 24, 2010
487 attr_internal :message
488
6ba9446 Make implicit and explicit templates pass through the same part creat…
José Valim and Mikel Lindsaar authored Jan 23, 2010
489 # Instantiate a new mailer object. If +method_name+ is not +nil+, the mailer
490 # will be initialized according to the named method. If not, the mailer will
491 # remain uninitialized (useful when you only need to invoke the "receive"
492 # method, for instance).
493 def initialize(method_name=nil, *args)
494 super()
ec3429a @senny The return value from mailer methods is not relevant.
senny authored Dec 7, 2012
495 @_mail_was_called = false
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored Jan 24, 2010
496 @_message = Mail.new
6ba9446 Make implicit and explicit templates pass through the same part creat…
José Valim and Mikel Lindsaar authored Jan 23, 2010
497 process(method_name, *args) if method_name
498 end
499
3fc609e @josevalim Fix ActionMailer test broken in 99d5459
josevalim authored Apr 12, 2010
500 def process(*args) #:nodoc:
501 lookup_context.skip_default_locale!
b786f06 @senny Do not render views when mail() isn't called. (NullMail refactoring)
senny authored Sep 29, 2012
502
ec3429a @senny The return value from mailer methods is not relevant.
senny authored Dec 7, 2012
503 super
504 @_message = NullMail.new unless @_mail_was_called
b786f06 @senny Do not render views when mail() isn't called. (NullMail refactoring)
senny authored Sep 29, 2012
505 end
506
507 class NullMail #:nodoc:
508 def body; '' end
509
510 def method_missing(*args)
511 nil
512 end
3fc609e @josevalim Fix ActionMailer test broken in 99d5459
josevalim authored Apr 12, 2010
513 end
514
972efa1 @josevalim Deprecate the old mailer API that was not deprecated yet.
josevalim authored Aug 29, 2010
515 def mailer_name
516 self.class.mailer_name
517 end
518
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
519 # Allows you to pass random and unusual headers to the new <tt>Mail::Message</tt> object
520 # which will add them to itself.
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
521 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
522 # headers['X-Special-Domain-Specific-Header'] = "SecretValue"
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
523 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
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 May 15, 2010
526 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
527 # headers 'X-Special-Domain-Specific-Header' => "SecretValue",
05c4ad9 Tidy up tests and docs.
José Valim and Mikel Lindsaar authored Jan 26, 2010
528 # 'In-Reply-To' => incoming.message_id
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
529 #
ff44c33 @mark-rushakoff Fix it's -> its
mark-rushakoff authored Apr 27, 2012
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 May 15, 2010
531 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
532 # X-Special-Domain-Specific-Header: SecretValue
975493a @robin850 Fix missing spaces before and after equal signs in method definitions
robin850 authored Jan 3, 2013
533 def headers(args = nil)
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored Jan 24, 2010
534 if args
9520166 @mikel Fixed up being able to pass random headers in with headers, or mail. …
mikel authored Jan 26, 2010
535 @_message.headers(args)
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored Jan 24, 2010
536 else
537 @_message
538 end
539 end
c34cfcc @mikel Created mail method for new API
mikel authored Jan 20, 2010
540
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
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 May 15, 2010
542 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
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 May 15, 2010
544 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
545 # If you do this, then Mail will take the file name and work out the mime type
546 # set the Content-Type, Content-Disposition, Content-Transfer-Encoding and
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 May 15, 2010
548 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
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 May 15, 2010
550 #
96f290e @Locke23rus Update actionmailer with new hash syntax.
Locke23rus authored Oct 7, 2012
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 May 15, 2010
553 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
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 May 15, 2010
557 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
558 # file_content = SpecialEncode(File.read('/path/to/filename.jpg'))
96f290e @Locke23rus Update actionmailer with new hash syntax.
Locke23rus authored Oct 7, 2012
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 May 15, 2010
562 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
563 # You can also search for specific attachments:
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
564 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
565 # # By Filename
755af49 @fxn edit pass to apply API guideline wrt the use of "# =>" in example code
fxn authored Jul 30, 2010
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 May 15, 2010
567 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
568 # # or by index
755af49 @fxn edit pass to apply API guideline wrt the use of "# =>" in example code
fxn authored Jul 30, 2010
569 # mail.attachments[0] # => Mail::Part (first attachment)
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
570 #
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored Jan 24, 2010
571 def attachments
572 @_message.attachments
573 end
dcb9253 Add basic template rendering to new DSL.
José Valim and Mikel Lindsaar authored Jan 22, 2010
574
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
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.
577 #
578 # Both methods accept a headers hash. This hash allows you to specify the most used headers
579 # in an email message, these are:
580 #
581 # * <tt>:subject</tt> - The subject of the message, if this is omitted, Action Mailer will
582 # ask the Rails I18n class for a translated <tt>:subject</tt> in the scope of
583 # <tt>[mailer_scope, action_name]</tt> or if this is missing, will translate the
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.
587 # * <tt>:from</tt> - Who the message is from
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.
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
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 May 15, 2010
594 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
595 # You can set default values for any of the above headers (except :date) by using the <tt>default</tt>
596 # class method:
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
597 #
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored Jan 26, 2010
598 # class Notifier < ActionMailer::Base
e1df81c @avakhov Remove superfluous `self.` in Action Mailer mail method documetation
avakhov authored Apr 23, 2013
599 # 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 Jan 26, 2010
602 # end
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
603 #
52c56f9 @wincent docs: note that mail() accepts arbitrary headers
wincent authored Jun 29, 2010
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 Jan 25, 2010
607 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
608 # When a <tt>:return_path</tt> is specified as header, that value will be used as the 'envelope from'
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
611 # <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 Jan 25, 2010
612 # field for the 'envelope from' value.
613 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
614 # If you do not pass a block to the +mail+ method, it will find all templates in the
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.
be35a15 @josevalim Allow to choose the template path and template name used in implicit …
josevalim authored Feb 19, 2010
619 #
620 # For example:
621 #
622 # class Notifier < ActionMailer::Base
96f290e @Locke23rus Update actionmailer with new hash syntax.
Locke23rus authored Oct 7, 2012
623 # default from: 'no-reply@test.lindsaar.net',
be35a15 @josevalim Allow to choose the template path and template name used in implicit …
josevalim authored Feb 19, 2010
624 #
625 # def welcome
96f290e @Locke23rus Update actionmailer with new hash syntax.
Locke23rus authored Oct 7, 2012
626 # mail(to: 'mikel@test.lindsaar.net')
be35a15 @josevalim Allow to choose the template path and template name used in implicit …
josevalim authored Feb 19, 2010
627 # end
628 # end
629 #
45b1045 @dmathieu raise an error if no implicit mailer template could be found
dmathieu authored Jun 20, 2012
630 # Will look for all templates at "app/views/notifier" with name "welcome".
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
631 # 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 Jun 20, 2012
632 #
633 # However, those can be customized:
be35a15 @josevalim Allow to choose the template path and template name used in implicit …
josevalim authored Feb 19, 2010
634 #
96f290e @Locke23rus Update actionmailer with new hash syntax.
Locke23rus authored Oct 7, 2012
635 # mail(template_path: 'notifications', template_name: 'another')
be35a15 @josevalim Allow to choose the template path and template name used in implicit …
josevalim authored Feb 19, 2010
636 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
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 Jan 25, 2010
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 May 15, 2010
640 #
96f290e @Locke23rus Update actionmailer with new hash syntax.
Locke23rus authored Oct 7, 2012
641 # mail(to: 'mikel@test.lindsaar.net') do |format|
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
642 # format.text
643 # format.html
644 # end
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
645 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
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 May 15, 2010
647 #
96f290e @Locke23rus Update actionmailer with new hash syntax.
Locke23rus authored Oct 7, 2012
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>" }
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
651 # end
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
652 #
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
653 # Which will render a <tt>multipart/alternative</tt> email with <tt>text/plain</tt> and
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 Jan 26, 2010
655 #
656 # The block syntax also allows you to customize the part headers if desired:
657 #
8659212 @AvnerCohen Actionmailer to 1.9 hash syntax
AvnerCohen authored Nov 8, 2012
658 # mail(to: 'mikel@test.lindsaar.net') do |format|
96f290e @Locke23rus Update actionmailer with new hash syntax.
Locke23rus authored Oct 7, 2012
659 # 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 Jan 26, 2010
660 # format.html
661 # end
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
662 #
975493a @robin850 Fix missing spaces before and after equal signs in method definitions
robin850 authored Jan 3, 2013
663 def mail(headers = {}, &block)
ec3429a @senny The return value from mailer methods is not relevant.
senny authored Dec 7, 2012
664 @_mail_was_called = true
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored Jan 24, 2010
665 m = @_message
258ca14 Delegated ActionMailer::Base.deliveries to Mail.deliveries, added cal…
José Valim and Mikel Lindsaar authored Jan 24, 2010
666
2125a6a @carlosantoniodasilva Remove not used variable warnings from AM and AC
carlosantoniodasilva authored Dec 11, 2012
667 # At the beginning, do not consider class default for content_type
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored Jan 26, 2010
668 content_type = headers[:content_type]
1cd5592 First work on implicit multipart.
José Valim and Mikel Lindsaar authored Jan 22, 2010
669
08b07b6 @mikel Adding ability to pass proc's to the ActionMailer class default method
mikel authored May 2, 2010
670 # Call all the procs (if any)
c176397 @sachin87 some modifications in action_mailer/base.rb
sachin87 authored Jan 21, 2012
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 Jan 23, 2012
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 May 2, 2010
674 end
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
675
b5f9a9f @josevalim Move set_fields! to the old API module.
josevalim authored Apr 12, 2010
676 # Handle defaults
08b07b6 @mikel Adding ability to pass proc's to the ActionMailer class default method
mikel authored May 2, 2010
677 headers = headers.reverse_merge(default_values)
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored Jan 26, 2010
678 headers[:subject] ||= default_i18n_subject
b5f9a9f @josevalim Move set_fields! to the old API module.
josevalim authored Apr 12, 2010
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 Aug 20, 2012
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 Apr 12, 2010
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 Apr 13, 2010
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 Apr 12, 2010
688 assignable.each { |k, v| m[k] = v }
951397b Get implicit multipart and attachments working together.
José Valim and Mikel Lindsaar authored Jan 22, 2010
689
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored Jan 24, 2010
690 # Render the templates and blocks
9cf33b5 @nateberkopec Explicit multipart messages respect :parts_order
nateberkopec authored Oct 27, 2012
691 responses = collect_responses(headers, &block)
b5f9a9f @josevalim Move set_fields! to the old API module.
josevalim authored Apr 12, 2010
692 create_parts_from_responses(m, responses)
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored Jan 24, 2010
693
b5f9a9f @josevalim Move set_fields! to the old API module.
josevalim authored Apr 12, 2010
694 # Setup content type, reapply charset and handle parts order
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored Jan 26, 2010
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 Jan 22, 2010
696 m.charset = charset
697
e7e4ed4 Set sort order for explicit parts from the collector's template sequence
José Valim and Mikel Lindsaar authored Jan 24, 2010
698 if m.multipart?
9cf33b5 @nateberkopec Explicit multipart messages respect :parts_order
nateberkopec authored Oct 27, 2012
699 m.body.set_sort_order(headers[:parts_order])
951397b Get implicit multipart and attachments working together.
José Valim and Mikel Lindsaar authored Jan 22, 2010
700 m.body.sort_parts!
701 end
bb9d71f Move class methods to deprecated stuff.
José Valim and Mikel Lindsaar authored Jan 22, 2010
702
c34cfcc @mikel Created mail method for new API
mikel authored Jan 20, 2010
703 m
704 end
705
6ba9446 Make implicit and explicit templates pass through the same part creat…
José Valim and Mikel Lindsaar authored Jan 23, 2010
706 protected
707
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored Jan 26, 2010
708 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 Jan 26, 2010
709 params = m.content_type_parameters || {}
710 case
711 when user_content_type.present?
712 user_content_type
713 when m.has_attachments?
311d99e @mikel Adding inline attachment support to ActionMailer
mikel authored Jun 7, 2010
714 if m.attachments.detect { |a| a.inline? }
715 ["multipart", "related", params]
716 else
717 ["multipart", "mixed", params]
718 end
74a5889 Refactor content type setting, added tests to ensure boundary exists …
José Valim and Mikel Lindsaar authored Jan 26, 2010
719 when m.multipart?
720 ["multipart", "alternative", params]
721 else
b6b3db6 @mikel Fixed bug on HTML only emails getting set to text/plain
mikel authored Jan 28, 2010
722 m.content_type || class_default
74a5889 Refactor content type setting, added tests to ensure boundary exists …
José Valim and Mikel Lindsaar authored Jan 26, 2010
723 end
724 end
725
0e288ec @rafaelfranca Revert "update ActionMailer::Base documentation [ci skip]"
rafaelfranca authored Sep 21, 2012
726 # Translates the +subject+ using Rails I18n class under <tt>[mailer_scope, action_name]</tt> scope.
727 # If it does not find a translation for the +subject+ under the specified scope it will default to a
728 # humanized version of the <tt>action_name</tt>.
57bfbc2 @exviva Allow passing interpolations to `#default_i18n_subject`, e.g.:
exviva authored Jan 23, 2013
729 # If the subject has interpolations, you can pass them through the +interpolations+ parameter.
730 def default_i18n_subject(interpolations = {})
2d8396f @jurriaan Updated/changed useless tr/gsubs
jurriaan authored Apr 3, 2012
731 mailer_scope = self.class.mailer_name.tr('/', '.')
57bfbc2 @exviva Allow passing interpolations to `#default_i18n_subject`, e.g.:
exviva authored Jan 23, 2013
732 I18n.t(:subject, interpolations.merge(scope: [mailer_scope, action_name], default: action_name.humanize))
5c3ef8c Refactor subject with i18n.
José Valim and Mikel Lindsaar authored Jan 23, 2010
733 end
734
9cf33b5 @nateberkopec Explicit multipart messages respect :parts_order
nateberkopec authored Oct 27, 2012
735 def collect_responses(headers) #:nodoc:
736 responses = []
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored Jan 24, 2010
737
738 if block_given?
a09e992 @josevalim Ensure details are frozen after @details_keys lookup. The implementat…
josevalim authored Mar 27, 2010
739 collector = ActionMailer::Collector.new(lookup_context) { render(action_name) }
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored Jan 24, 2010
740 yield(collector)
9cf33b5 @nateberkopec Explicit multipart messages respect :parts_order
nateberkopec authored Oct 27, 2012
741 responses = collector.responses
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored Jan 24, 2010
742 elsif headers[:body]
743 responses << {
96f290e @Locke23rus Update actionmailer with new hash syntax.
Locke23rus authored Oct 7, 2012
744 body: headers.delete(:body),
745 content_type: self.class.default[:content_type] || "text/plain"
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored Jan 24, 2010
746 }
747 else
be35a15 @josevalim Allow to choose the template path and template name used in implicit …
josevalim authored Feb 19, 2010
748 templates_path = headers.delete(:template_path) || self.class.mailer_name
749 templates_name = headers.delete(:template_name) || action_name
750
744307e @carlosantoniodasilva Send paths argument as an array rather than converting it internally
carlosantoniodasilva authored Jan 28, 2013
751 each_template(Array(templates_path), templates_name) do |template|
f28d856 @josevalim Improve performance of the rendering stack by freezing formats as a s…
josevalim authored Mar 19, 2010
752 self.formats = template.formats
753
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored Jan 24, 2010
754 responses << {
96f290e @Locke23rus Update actionmailer with new hash syntax.
Locke23rus authored Oct 7, 2012
755 body: render(template: template),
756 content_type: template.type.to_s
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored Jan 24, 2010
757 }
758 end
759 end
760
9cf33b5 @nateberkopec Explicit multipart messages respect :parts_order
nateberkopec authored Oct 27, 2012
761 responses
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored Jan 24, 2010
762 end
763
be35a15 @josevalim Allow to choose the template path and template name used in implicit …
josevalim authored Feb 19, 2010
764 def each_template(paths, name, &block) #:nodoc:
744307e @carlosantoniodasilva Send paths argument as an array rather than converting it internally
carlosantoniodasilva authored Jan 29, 2013
765 templates = lookup_context.find_all(name, paths)
45b1045 @dmathieu raise an error if no implicit mailer template could be found
dmathieu authored Jun 20, 2012
766 if templates.empty?
744307e @carlosantoniodasilva Send paths argument as an array rather than converting it internally
carlosantoniodasilva authored Jan 29, 2013
767 raise ActionView::MissingTemplate.new(paths, name, paths, false, 'mailer')
45b1045 @dmathieu raise an error if no implicit mailer template could be found
dmathieu authored Jun 20, 2012
768 else
769 templates.uniq { |t| t.formats }.each(&block)
770 end
99f960a Handle some TODOs and deprecations.
José Valim and Mikel Lindsaar authored Jan 24, 2010
771 end
772
b5f9a9f @josevalim Move set_fields! to the old API module.
josevalim authored Apr 12, 2010
773 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 Jan 23, 2010
774 if responses.size == 1 && !m.has_attachments?
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored Jan 26, 2010
775 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 Jan 26, 2010
776 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 Jan 23, 2010
777 container = Mail::Part.new
74a5889 Refactor content type setting, added tests to ensure boundary exists …
José Valim and Mikel Lindsaar authored Jan 26, 2010
778 container.content_type = "multipart/alternative"
b5f9a9f @josevalim Move set_fields! to the old API module.
josevalim authored Apr 12, 2010
779 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 Jan 23, 2010
780 m.add_part(container)
781 else
b5f9a9f @josevalim Move set_fields! to the old API module.
josevalim authored Apr 12, 2010
782 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 Jan 23, 2010
783 end
359caef @jamis A very thorough refactoring, resulting in new mail property setters a…
jamis authored May 29, 2005
784 end
785
6ba9446 Make implicit and explicit templates pass through the same part creat…
José Valim and Mikel Lindsaar authored Jan 23, 2010
786 def insert_part(container, response, charset) #:nodoc:
787 response[:charset] ||= charset
788 part = Mail::Part.new(response)
789 container.add_part(part)
359caef @jamis A very thorough refactoring, resulting in new mail property setters a…
jamis authored May 29, 2005
790 end
3fad0cd @dhh Added support for charsets for both subject and body. The default cha…
dhh authored Feb 19, 2005
791
ef5dada @nex3 Only run load hooks once a file has been fully loaded.
nex3 authored Apr 27, 2010
792 ActiveSupport.run_load_hooks(:action_mailer, self)
db045db @dhh Initial
dhh authored Nov 24, 2004
793 end
edaa2c4 @paneq Introduce config.action_mailer.default_from=
paneq authored Jun 15, 2012
794 end
Something went wrong with that request. Please try again.