Skip to content
This repository
Newer
Older
100644 651 lines (606 sloc) 27.996 kb
616ebb8f » josevalim
2009-12-28 Remove unused code paths and require mail only when it's needed.
1 require 'mail'
a2880827 » mikel
2009-12-30 Adding :transfer_encoding -> :content_transfer_encoding as part of Tm…
2 require 'action_mailer/tmail_compat'
c985a0ee » José Valim and Mikel Lindsaar
2010-01-23 Add some tests to collector with templates and any.
3 require 'action_mailer/collector'
41af6d9a » jeremy
2010-03-17 Use Array.wrap not Array()
4 require 'active_support/core_ext/array/wrap'
76f024ac » fxn
2010-03-28 adds missing requires for Object#blank? and Object#present?
5 require 'active_support/core_ext/object/blank'
a63caa4c » Yehuda Katz + Carl Lerche
2009-06-15 Get tests to run (with failures) without old base around
6
c4590d57 » dhh
2006-03-28 Fixed docs
7 module ActionMailer #:nodoc:
98dc5827 » lifo
2008-05-25 Merge docrails.
8 # Action Mailer allows you to send email from your application using a mailer model and views.
db045dbb » dhh
2004-11-24 Initial
9 #
0a407bca » Marcel Molina
2006-05-10 ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, …
10 # = Mailer Models
20bd4bd3 » dhh
2006-09-02 Updated docs and otherwise
11 #
98dc5827 » lifo
2008-05-25 Merge docrails.
12 # To use Action Mailer, you need to create a mailer model.
3b0e1d90 » josh
2008-05-14 Prefer string core_ext inflector methods over directly accessing Infl…
13 #
f44a0b1d » romdi
2010-02-06 fix usage examples and more to use new invocations
14 # $ rails generate mailer Notifier
0a407bca » Marcel Molina
2006-05-10 ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, …
15 #
4a6eba32 » José Valim and Mikel Lindsaar
2010-01-25 Added initial documentation for the new API
16 # The generated model inherits from ActionMailer::Base. Emails are defined by creating methods
17 # within the model which are then used to set variables to be used in the mail template, to
18 # change options on the mail, or to add attachments.
0a407bca » Marcel Molina
2006-05-10 ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, …
19 #
20 # Examples:
21 #
22 # class Notifier < ActionMailer::Base
452bb1e4 » jeremy
2010-01-27 Rename 'defaults' class method to 'default' to reflect that it's a de…
23 # default :from => 'no-reply@example.com',
24 # :return_path => 'system@example.com'
4a6eba32 » José Valim and Mikel Lindsaar
2010-01-25 Added initial documentation for the new API
25 #
26 # def welcome(recipient)
27 # @account = recipient
65899765 » José Valim and Mikel Lindsaar
2010-01-26 Remove old files, add some information to docs and improve test suite.
28 # mail(:to => recipient.email_address_with_name,
29 # :bcc => ["bcc@example.com", "Order Watcher <watcher@example.com>"])
4a6eba32 » José Valim and Mikel Lindsaar
2010-01-25 Added initial documentation for the new API
30 # end
0a407bca » Marcel Molina
2006-05-10 ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, …
31 # end
4a6eba32 » José Valim and Mikel Lindsaar
2010-01-25 Added initial documentation for the new API
32 #
33 # Within the mailer method, you have access to the following methods:
34 #
35 # * <tt>attachments[]=</tt> - Allows you to add attachments to your email in an intuitive
36 # manner; <tt>attachments['filename.png'] = File.read('path/to/filename.png')</tt>
65899765 » José Valim and Mikel Lindsaar
2010-01-26 Remove old files, add some information to docs and improve test suite.
37 #
bb2c7b43 » mikel
2010-01-29 Updating Action Mailer documentation
38 # * <tt>headers[]=</tt> - Allows you to specify any header field in your email such
39 # as <tt>headers['X-No-Spam'] = 'True'</tt>. Note, while most fields (like <tt>To:</tt>
40 # <tt>From:</tt> can only appear once in an email header, other fields like <tt>X-Anything</tt>
41 # can appear multiple times. If you want to change a field that can appear multiple times,
42 # you need to set it to nil first so that Mail knows you are replacing it, not adding
43 # another field of the same name.)
65899765 » José Valim and Mikel Lindsaar
2010-01-26 Remove old files, add some information to docs and improve test suite.
44 #
9520166f » mikel
2010-01-27 Fixed up being able to pass random headers in with headers, or mail. …
45 # * <tt>headers(hash)</tt> - Allows you to specify multiple headers in your email such
46 # as <tt>headers({'X-No-Spam' => 'True', 'In-Reply-To' => '1234@message.id'})</tt>
47 #
4a6eba32 » José Valim and Mikel Lindsaar
2010-01-25 Added initial documentation for the new API
48 # * <tt>mail</tt> - Allows you to specify your email to send.
49 #
9520166f » mikel
2010-01-27 Fixed up being able to pass random headers in with headers, or mail. …
50 # The hash passed to the mail method allows you to specify any header that a Mail::Message
bb2c7b43 » mikel
2010-01-29 Updating Action Mailer documentation
51 # will accept (any valid Email header including optional fields).
4a6eba32 » José Valim and Mikel Lindsaar
2010-01-25 Added initial documentation for the new API
52 #
53 # The mail method, if not passed a block, will inspect your views and send all the views with
bb2c7b43 » mikel
2010-01-29 Updating Action Mailer documentation
54 # the same name as the method, so the above action would send the +welcome.text.plain.erb+ view
55 # file as well as the +welcome.text.html.erb+ view file in a +multipart/alternative+ email.
4a6eba32 » José Valim and Mikel Lindsaar
2010-01-25 Added initial documentation for the new API
56 #
57 # If you want to explicitly render only certain templates, pass a block:
58 #
59 # mail(:to => user.emai) do |format|
60 # format.text
61 # format.html
62 # end
20bd4bd3 » dhh
2006-09-02 Updated docs and otherwise
63 #
65899765 » José Valim and Mikel Lindsaar
2010-01-26 Remove old files, add some information to docs and improve test suite.
64 # The block syntax is useful if also need to specify information specific to a part:
65 #
66 # mail(:to => user.emai) do |format|
67 # format.text(:content_transfer_encoding => "base64")
68 # format.html
69 # end
70 #
bb2c7b43 » mikel
2010-01-29 Updating Action Mailer documentation
71 # Or even to render a special view:
65899765 » José Valim and Mikel Lindsaar
2010-01-26 Remove old files, add some information to docs and improve test suite.
72 #
73 # mail(:to => user.emai) do |format|
74 # format.text
75 # format.html { render "some_other_template" }
76 # end
77 #
20bd4bd3 » dhh
2006-09-02 Updated docs and otherwise
78 # = Mailer views
79 #
4a6eba32 » José Valim and Mikel Lindsaar
2010-01-25 Added initial documentation for the new API
80 # Like Action Controller, each mailer class has a corresponding view directory in which each
81 # method of the class looks for a template with its name.
82 #
83 # To define a template to be used with a mailing, create an <tt>.erb</tt> file with the same
84 # name as the method in your mailer model. For example, in the mailer defined above, the template at
bb2c7b43 » mikel
2010-01-29 Updating Action Mailer documentation
85 # <tt>app/views/notifier/signup_notification.text.plain.erb</tt> would be used to generate the email.
0a407bca » Marcel Molina
2006-05-10 ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, …
86 #
87 # Variables defined in the model are accessible as instance variables in the view.
88 #
89 # Emails by default are sent in plain text, so a sample view for our model example might look like this:
90 #
91 # Hi <%= @account.name %>,
92 # Thanks for joining our service! Please check back often.
93 #
20bd4bd3 » dhh
2006-09-02 Updated docs and otherwise
94 # You can even use Action Pack helpers in these views. For example:
95 #
96 # You got a new note!
ee70d1b6 » josevalim
2009-12-25 adv_attr_accessors in ActionMailer are not sent to the views, use the…
97 # <%= truncate(@note.body, 25) %>
98 #
65899765 » José Valim and Mikel Lindsaar
2010-01-26 Remove old files, add some information to docs and improve test suite.
99 # If you need to access the subject, from or the recipients in the view, you can do that through message object:
ee70d1b6 » josevalim
2009-12-25 adv_attr_accessors in ActionMailer are not sent to the views, use the…
100 #
65899765 » José Valim and Mikel Lindsaar
2010-01-26 Remove old files, add some information to docs and improve test suite.
101 # You got a new note from <%= message.from %>!
ee70d1b6 » josevalim
2009-12-25 adv_attr_accessors in ActionMailer are not sent to the views, use the…
102 # <%= truncate(@note.body, 25) %>
3b0e1d90 » josh
2008-05-14 Prefer string core_ext inflector methods over directly accessing Infl…
103 #
20bd4bd3 » dhh
2006-09-02 Updated docs and otherwise
104 #
4809dcc1 » Cody Fauser
2008-04-21 * Remove default_url_options from mailer generator
105 # = Generating URLs
3b0e1d90 » josh
2008-05-14 Prefer string core_ext inflector methods over directly accessing Infl…
106 #
bb2c7b43 » mikel
2010-01-29 Updating Action Mailer documentation
107 # URLs can be generated in mailer views using <tt>url_for</tt> or named routes. Unlike controllers from
108 # Action Pack, the mailer instance doesn't have any context about the incoming request, so you'll need
109 # to provide all of the details needed to generate a URL.
20bd4bd3 » dhh
2006-09-02 Updated docs and otherwise
110 #
4809dcc1 » Cody Fauser
2008-04-21 * Remove default_url_options from mailer generator
111 # When using <tt>url_for</tt> you'll need to provide the <tt>:host</tt>, <tt>:controller</tt>, and <tt>:action</tt>:
3b0e1d90 » josh
2008-05-14 Prefer string core_ext inflector methods over directly accessing Infl…
112 #
4809dcc1 » Cody Fauser
2008-04-21 * Remove default_url_options from mailer generator
113 # <%= url_for(:host => "example.com", :controller => "welcome", :action => "greeting") %>
20bd4bd3 » dhh
2006-09-02 Updated docs and otherwise
114 #
4809dcc1 » Cody Fauser
2008-04-21 * Remove default_url_options from mailer generator
115 # When using named routes you only need to supply the <tt>:host</tt>:
3b0e1d90 » josh
2008-05-14 Prefer string core_ext inflector methods over directly accessing Infl…
116 #
4809dcc1 » Cody Fauser
2008-04-21 * Remove default_url_options from mailer generator
117 # <%= users_url(:host => "example.com") %>
118 #
bb2c7b43 » mikel
2010-01-29 Updating Action Mailer documentation
119 # You will want to avoid using the <tt>name_of_route_path</tt> form of named routes because it doesn't
120 # make sense to generate relative URLs in email messages.
4809dcc1 » Cody Fauser
2008-04-21 * Remove default_url_options from mailer generator
121 #
bb2c7b43 » mikel
2010-01-29 Updating Action Mailer documentation
122 # It is also possible to set a default host that will be used in all mailers by setting the <tt>:host</tt>
123 # option in the <tt>ActionMailer::Base.default_url_options</tt> hash as follows:
4809dcc1 » Cody Fauser
2008-04-21 * Remove default_url_options from mailer generator
124 #
125 # ActionMailer::Base.default_url_options[:host] = "example.com"
3b0e1d90 » josh
2008-05-14 Prefer string core_ext inflector methods over directly accessing Infl…
126 #
dc4eec11 » lifo
2008-05-09 Merge docrails:
127 # This can also be set as a configuration option in <tt>config/environment.rb</tt>:
4809dcc1 » Cody Fauser
2008-04-21 * Remove default_url_options from mailer generator
128 #
129 # config.action_mailer.default_url_options = { :host => "example.com" }
20bd4bd3 » dhh
2006-09-02 Updated docs and otherwise
130 #
4809dcc1 » Cody Fauser
2008-04-21 * Remove default_url_options from mailer generator
131 # If you do decide to set a default <tt>:host</tt> for your mailers you will want to use the
bb2c7b43 » mikel
2010-01-29 Updating Action Mailer documentation
132 # <tt>:only_path => false</tt> option when using <tt>url_for</tt>. This will ensure that absolute URLs are
133 # generated because the <tt>url_for</tt> view helper will, by default, generate relative URLs when a
134 # <tt>:host</tt> option isn't explicitly provided.
20bd4bd3 » dhh
2006-09-02 Updated docs and otherwise
135 #
136 # = Sending mail
137 #
3b0e1d90 » josh
2008-05-14 Prefer string core_ext inflector methods over directly accessing Infl…
138 # Once a mailer action and template are defined, you can deliver your message or create it and save it
0a407bca » Marcel Molina
2006-05-10 ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, …
139 # for delivery later:
140 #
4a6eba32 » José Valim and Mikel Lindsaar
2010-01-25 Added initial documentation for the new API
141 # Notifier.welcome(david).deliver # sends the email
142 # mail = Notifier.welcome(david) # => a Mail::Message object
143 # mail.deliver # sends the email
0a407bca » Marcel Molina
2006-05-10 ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, …
144 #
bb2c7b43 » mikel
2010-01-29 Updating Action Mailer documentation
145 # You never instantiate your mailer class. Rather, you just call the method you defined on the class itself.
20bd4bd3 » dhh
2006-09-02 Updated docs and otherwise
146 #
4a6eba32 » José Valim and Mikel Lindsaar
2010-01-25 Added initial documentation for the new API
147 # = Multipart Emails
3b0e1d90 » josh
2008-05-14 Prefer string core_ext inflector methods over directly accessing Infl…
148 #
98dc5827 » lifo
2008-05-25 Merge docrails.
149 # Multipart messages can also be used implicitly because Action Mailer will automatically
0a407bca » Marcel Molina
2006-05-10 ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, …
150 # detect and use multipart templates, where each template is named after the name of the action, followed
151 # by the content type. Each such detected template will be added as separate part to the message.
3b0e1d90 » josh
2008-05-14 Prefer string core_ext inflector methods over directly accessing Infl…
152 #
0a407bca » Marcel Molina
2006-05-10 ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, …
153 # For example, if the following templates existed:
21187c0f » dhh
2007-02-21 Apply the rest of Chads patch
154 # * signup_notification.text.plain.erb
155 # * signup_notification.text.html.erb
156 # * signup_notification.text.xml.builder
65899765 » José Valim and Mikel Lindsaar
2010-01-26 Remove old files, add some information to docs and improve test suite.
157 # * signup_notification.text.yaml.erb
3b0e1d90 » josh
2008-05-14 Prefer string core_ext inflector methods over directly accessing Infl…
158 #
4a6eba32 » José Valim and Mikel Lindsaar
2010-01-25 Added initial documentation for the new API
159 # Each would be rendered and added as a separate part to the message, with the corresponding content
160 # type. The content type for the entire message is automatically set to <tt>multipart/alternative</tt>,
161 # which indicates that the email contains multiple different representations of the same email
162 # body. The same instance variables defined in the action are passed to all email templates.
359caef3 » jamis
2005-05-29 A very thorough refactoring, resulting in new mail property setters a…
163 #
46f30f90 » lifo
2008-05-16 Merge documentation changes from docrails.
164 # Implicit template rendering is not performed if any attachments or parts have been added to the email.
165 # This means that you'll have to manually add each part to the email and set the content type of the email
166 # to <tt>multipart/alternative</tt>.
20bd4bd3 » dhh
2006-09-02 Updated docs and otherwise
167 #
0a407bca » Marcel Molina
2006-05-10 ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, …
168 # = Attachments
20bd4bd3 » dhh
2006-09-02 Updated docs and otherwise
169 #
4a6eba32 » José Valim and Mikel Lindsaar
2010-01-25 Added initial documentation for the new API
170 # You can see above how to make a multipart HTML / Text email, to send attachments is just
171 # as easy:
0a407bca » Marcel Molina
2006-05-10 ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, …
172 #
173 # class ApplicationMailer < ActionMailer::Base
4a6eba32 » José Valim and Mikel Lindsaar
2010-01-25 Added initial documentation for the new API
174 # def welcome(recipient)
175 # attachments['free_book.pdf'] = { :data => File.read('path/to/file.pdf') }
176 # mail(:to => recipient, :subject => "New account information")
db045dbb » dhh
2004-11-24 Initial
177 # end
3b0e1d90 » josh
2008-05-14 Prefer string core_ext inflector methods over directly accessing Infl…
178 # end
4a6eba32 » José Valim and Mikel Lindsaar
2010-01-25 Added initial documentation for the new API
179 #
bb2c7b43 » mikel
2010-01-29 Updating Action Mailer documentation
180 # Which will (if it had both a <tt>welcome.text.plain.erb</tt> and <tt>welcome.text.html.erb</tt>
181 # tempalte in the view directory), send a complete <tt>multipart/mixed</tt> email with two parts,
182 # the first part being a <tt>multipart/alternative</tt> with the text and HTML email parts inside,
183 # and the second being a <tt>application/pdf</tt> with a Base64 encoded copy of the file.pdf book
184 # with the filename +free_book.pdf+.
c927aa0f » dhh
2004-12-16 Updated documentation
185 #
cefc136e » mikel
2010-02-22 Adding options to register observers and interceptors through ActionM…
186 # = Observing and Intercepting Mails
187 #
188 # ActionMailer provides hooks into the Mail observer and interceptor methods. These allow you to
189 # register objects that are called during the mail delivery life cycle.
190 #
191 # An observer object must implement the <tt>:delivered_email(message)</tt> method which will be
192 # called once for every email sent after the email has been sent.
193 #
194 # An interceptor object must implement the <tt>:delivering_email(message)</tt> method which will be
195 # called before the email is sent, allowing you to make modifications to the email before it hits
196 # the delivery agents. Your object should make and needed modifications directly to the passed
197 # in Mail::Message instance.
20bd4bd3 » dhh
2006-09-02 Updated docs and otherwise
198 #
c927aa0f » dhh
2004-12-16 Updated documentation
199 # = Configuration options
200 #
201 # These options are specified on the class level, like <tt>ActionMailer::Base.template_root = "/my/templates"</tt>
202 #
452bb1e4 » jeremy
2010-01-27 Rename 'defaults' class method to 'default' to reflect that it's a de…
203 # * <tt>default</tt> - This is a class wide hash of <tt>:key => value</tt> pairs containing
21dcc20e » mikel
2010-01-27 Fixed up documentation to reflect code change and cleaned up tests of…
204 # default values for the specified header fields of the <tt>Mail::Message</tt>. You can
205 # specify a default for any valid header for <tt>Mail::Message</tt> and it will be used if
bb2c7b43 » mikel
2010-01-29 Updating Action Mailer documentation
206 # you do not override it. You pass in the header value as a symbol, all lower case with under
207 # scores instead of hyphens, so <tt>Content-Transfer-Encoding:</tt>
208 # becomes <tt>:content_transfer_encoding</tt>. The defaults set by Action Mailer are:
21dcc20e » mikel
2010-01-27 Fixed up documentation to reflect code change and cleaned up tests of…
209 # * <tt>:mime_version => "1.0"</tt>
dbcf01e6 » mikel
2010-04-08 Removing quoting.rb, upgrade to 2.1.3.6, changing all utf-8 reference…
210 # * <tt>:charset => "UTF-8",</tt>
21dcc20e » mikel
2010-01-27 Fixed up documentation to reflect code change and cleaned up tests of…
211 # * <tt>:content_type => "text/plain",</tt>
212 # * <tt>:parts_order => [ "text/plain", "text/enriched", "text/html" ]</tt>
c927aa0f » dhh
2004-12-16 Updated documentation
213 #
214 # * <tt>logger</tt> - the logger is used for generating information on the mailing run if available.
215 # Can be set to nil for no logging. Compatible with both Ruby's own Logger and Log4r loggers.
216 #
64092de2 » fxn
2008-05-02 Improve documentation coverage and markup
217 # * <tt>smtp_settings</tt> - Allows detailed configuration for <tt>:smtp</tt> delivery method:
bb2c7b43 » mikel
2010-01-29 Updating Action Mailer documentation
218 # * <tt>:address</tt> - Allows you to use a remote mail server. Just change it from its default
219 # "localhost" setting.
dc4eec11 » lifo
2008-05-09 Merge docrails:
220 # * <tt>:port</tt> - On the off chance that your mail server doesn't run on port 25, you can change it.
221 # * <tt>:domain</tt> - If you need to specify a HELO domain, you can do it here.
222 # * <tt>:user_name</tt> - If your mail server requires authentication, set the username in this setting.
223 # * <tt>:password</tt> - If your mail server requires authentication, set the password in this setting.
bb2c7b43 » mikel
2010-01-29 Updating Action Mailer documentation
224 # * <tt>:authentication</tt> - If your mail server requires authentication, you need to specify the
225 # authentication type here.
46f30f90 » lifo
2008-05-16 Merge documentation changes from docrails.
226 # This is a symbol and one of <tt>:plain</tt>, <tt>:login</tt>, <tt>:cram_md5</tt>.
bb2c7b43 » mikel
2010-01-29 Updating Action Mailer documentation
227 # * <tt>:enable_starttls_auto</tt> - When set to true, detects if STARTTLS is enabled in your SMTP server
228 # and starts to use it.
c927aa0f » dhh
2004-12-16 Updated documentation
229 #
46f30f90 » lifo
2008-05-16 Merge documentation changes from docrails.
230 # * <tt>sendmail_settings</tt> - Allows you to override options for the <tt>:sendmail</tt> delivery method.
231 # * <tt>:location</tt> - The location of the sendmail executable. Defaults to <tt>/usr/sbin/sendmail</tt>.
bb2c7b43 » mikel
2010-01-29 Updating Action Mailer documentation
232 # * <tt>:arguments</tt> - The command line arguments. Defaults to <tt>-i -t</tt> with <tt>-f sender@addres</tt>
233 # added automatically before the message is sent.
dc4eec11 » lifo
2008-05-09 Merge docrails:
234 #
fbe6c3c1 » edavis10
2009-08-07 Adds a :file delivery_method to save email to a file on disk
235 # * <tt>file_settings</tt> - Allows you to override options for the <tt>:file</tt> delivery method.
bb2c7b43 » mikel
2010-01-29 Updating Action Mailer documentation
236 # * <tt>:location</tt> - The directory into which emails will be written. Defaults to the application
237 # <tt>tmp/mails</tt>.
fbe6c3c1 » edavis10
2009-08-07 Adds a :file delivery_method to save email to a file on disk
238 #
dc4eec11 » lifo
2008-05-09 Merge docrails:
239 # * <tt>raise_delivery_errors</tt> - Whether or not errors should be raised if the email fails to be delivered.
c927aa0f » dhh
2004-12-16 Updated documentation
240 #
bb2c7b43 » mikel
2010-01-29 Updating Action Mailer documentation
241 # * <tt>delivery_method</tt> - Defines a delivery method. Possible values are <tt>:smtp</tt> (default),
242 # <tt>:sendmail</tt>, <tt>:test</tt>, and <tt>:file</tt>. Or you may provide a custom delivery method
243 # object eg. MyOwnDeliveryMethodClass.new. See the Mail gem documentation on the interface you need to
244 # implement for a custom delivery agent.
c927aa0f » dhh
2004-12-16 Updated documentation
245 #
bb2c7b43 » mikel
2010-01-29 Updating Action Mailer documentation
246 # * <tt>perform_deliveries</tt> - Determines whether emails are actually sent from Action Mailer when you
247 # call <tt>.deliver</tt> on an mail message or on an Action Mailer method. This is on by default but can
248 # be turned off to aid in functional testing.
c927aa0f » dhh
2004-12-16 Updated documentation
249 #
bb2c7b43 » mikel
2010-01-29 Updating Action Mailer documentation
250 # * <tt>deliveries</tt> - Keeps an array of all the emails sent out through the Action Mailer with
251 # <tt>delivery_method :test</tt>. Most useful for unit and functional testing.
af56c806 » dhh
2005-02-24 Updated documentation
252 #
452bb1e4 » jeremy
2010-01-27 Rename 'defaults' class method to 'default' to reflect that it's a de…
253 # * <tt>default_charset</tt> - This is now deprecated, use the +default+ method above to
21dcc20e » mikel
2010-01-27 Fixed up documentation to reflect code change and cleaned up tests of…
254 # set the default +:charset+.
c2e7851f » josevalim
2009-01-11 Add ActionMailer::Base#enable_starttls_auto option for enabling/disab…
255 #
452bb1e4 » jeremy
2010-01-27 Rename 'defaults' class method to 'default' to reflect that it's a de…
256 # * <tt>default_content_type</tt> - This is now deprecated, use the +default+ method above
21dcc20e » mikel
2010-01-27 Fixed up documentation to reflect code change and cleaned up tests of…
257 # to set the default +:content_type+.
c2e7851f » josevalim
2009-01-11 Add ActionMailer::Base#enable_starttls_auto option for enabling/disab…
258 #
452bb1e4 » jeremy
2010-01-27 Rename 'defaults' class method to 'default' to reflect that it's a de…
259 # * <tt>default_mime_version</tt> - This is now deprecated, use the +default+ method above
21dcc20e » mikel
2010-01-27 Fixed up documentation to reflect code change and cleaned up tests of…
260 # to set the default +:mime_version+.
c2e7851f » josevalim
2009-01-11 Add ActionMailer::Base#enable_starttls_auto option for enabling/disab…
261 #
452bb1e4 » jeremy
2010-01-27 Rename 'defaults' class method to 'default' to reflect that it's a de…
262 # * <tt>default_implicit_parts_order</tt> - This is now deprecated, use the +default+ method above
21dcc20e » mikel
2010-01-27 Fixed up documentation to reflect code change and cleaned up tests of…
263 # to set the default +:parts_order+. Parts Order is used when a message is built implicitly
264 # (i.e. multiple parts are assembled from templates which specify the content type in their
265 # filenames) this variable controls how the parts are ordered.
4964d3b0 » josevalim
2009-12-22 Make ActionMailer::Base inherit from AbstractController::Base
266 class Base < AbstractController::Base
dbcf01e6 » mikel
2010-04-08 Removing quoting.rb, upgrade to 2.1.3.6, changing all utf-8 reference…
267 include DeliveryMethods
f30d73ba » José Valim and Mikel Lindsaar
2010-01-24 Add new class delivery method API.
268 abstract!
269
c03c40b4 » josevalim
2009-12-31 Expose a _render_partial hook as thhe _render_template one and make u…
270 include AbstractController::Logger
83f4d86a » dhh
2009-12-20 Rename the RenderingController module to just plain Rendering
271 include AbstractController::Rendering
a9751a70 » josevalim
2009-10-17 Refactor ActionMailer layout and remove legacy one.
272 include AbstractController::Layouts
684c2dc2 » josevalim
2009-10-18 Remove ActionMailer helpers and rely on AbstractController one.
273 include AbstractController::Helpers
48a3985d » josevalim
2010-01-26 Also include translation in ActionMailer.
274 include AbstractController::Translation
359caef3 » jamis
2005-05-29 A very thorough refactoring, resulting in new mail property setters a…
275
ee70d1b6 » josevalim
2009-12-25 adv_attr_accessors in ActionMailer are not sent to the views, use the…
276 helper ActionMailer::MailHelper
7409b734 » José Valim and Mikel Lindsaar
2010-01-24 Some refactoring.
277
5dead5bb » José Valim and Mikel Lindsaar
2010-01-24 Maintain old_api and deprecated_api in different files.
278 include ActionMailer::OldApi
f30d73ba » José Valim and Mikel Lindsaar
2010-01-24 Add new class delivery method API.
279 include ActionMailer::DeprecatedApi
cefc136e » mikel
2010-02-22 Adding options to register observers and interceptors through ActionM…
280
281 delegate :register_observer, :to => Mail
282 delegate :register_interceptor, :to => Mail
7409b734 » José Valim and Mikel Lindsaar
2010-01-24 Some refactoring.
283
c927aa0f » dhh
2004-12-16 Updated documentation
284 private_class_method :new #:nodoc:
db045dbb » dhh
2004-11-24 Initial
285
e5ab4b0d » jeremy
2010-01-31 Convert to class_attribute
286 class_attribute :default_params
9dd65c36 » José Valim and Mikel Lindsaar
2010-01-26 Make defaults accept a hash.
287 self.default_params = {
288 :mime_version => "1.0",
dbcf01e6 » mikel
2010-04-08 Removing quoting.rb, upgrade to 2.1.3.6, changing all utf-8 reference…
289 :charset => "UTF-8",
9dd65c36 » José Valim and Mikel Lindsaar
2010-01-26 Make defaults accept a hash.
290 :content_type => "text/plain",
291 :parts_order => [ "text/plain", "text/enriched", "text/html" ]
e5ab4b0d » jeremy
2010-01-31 Convert to class_attribute
292 }.freeze
e1c13186 » José Valim and Mikel Lindsaar
2010-01-25 Added delivers_from.
293
eda17194 » jamis
2005-07-31 ActionMailer::Base.deliver(email) had been accidentally removed, but …
294 class << self
0b05acd4 » mikel
2010-01-26 Implementing class level :defaults hash, instead of delivers_from et al
295
bd5ed651 » technoweenie
2007-11-26 Update ActionMailer so it treats ActionView the same way that ActionC…
296 def mailer_name
297 @mailer_name ||= name.underscore
298 end
0750304c » mikel
2010-01-16 Migrated over to Mail doing delivery.
299 attr_writer :mailer_name
300 alias :controller_path :mailer_name
81c416b7 » josevalim
2009-10-28 More refactoring on ActionMailer::Base.
301
e5ab4b0d » jeremy
2010-01-31 Convert to class_attribute
302 def default(value = nil)
303 self.default_params = default_params.merge(value).freeze if value
304 default_params
9dd65c36 » José Valim and Mikel Lindsaar
2010-01-26 Make defaults accept a hash.
305 end
306
59f1df1b » jamis
2005-10-16 Update/extend ActionMailer documentation (rdoc)
307 # Receives a raw email, parses it into an email object, decodes it,
308 # instantiates a new mailer, and passes the email object to the mailer
98dc5827 » lifo
2008-05-25 Merge docrails.
309 # object's +receive+ method. If you want your mailer to be able to
310 # process incoming messages, you'll need to implement a +receive+
bb2c7b43 » mikel
2010-01-29 Updating Action Mailer documentation
311 # method that accepts the raw email string as a parameter:
59f1df1b » jamis
2005-10-16 Update/extend ActionMailer documentation (rdoc)
312 #
313 # class MyMailer < ActionMailer::Base
314 # def receive(mail)
315 # ...
316 # end
317 # end
704daad7 » josevalim
2010-01-15 Ensure we just send Ruby Stdlib objects in ActionMailer notifications.
318 def receive(raw_mail)
319 ActiveSupport::Notifications.instrument("action_mailer.receive") do |payload|
320 mail = Mail.new(raw_mail)
321 set_payload_for_mail(payload, mail)
2a6bc126 » josevalim
2010-01-13 Add subscriber to ActionMailer.
322 new.receive(mail)
323 end
eda17194 » jamis
2005-07-31 ActionMailer::Base.deliver(email) had been accidentally removed, but …
324 end
325
bb2c7b43 » mikel
2010-01-29 Updating Action Mailer documentation
326 # Wraps an email delivery inside of Active Support Notifications instrumentation. This
327 # method is actually called by the <tt>Mail::Message</tt> object itself through a call back
328 # when you call <tt>:deliver</tt> on the Mail::Message, calling +deliver_mail+ directly
329 # and passing a Mail::Message will do nothing except tell the logger you sent the email.
e4a989e9 » José Valim and Mikel Lindsaar
2010-01-25 Added delivery_handler method to mail and implemented in ActionMailer…
330 def deliver_mail(mail) #:nodoc:
99f960a3 » José Valim and Mikel Lindsaar
2010-01-24 Handle some TODOs and deprecations.
331 ActiveSupport::Notifications.instrument("action_mailer.deliver") do |payload|
258ca148 » José Valim and Mikel Lindsaar
2010-01-24 Delegated ActionMailer::Base.deliveries to Mail.deliveries, added cal…
332 self.set_payload_for_mail(payload, mail)
ace74974 » José Valim and Mikel Lindsaar
2010-01-25 Got AM working with Mail yield on delivery_handler and updated tests
333 yield # Let Mail do the delivery actions
258ca148 » José Valim and Mikel Lindsaar
2010-01-24 Delegated ActionMailer::Base.deliveries to Mail.deliveries, added cal…
334 end
335 end
336
99f960a3 » José Valim and Mikel Lindsaar
2010-01-24 Handle some TODOs and deprecations.
337 def respond_to?(method, *args) #:nodoc:
338 super || action_methods.include?(method.to_s)
339 end
340
341 protected
342
704daad7 » josevalim
2010-01-15 Ensure we just send Ruby Stdlib objects in ActionMailer notifications.
343 def set_payload_for_mail(payload, mail) #:nodoc:
99f960a3 » José Valim and Mikel Lindsaar
2010-01-24 Handle some TODOs and deprecations.
344 payload[:mailer] = self.name
c905fce3 » josevalim
2010-01-15 Add message_id to AM payload and don't send bcc and cc if they were n…
345 payload[:message_id] = mail.message_id
346 payload[:subject] = mail.subject
347 payload[:to] = mail.to
348 payload[:from] = mail.from
349 payload[:bcc] = mail.bcc if mail.bcc.present?
350 payload[:cc] = mail.cc if mail.cc.present?
351 payload[:date] = mail.date
352 payload[:mail] = mail.encoded
704daad7 » josevalim
2010-01-15 Ensure we just send Ruby Stdlib objects in ActionMailer notifications.
353 end
f30d73ba » José Valim and Mikel Lindsaar
2010-01-24 Add new class delivery method API.
354
99f960a3 » José Valim and Mikel Lindsaar
2010-01-24 Handle some TODOs and deprecations.
355 def method_missing(method, *args) #:nodoc:
f30d73ba » José Valim and Mikel Lindsaar
2010-01-24 Add new class delivery method API.
356 if action_methods.include?(method.to_s)
357 new(method, *args).message
358 else
359 super
360 end
361 end
eda17194 » jamis
2005-07-31 ActionMailer::Base.deliver(email) had been accidentally removed, but …
362 end
363
7409b734 » José Valim and Mikel Lindsaar
2010-01-24 Some refactoring.
364 attr_internal :message
365
6ba94460 » José Valim and Mikel Lindsaar
2010-01-23 Make implicit and explicit templates pass through the same part creat…
366 # Instantiate a new mailer object. If +method_name+ is not +nil+, the mailer
367 # will be initialized according to the named method. If not, the mailer will
368 # remain uninitialized (useful when you only need to invoke the "receive"
369 # method, for instance).
370 def initialize(method_name=nil, *args)
371 super()
7409b734 » José Valim and Mikel Lindsaar
2010-01-24 Some refactoring.
372 @_message = Mail.new
6ba94460 » José Valim and Mikel Lindsaar
2010-01-23 Make implicit and explicit templates pass through the same part creat…
373 process(method_name, *args) if method_name
374 end
375
3fc609ee » josevalim
2010-04-12 Fix ActionMailer test broken in 99d5459
376 def process(*args) #:nodoc:
377 lookup_context.skip_default_locale!
378 super
379 end
380
4a6eba32 » José Valim and Mikel Lindsaar
2010-01-25 Added initial documentation for the new API
381 # Allows you to pass random and unusual headers to the new +Mail::Message+ object
382 # which will add them to itself.
383 #
384 # headers['X-Special-Domain-Specific-Header'] = "SecretValue"
385 #
9520166f » mikel
2010-01-27 Fixed up being able to pass random headers in with headers, or mail. …
386 # You can also pass a hash into headers of header field names and values, which
387 # will then be set on the Mail::Message object:
388 #
05c4ad9d » José Valim and Mikel Lindsaar
2010-01-26 Tidy up tests and docs.
389 # headers 'X-Special-Domain-Specific-Header' => "SecretValue",
390 # 'In-Reply-To' => incoming.message_id
9520166f » mikel
2010-01-27 Fixed up being able to pass random headers in with headers, or mail. …
391 #
4a6eba32 » José Valim and Mikel Lindsaar
2010-01-25 Added initial documentation for the new API
392 # The resulting Mail::Message will have the following in it's header:
393 #
394 # X-Special-Domain-Specific-Header: SecretValue
7409b734 » José Valim and Mikel Lindsaar
2010-01-24 Some refactoring.
395 def headers(args=nil)
396 if args
9520166f » mikel
2010-01-27 Fixed up being able to pass random headers in with headers, or mail. …
397 @_message.headers(args)
7409b734 » José Valim and Mikel Lindsaar
2010-01-24 Some refactoring.
398 else
399 @_message
400 end
401 end
c34cfcc2 » mikel
2010-01-20 Created mail method for new API
402
4a6eba32 » José Valim and Mikel Lindsaar
2010-01-25 Added initial documentation for the new API
403 # Allows you to add attachments to an email, like so:
404 #
405 # mail.attachments['filename.jpg'] = File.read('/path/to/filename.jpg')
406 #
407 # If you do this, then Mail will take the file name and work out the mime type
408 # set the Content-Type, Content-Disposition, Content-Transfer-Encoding and
409 # base64 encode the contents of the attachment all for you.
410 #
411 # You can also specify overrides if you want by passing a hash instead of a string:
412 #
413 # mail.attachments['filename.jpg'] = {:mime_type => 'application/x-gzip',
414 # :content => File.read('/path/to/filename.jpg')}
415 #
416 # If you want to use a different encoding than Base64, you can pass an encoding in,
417 # but then it is up to you to pass in the content pre-encoded, and don't expect
418 # Mail to know how to decode this data:
419 #
420 # file_content = SpecialEncode(File.read('/path/to/filename.jpg'))
421 # mail.attachments['filename.jpg'] = {:mime_type => 'application/x-gzip',
422 # :encoding => 'SpecialEncoding',
423 # :content => file_content }
424 #
425 # You can also search for specific attachments:
426 #
427 # # By Filename
428 # mail.attachments['filename.jpg'] #=> Mail::Part object or nil
429 #
430 # # or by index
431 # mail.attachments[0] #=> Mail::Part (first attachment)
432 #
7409b734 » José Valim and Mikel Lindsaar
2010-01-24 Some refactoring.
433 def attachments
434 @_message.attachments
435 end
dcb92536 » José Valim and Mikel Lindsaar
2010-01-22 Add basic template rendering to new DSL.
436
4a6eba32 » José Valim and Mikel Lindsaar
2010-01-25 Added initial documentation for the new API
437 # The main method that creates the message and renders the email templates. There are
438 # two ways to call this method, with a block, or without a block.
439 #
65899765 » José Valim and Mikel Lindsaar
2010-01-26 Remove old files, add some information to docs and improve test suite.
440 # Both methods accept a headers hash. This hash allows you to specify the most used headers
4a6eba32 » José Valim and Mikel Lindsaar
2010-01-25 Added initial documentation for the new API
441 # in an email message, these are:
442 #
443 # * <tt>:subject</tt> - The subject of the message, if this is omitted, ActionMailer will
444 # ask the Rails I18n class for a translated <tt>:subject</tt> in the scope of
445 # <tt>[:actionmailer, mailer_scope, action_name]</tt> or if this is missing, will translate the
446 # humanized version of the <tt>action_name</tt>
447 # * <tt>:to</tt> - Who the message is destined for, can be a string of addresses, or an array
448 # of addresses.
0b05acd4 » mikel
2010-01-26 Implementing class level :defaults hash, instead of delivers_from et al
449 # * <tt>:from</tt> - Who the message is from
4a6eba32 » José Valim and Mikel Lindsaar
2010-01-25 Added initial documentation for the new API
450 # * <tt>:cc</tt> - Who you would like to Carbon-Copy on this email, can be a string of addresses,
451 # or an array of addresses.
452 # * <tt>:bcc</tt> - Who you would like to Blind-Carbon-Copy on this email, can be a string of
453 # addresses, or an array of addresses.
454 # * <tt>:reply_to</tt> - Who to set the Reply-To header of the email to.
455 # * <tt>:date</tt> - The date to say the email was sent on.
456 #
452bb1e4 » jeremy
2010-01-27 Rename 'defaults' class method to 'default' to reflect that it's a de…
457 # You can set default values for any of the above headers (except :date) by using the <tt>default</tt>
0b05acd4 » mikel
2010-01-26 Implementing class level :defaults hash, instead of delivers_from et al
458 # class method:
459 #
9dd65c36 » José Valim and Mikel Lindsaar
2010-01-26 Make defaults accept a hash.
460 # class Notifier < ActionMailer::Base
452bb1e4 » jeremy
2010-01-27 Rename 'defaults' class method to 'default' to reflect that it's a de…
461 # self.default :from => 'no-reply@test.lindsaar.net',
462 # :bcc => 'email_logger@test.lindsaar.net',
463 # :reply_to => 'bounces@test.lindsaar.net'
0b05acd4 » mikel
2010-01-26 Implementing class level :defaults hash, instead of delivers_from et al
464 # end
465 #
4a6eba32 » José Valim and Mikel Lindsaar
2010-01-25 Added initial documentation for the new API
466 # If you need other headers not listed above, use the <tt>headers['name'] = value</tt> method.
467 #
65899765 » José Valim and Mikel Lindsaar
2010-01-26 Remove old files, add some information to docs and improve test suite.
468 # When a <tt>:return_path</tt> is specified as header, that value will be used as the 'envelope from'
4a6eba32 » José Valim and Mikel Lindsaar
2010-01-25 Added initial documentation for the new API
469 # address for the Mail message. Setting this is useful when you want delivery notifications
470 # sent to a different address than the one in <tt>:from</tt>. Mail will actually use the
471 # <tt>:return_path</tt> in preference to the <tt>:sender</tt> in preference to the <tt>:from</tt>
472 # field for the 'envelope from' value.
473 #
474 # If you do not pass a block to the +mail+ method, it will find all templates in the
be35a151 » josevalim
2010-02-19 Allow to choose the template path and template name used in implicit …
475 # view paths using by default the mailer name and the method name that it is being
476 # called from, it will then create parts for each of these templates intelligently,
477 # making educated guesses on correct content type and sequence, and return a fully
478 # prepared Mail::Message ready to call <tt>:deliver</tt> on to send.
479 #
480 # For example:
481 #
482 # class Notifier < ActionMailer::Base
483 # default :from => 'no-reply@test.lindsaar.net',
484 #
485 # def welcome
486 # mail(:to => 'mikel@test.lindsaar.net')
487 # end
488 # end
489 #
490 # Will look for all templates at "app/views/notifier" with name "welcome". However, those
491 # can be customized:
492 #
493 # mail(:template_path => 'notifications', :template_name => 'another')
494 #
495 # And now it will look for all templates at "app/views/notifications" with name "another".
4a6eba32 » José Valim and Mikel Lindsaar
2010-01-25 Added initial documentation for the new API
496 #
497 # If you do pass a block, you can render specific templates of your choice:
498 #
499 # mail(:to => 'mikel@test.lindsaar.net') do |format|
500 # format.text
501 # format.html
502 # end
503 #
504 # You can even render text directly without using a template:
505 #
506 # mail(:to => 'mikel@test.lindsaar.net') do |format|
507 # format.text { render :text => "Hello Mikel!" }
508 # format.html { render :text => "<h1>Hello Mikel!</h1>" }
509 # end
510 #
74a5889a » José Valim and Mikel Lindsaar
2010-01-26 Refactor content type setting, added tests to ensure boundary exists …
511 # Which will render a <tt>multipart/alternative</tt> email with <tt>text/plain</tt> and
4a6eba32 » José Valim and Mikel Lindsaar
2010-01-25 Added initial documentation for the new API
512 # <tt>text/html</tt> parts.
65899765 » José Valim and Mikel Lindsaar
2010-01-26 Remove old files, add some information to docs and improve test suite.
513 #
514 # The block syntax also allows you to customize the part headers if desired:
515 #
516 # mail(:to => 'mikel@test.lindsaar.net') do |format|
517 # format.text(:content_transfer_encoding => "base64")
518 # format.html
519 # end
520 #
7409b734 » José Valim and Mikel Lindsaar
2010-01-24 Some refactoring.
521 def mail(headers={}, &block)
522 # Guard flag to prevent both the old and the new API from firing
523 # Should be removed when old API is removed
524 @mail_was_called = true
525 m = @_message
258ca148 » José Valim and Mikel Lindsaar
2010-01-24 Delegated ActionMailer::Base.deliveries to Mail.deliveries, added cal…
526
9dd65c36 » José Valim and Mikel Lindsaar
2010-01-26 Make defaults accept a hash.
527 # At the beginning, do not consider class default for parts order neither content_type
528 content_type = headers[:content_type]
529 parts_order = headers[:parts_order]
1cd55928 » José Valim and Mikel Lindsaar
2010-01-22 First work on implicit multipart.
530
08b07b60 » mikel
2010-05-02 Adding ability to pass proc's to the ActionMailer class default method
531 # Call all the procs (if any)
532 default_values = self.class.default.merge(self.class.default) do |k,v|
533 v.respond_to?(:call) ? v.call : v
534 end
535
b5f9a9fc » josevalim
2010-04-12 Move set_fields! to the old API module.
536 # Handle defaults
08b07b60 » mikel
2010-05-02 Adding ability to pass proc's to the ActionMailer class default method
537 headers = headers.reverse_merge(default_values)
9dd65c36 » José Valim and Mikel Lindsaar
2010-01-26 Make defaults accept a hash.
538 headers[:subject] ||= default_i18n_subject
b5f9a9fc » josevalim
2010-04-12 Move set_fields! to the old API module.
539
540 # Apply charset at the beginning so all fields are properly quoted
541 m.charset = charset = headers[:charset]
542
543 # Set configure delivery behavior
544 wrap_delivery_behavior!(headers.delete(:delivery_method))
545
546 # Assign all headers except parts_order, content_type and body
b4fd5e6f » josevalim
2010-04-13 template_name and template_path should not be added to mail headers.
547 assignable = headers.except(:parts_order, :content_type, :body, :template_name, :template_path)
b5f9a9fc » josevalim
2010-04-12 Move set_fields! to the old API module.
548 assignable.each { |k, v| m[k] = v }
951397b4 » José Valim and Mikel Lindsaar
2010-01-22 Get implicit multipart and attachments working together.
549
7409b734 » José Valim and Mikel Lindsaar
2010-01-24 Some refactoring.
550 # Render the templates and blocks
39a1b06f » José Valim and Mikel Lindsaar
2010-01-26 Deprecate old defaults API.
551 responses, explicit_order = collect_responses_and_parts_order(headers, &block)
b5f9a9fc » josevalim
2010-04-12 Move set_fields! to the old API module.
552 create_parts_from_responses(m, responses)
7409b734 » José Valim and Mikel Lindsaar
2010-01-24 Some refactoring.
553
b5f9a9fc » josevalim
2010-04-12 Move set_fields! to the old API module.
554 # Setup content type, reapply charset and handle parts order
9dd65c36 » José Valim and Mikel Lindsaar
2010-01-26 Make defaults accept a hash.
555 m.content_type = set_content_type(m, content_type, headers[:content_type])
951397b4 » José Valim and Mikel Lindsaar
2010-01-22 Get implicit multipart and attachments working together.
556 m.charset = charset
557
e7e4ed48 » José Valim and Mikel Lindsaar
2010-01-24 Set sort order for explicit parts from the collector's template sequence
558 if m.multipart?
9dd65c36 » José Valim and Mikel Lindsaar
2010-01-26 Make defaults accept a hash.
559 parts_order ||= explicit_order || headers[:parts_order]
560 m.body.set_sort_order(parts_order)
951397b4 » José Valim and Mikel Lindsaar
2010-01-22 Get implicit multipart and attachments working together.
561 m.body.sort_parts!
562 end
bb9d71ff » José Valim and Mikel Lindsaar
2010-01-22 Move class methods to deprecated stuff.
563
c34cfcc2 » mikel
2010-01-20 Created mail method for new API
564 m
565 end
566
6ba94460 » José Valim and Mikel Lindsaar
2010-01-23 Make implicit and explicit templates pass through the same part creat…
567 protected
568
9dd65c36 » José Valim and Mikel Lindsaar
2010-01-26 Make defaults accept a hash.
569 def set_content_type(m, user_content_type, class_default)
74a5889a » José Valim and Mikel Lindsaar
2010-01-26 Refactor content type setting, added tests to ensure boundary exists …
570 params = m.content_type_parameters || {}
571 case
572 when user_content_type.present?
573 user_content_type
574 when m.has_attachments?
575 ["multipart", "mixed", params]
576 when m.multipart?
577 ["multipart", "alternative", params]
578 else
b6b3db67 » mikel
2010-01-28 Fixed bug on HTML only emails getting set to text/plain
579 m.content_type || class_default
74a5889a » José Valim and Mikel Lindsaar
2010-01-26 Refactor content type setting, added tests to ensure boundary exists …
580 end
581 end
582
9dd65c36 » José Valim and Mikel Lindsaar
2010-01-26 Make defaults accept a hash.
583 def default_i18n_subject #:nodoc:
5c3ef8c1 » José Valim and Mikel Lindsaar
2010-01-23 Refactor subject with i18n.
584 mailer_scope = self.class.mailer_name.gsub('/', '.')
9dd65c36 » José Valim and Mikel Lindsaar
2010-01-26 Make defaults accept a hash.
585 I18n.t(:subject, :scope => [:actionmailer, mailer_scope, action_name], :default => action_name.humanize)
5c3ef8c1 » José Valim and Mikel Lindsaar
2010-01-23 Refactor subject with i18n.
586 end
587
39a1b06f » José Valim and Mikel Lindsaar
2010-01-26 Deprecate old defaults API.
588 def collect_responses_and_parts_order(headers) #:nodoc:
589 responses, parts_order = [], nil
7409b734 » José Valim and Mikel Lindsaar
2010-01-24 Some refactoring.
590
591 if block_given?
a09e9925 » josevalim
2010-03-27 Ensure details are frozen after @details_keys lookup. The implementat…
592 collector = ActionMailer::Collector.new(lookup_context) { render(action_name) }
7409b734 » José Valim and Mikel Lindsaar
2010-01-24 Some refactoring.
593 yield(collector)
39a1b06f » José Valim and Mikel Lindsaar
2010-01-26 Deprecate old defaults API.
594 parts_order = collector.responses.map { |r| r[:content_type] }
7409b734 » José Valim and Mikel Lindsaar
2010-01-24 Some refactoring.
595 responses = collector.responses
596 elsif headers[:body]
597 responses << {
be35a151 » josevalim
2010-02-19 Allow to choose the template path and template name used in implicit …
598 :body => headers.delete(:body),
452bb1e4 » jeremy
2010-01-27 Rename 'defaults' class method to 'default' to reflect that it's a de…
599 :content_type => self.class.default[:content_type] || "text/plain"
7409b734 » José Valim and Mikel Lindsaar
2010-01-24 Some refactoring.
600 }
601 else
be35a151 » josevalim
2010-02-19 Allow to choose the template path and template name used in implicit …
602 templates_path = headers.delete(:template_path) || self.class.mailer_name
603 templates_name = headers.delete(:template_name) || action_name
604
605 each_template(templates_path, templates_name) do |template|
f28d856c » josevalim
2010-03-19 Improve performance of the rendering stack by freezing formats as a s…
606 self.formats = template.formats
607
7409b734 » José Valim and Mikel Lindsaar
2010-01-24 Some refactoring.
608 responses << {
2a126868 » josevalim
2010-03-12 Allow anything that responds to render to be given as :template and u…
609 :body => render(:template => template),
7409b734 » José Valim and Mikel Lindsaar
2010-01-24 Some refactoring.
610 :content_type => template.mime_type.to_s
611 }
612 end
613 end
614
39a1b06f » José Valim and Mikel Lindsaar
2010-01-26 Deprecate old defaults API.
615 [responses, parts_order]
7409b734 » José Valim and Mikel Lindsaar
2010-01-24 Some refactoring.
616 end
617
be35a151 » josevalim
2010-02-19 Allow to choose the template path and template name used in implicit …
618 def each_template(paths, name, &block) #:nodoc:
41af6d9a » jeremy
2010-03-17 Use Array.wrap not Array()
619 Array.wrap(paths).each do |path|
36eb1a68 » josevalim
2010-03-08 Bring AM up to date with new rendering stack.
620 templates = lookup_context.find_all(name, path)
00d6271d » josevalim
2010-03-09 Clean up the API required from ActionView::Template.
621 templates = templates.uniq_by { |t| t.formats }
0ece244f » José Valim and Mikel Lindsaar
2010-01-24 Ensure implicit multipart templates with locale works as expected.
622
36eb1a68 » josevalim
2010-03-08 Bring AM up to date with new rendering stack.
623 unless templates.empty?
624 templates.each(&block)
625 return
99f960a3 » José Valim and Mikel Lindsaar
2010-01-24 Handle some TODOs and deprecations.
626 end
627 end
628 end
629
b5f9a9fc » josevalim
2010-04-12 Move set_fields! to the old API module.
630 def create_parts_from_responses(m, responses) #:nodoc:
6ba94460 » José Valim and Mikel Lindsaar
2010-01-23 Make implicit and explicit templates pass through the same part creat…
631 if responses.size == 1 && !m.has_attachments?
9dd65c36 » José Valim and Mikel Lindsaar
2010-01-26 Make defaults accept a hash.
632 responses[0].each { |k,v| m[k] = v }
74a5889a » José Valim and Mikel Lindsaar
2010-01-26 Refactor content type setting, added tests to ensure boundary exists …
633 elsif responses.size > 1 && m.has_attachments?
6ba94460 » José Valim and Mikel Lindsaar
2010-01-23 Make implicit and explicit templates pass through the same part creat…
634 container = Mail::Part.new
74a5889a » José Valim and Mikel Lindsaar
2010-01-26 Refactor content type setting, added tests to ensure boundary exists …
635 container.content_type = "multipart/alternative"
b5f9a9fc » josevalim
2010-04-12 Move set_fields! to the old API module.
636 responses.each { |r| insert_part(container, r, m.charset) }
6ba94460 » José Valim and Mikel Lindsaar
2010-01-23 Make implicit and explicit templates pass through the same part creat…
637 m.add_part(container)
638 else
b5f9a9fc » josevalim
2010-04-12 Move set_fields! to the old API module.
639 responses.each { |r| insert_part(m, r, m.charset) }
6ba94460 » José Valim and Mikel Lindsaar
2010-01-23 Make implicit and explicit templates pass through the same part creat…
640 end
359caef3 » jamis
2005-05-29 A very thorough refactoring, resulting in new mail property setters a…
641 end
642
6ba94460 » José Valim and Mikel Lindsaar
2010-01-23 Make implicit and explicit templates pass through the same part creat…
643 def insert_part(container, response, charset) #:nodoc:
644 response[:charset] ||= charset
645 part = Mail::Part.new(response)
646 container.add_part(part)
359caef3 » jamis
2005-05-29 A very thorough refactoring, resulting in new mail property setters a…
647 end
3fad0cd0 » dhh
2005-02-19 Added support for charsets for both subject and body. The default cha…
648
ef5dadaf » nex3
2010-04-27 Only run load hooks once a file has been fully loaded.
649 ActiveSupport.run_load_hooks(:action_mailer, self)
db045dbb » dhh
2004-11-24 Initial
650 end
651 end
Something went wrong with that request. Please try again.