Skip to content
Newer
Older
100644 607 lines (565 sloc) 25.5 KB
616ebb8 @josevalim Remove unused code paths and require mail only when it's needed.
josevalim authored Dec 28, 2009
1 require 'mail'
a288082 @mikel Adding :transfer_encoding -> :content_transfer_encoding as part of Tm…
mikel authored Dec 30, 2009
2 require 'action_mailer/tmail_compat'
c985a0e Add some tests to collector with templates and any.
José Valim and Mikel Lindsaar authored Jan 23, 2010
3 require 'action_mailer/collector'
a63caa4 Get tests to run (with failures) without old base around
Yehuda Katz + Carl Lerche authored Jun 15, 2009
4
c4590d5 @dhh Fixed docs
dhh authored Mar 28, 2006
5 module ActionMailer #:nodoc:
98dc582 @lifo Merge docrails.
lifo authored May 25, 2008
6 # Action Mailer allows you to send email from your application using a mailer model and views.
db045db @dhh Initial
dhh authored Nov 24, 2004
7 #
0a407bc ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, …
Marcel Molina authored May 10, 2006
8 # = Mailer Models
20bd4bd @dhh Updated docs and otherwise
dhh authored Sep 2, 2006
9 #
98dc582 @lifo Merge docrails.
lifo authored May 25, 2008
10 # 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
11 #
0a407bc ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, …
Marcel Molina authored May 10, 2006
12 # $ script/generate mailer Notifier
13 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
14 # The generated model inherits from ActionMailer::Base. Emails are defined by creating methods
15 # within the model which are then used to set variables to be used in the mail template, to
16 # change options on the mail, or to add attachments.
0a407bc ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, …
Marcel Molina authored May 10, 2006
17 #
18 # Examples:
19 #
20 # class Notifier < ActionMailer::Base
452bb1e @jeremy Rename 'defaults' class method to 'default' to reflect that it's a de…
jeremy authored Jan 27, 2010
21 # default :from => 'no-reply@example.com',
22 # :return_path => 'system@example.com'
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
23 #
24 # def welcome(recipient)
25 # @account = recipient
6589976 Remove old files, add some information to docs and improve test suite.
José Valim and Mikel Lindsaar authored Jan 26, 2010
26 # mail(:to => recipient.email_address_with_name,
27 # :bcc => ["bcc@example.com", "Order Watcher <watcher@example.com>"])
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
28 # end
0a407bc ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, …
Marcel Molina authored May 10, 2006
29 # end
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
30 #
31 # Within the mailer method, you have access to the following methods:
32 #
33 # * <tt>attachments[]=</tt> - Allows you to add attachments to your email in an intuitive
34 # 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
35 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
36 # * <tt>headers[]=</tt> - Allows you to specify non standard headers in your email such
37 # as <tt>headers['X-No-Spam'] = 'True'</tt>
6589976 Remove old files, add some information to docs and improve test suite.
José Valim and Mikel Lindsaar authored Jan 26, 2010
38 #
9520166 @mikel Fixed up being able to pass random headers in with headers, or mail. …
mikel authored Jan 27, 2010
39 # * <tt>headers(hash)</tt> - Allows you to specify multiple headers in your email such
40 # as <tt>headers({'X-No-Spam' => 'True', 'In-Reply-To' => '1234@message.id'})</tt>
41 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
42 # * <tt>mail</tt> - Allows you to specify your email to send.
43 #
9520166 @mikel Fixed up being able to pass random headers in with headers, or mail. …
mikel authored Jan 26, 2010
44 # The hash passed to the mail method allows you to specify any header that a Mail::Message
45 # will accept (any valid Email header including optional fields). Obviously if you specify
46 # the same header in the headers method and then again in the mail method, the last one
47 # will over write the first, unless you are specifying a header field that can appear more
48 # than once per RFC, in which case, both will be inserted (X-value headers for example can
49 # appear multiple times.)
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
50 #
51 # The mail method, if not passed a block, will inspect your views and send all the views with
52 # the same name as the method, so the above action would send the +welcome.plain.erb+ view file
74a5889 Refactor content type setting, added tests to ensure boundary exists …
José Valim and Mikel Lindsaar authored Jan 26, 2010
53 # as well as the +welcome.html.erb+ view file in a +multipart/alternative+ email.
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
54 #
55 # If you want to explicitly render only certain templates, pass a block:
56 #
57 # mail(:to => user.emai) do |format|
58 # format.text
59 # format.html
60 # end
20bd4bd @dhh Updated docs and otherwise
dhh authored Sep 2, 2006
61 #
6589976 Remove old files, add some information to docs and improve test suite.
José Valim and Mikel Lindsaar authored Jan 26, 2010
62 # The block syntax is useful if also need to specify information specific to a part:
63 #
64 # mail(:to => user.emai) do |format|
65 # format.text(:content_transfer_encoding => "base64")
66 # format.html
67 # end
68 #
69 # Or even to renderize a special view:
70 #
71 # mail(:to => user.emai) do |format|
72 # format.text
73 # format.html { render "some_other_template" }
74 # end
75 #
20bd4bd @dhh Updated docs and otherwise
dhh authored Sep 2, 2006
76 # = Mailer views
77 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
78 # Like Action Controller, each mailer class has a corresponding view directory in which each
79 # method of the class looks for a template with its name.
80 #
81 # To define a template to be used with a mailing, create an <tt>.erb</tt> file with the same
82 # name as the method in your mailer model. For example, in the mailer defined above, the template at
83 # <tt>app/views/notifier/signup_notification.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
84 #
85 # Variables defined in the model are accessible as instance variables in the view.
86 #
87 # Emails by default are sent in plain text, so a sample view for our model example might look like this:
88 #
89 # Hi <%= @account.name %>,
90 # Thanks for joining our service! Please check back often.
91 #
20bd4bd @dhh Updated docs and otherwise
dhh authored Sep 2, 2006
92 # You can even use Action Pack helpers in these views. For example:
93 #
94 # You got a new note!
ee70d1b @josevalim adv_attr_accessors in ActionMailer are not sent to the views, use the…
josevalim authored Dec 25, 2009
95 # <%= truncate(@note.body, 25) %>
96 #
6589976 Remove old files, add some information to docs and improve test suite.
José Valim and Mikel Lindsaar authored Jan 26, 2010
97 # 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
98 #
6589976 Remove old files, add some information to docs and improve test suite.
José Valim and Mikel Lindsaar authored Jan 26, 2010
99 # You got a new note from <%= message.from %>!
ee70d1b @josevalim adv_attr_accessors in ActionMailer are not sent to the views, use the…
josevalim authored Dec 25, 2009
100 # <%= truncate(@note.body, 25) %>
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Infl…
josh authored May 14, 2008
101 #
20bd4bd @dhh Updated docs and otherwise
dhh authored Sep 2, 2006
102 #
4809dcc * Remove default_url_options from mailer generator
Cody Fauser authored Apr 21, 2008
103 # = Generating URLs
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Infl…
josh authored May 14, 2008
104 #
4809dcc * Remove default_url_options from mailer generator
Cody Fauser authored Apr 21, 2008
105 # URLs can be generated in mailer views using <tt>url_for</tt> or named routes.
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Infl…
josh authored May 14, 2008
106 # Unlike controllers from Action Pack, the mailer instance doesn't have any context about the incoming request,
107 # so you'll need to provide all of the details needed to generate a URL.
20bd4bd @dhh Updated docs and otherwise
dhh authored Sep 2, 2006
108 #
4809dcc * Remove default_url_options from mailer generator
Cody Fauser authored Apr 21, 2008
109 # 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
110 #
4809dcc * Remove default_url_options from mailer generator
Cody Fauser authored Apr 21, 2008
111 # <%= url_for(:host => "example.com", :controller => "welcome", :action => "greeting") %>
20bd4bd @dhh Updated docs and otherwise
dhh authored Sep 2, 2006
112 #
4809dcc * Remove default_url_options from mailer generator
Cody Fauser authored Apr 21, 2008
113 # 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
114 #
4809dcc * Remove default_url_options from mailer generator
Cody Fauser authored Apr 21, 2008
115 # <%= users_url(:host => "example.com") %>
116 #
117 # You will want to avoid using the <tt>name_of_route_path</tt> form of named routes because it doesn't make sense to
118 # generate relative URLs in email messages.
119 #
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Infl…
josh authored May 14, 2008
120 # It is also possible to set a default host that will be used in all mailers by setting the <tt>:host</tt> option in
4809dcc * Remove default_url_options from mailer generator
Cody Fauser authored Apr 21, 2008
121 # the <tt>ActionMailer::Base.default_url_options</tt> hash as follows:
122 #
123 # ActionMailer::Base.default_url_options[:host] = "example.com"
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Infl…
josh authored May 14, 2008
124 #
dc4eec1 @lifo Merge docrails:
lifo authored May 9, 2008
125 # This can also be set as a configuration option in <tt>config/environment.rb</tt>:
4809dcc * Remove default_url_options from mailer generator
Cody Fauser authored Apr 21, 2008
126 #
127 # config.action_mailer.default_url_options = { :host => "example.com" }
20bd4bd @dhh Updated docs and otherwise
dhh authored Sep 2, 2006
128 #
4809dcc * Remove default_url_options from mailer generator
Cody Fauser authored Apr 21, 2008
129 # If you do decide to set a default <tt>:host</tt> for your mailers you will want to use the
130 # <tt>:only_path => false</tt> option when using <tt>url_for</tt>. This will ensure that absolute URLs are generated because
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Infl…
josh authored May 14, 2008
131 # the <tt>url_for</tt> view helper will, by default, generate relative URLs when a <tt>:host</tt> option isn't
4809dcc * Remove default_url_options from mailer generator
Cody Fauser authored Apr 21, 2008
132 # explicitly provided.
20bd4bd @dhh Updated docs and otherwise
dhh authored Sep 2, 2006
133 #
134 # = Sending mail
135 #
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Infl…
josh authored May 14, 2008
136 # Once a mailer action and template are defined, you can deliver your message or create it and save it
0a407bc ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, …
Marcel Molina authored May 10, 2006
137 # for delivery later:
138 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
139 # Notifier.welcome(david).deliver # sends the email
140 # mail = Notifier.welcome(david) # => a Mail::Message object
141 # mail.deliver # sends the email
0a407bc ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, …
Marcel Molina authored May 10, 2006
142 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
143 # You never instantiate your mailer class. Rather, you just call the method on the class itself.
20bd4bd @dhh Updated docs and otherwise
dhh authored Sep 2, 2006
144 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
145 # = Multipart Emails
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Infl…
josh authored May 14, 2008
146 #
98dc582 @lifo Merge docrails.
lifo authored May 25, 2008
147 # Multipart messages can also be used implicitly because Action Mailer will automatically
0a407bc ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, …
Marcel Molina authored May 10, 2006
148 # detect and use multipart templates, where each template is named after the name of the action, followed
149 # by the content type. Each such detected template will be added as separate part to the message.
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Infl…
josh authored May 14, 2008
150 #
0a407bc ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, …
Marcel Molina authored May 10, 2006
151 # For example, if the following templates existed:
21187c0 @dhh Apply the rest of Chads patch
dhh authored Feb 21, 2007
152 # * signup_notification.text.plain.erb
153 # * signup_notification.text.html.erb
154 # * 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
155 # * signup_notification.text.yaml.erb
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Infl…
josh authored May 14, 2008
156 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
157 # Each would be rendered and added as a separate part to the message, with the corresponding content
158 # type. The content type for the entire message is automatically set to <tt>multipart/alternative</tt>,
159 # which indicates that the email contains multiple different representations of the same email
160 # 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
161 #
46f30f9 @lifo Merge documentation changes from docrails.
lifo authored May 16, 2008
162 # Implicit template rendering is not performed if any attachments or parts have been added to the email.
163 # This means that you'll have to manually add each part to the email and set the content type of the email
164 # to <tt>multipart/alternative</tt>.
20bd4bd @dhh Updated docs and otherwise
dhh authored Sep 2, 2006
165 #
0a407bc ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, …
Marcel Molina authored May 10, 2006
166 # = Attachments
20bd4bd @dhh Updated docs and otherwise
dhh authored Sep 2, 2006
167 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
168 # You can see above how to make a multipart HTML / Text email, to send attachments is just
169 # as 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)
173 # attachments['free_book.pdf'] = { :data => File.read('path/to/file.pdf') }
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
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
177 #
178 # Which will (if it had both a <tt>.text.erb</tt> and <tt>.html.erb</tt> tempalte in the view
179 # directory), send a complete <tt>multipart/mixed</tt> email with two parts, the first part being
74a5889 Refactor content type setting, added tests to ensure boundary exists …
José Valim and Mikel Lindsaar authored Jan 26, 2010
180 # a <tt>multipart/alternative</tt> with the text and HTML email parts inside, and the second being
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
181 # a <tt>application/pdf</tt> with a Base64 encoded copy of the file.pdf book with the filename
182 # +free_book.pdf+.
c927aa0 @dhh Updated documentation
dhh authored Dec 16, 2004
183 #
20bd4bd @dhh Updated docs and otherwise
dhh authored Sep 2, 2006
184 #
c927aa0 @dhh Updated documentation
dhh authored Dec 16, 2004
185 # = Configuration options
186 #
187 # These options are specified on the class level, like <tt>ActionMailer::Base.template_root = "/my/templates"</tt>
188 #
452bb1e @jeremy Rename 'defaults' class method to 'default' to reflect that it's a de…
jeremy authored Jan 28, 2010
189 # * <tt>default</tt> - This is a class wide hash of <tt>:key => value</tt> pairs containing
21dcc20 @mikel Fixed up documentation to reflect code change and cleaned up tests of…
mikel authored Jan 27, 2010
190 # default values for the specified header fields of the <tt>Mail::Message</tt>. You can
191 # specify a default for any valid header for <tt>Mail::Message</tt> and it will be used if
192 # you do not override it. The defaults set by Action Mailer are:
193 # * <tt>:mime_version => "1.0"</tt>
194 # * <tt>:charset => "utf-8",</tt>
195 # * <tt>:content_type => "text/plain",</tt>
196 # * <tt>:parts_order => [ "text/plain", "text/enriched", "text/html" ]</tt>
c927aa0 @dhh Updated documentation
dhh authored Dec 16, 2004
197 #
198 # * <tt>logger</tt> - the logger is used for generating information on the mailing run if available.
199 # Can be set to nil for no logging. Compatible with both Ruby's own Logger and Log4r loggers.
200 #
64092de @fxn Improve documentation coverage and markup
fxn authored May 2, 2008
201 # * <tt>smtp_settings</tt> - Allows detailed configuration for <tt>:smtp</tt> delivery method:
dc4eec1 @lifo Merge docrails:
lifo authored May 9, 2008
202 # * <tt>:address</tt> - Allows you to use a remote mail server. Just change it from its default "localhost" setting.
203 # * <tt>:port</tt> - On the off chance that your mail server doesn't run on port 25, you can change it.
204 # * <tt>:domain</tt> - If you need to specify a HELO domain, you can do it here.
205 # * <tt>:user_name</tt> - If your mail server requires authentication, set the username in this setting.
206 # * <tt>:password</tt> - If your mail server requires authentication, set the password in this setting.
b2504f8 @josh Tidy up ActionMailer rendering logic to take advantage of view path c…
josh authored Aug 6, 2008
207 # * <tt>:authentication</tt> - If your mail server requires authentication, you need to specify the authentication type here.
46f30f9 @lifo Merge documentation changes from docrails.
lifo authored May 16, 2008
208 # This is a symbol and one of <tt>:plain</tt>, <tt>:login</tt>, <tt>:cram_md5</tt>.
c2e7851 @josevalim Add ActionMailer::Base#enable_starttls_auto option for enabling/disab…
josevalim authored Jan 11, 2009
209 # * <tt>:enable_starttls_auto</tt> - When set to true, detects if STARTTLS is enabled in your SMTP server and starts to use it.
210 # It works only on Ruby >= 1.8.7 and Ruby >= 1.9. Default is true.
c927aa0 @dhh Updated documentation
dhh authored Dec 16, 2004
211 #
46f30f9 @lifo Merge documentation changes from docrails.
lifo authored May 16, 2008
212 # * <tt>sendmail_settings</tt> - Allows you to override options for the <tt>:sendmail</tt> delivery method.
213 # * <tt>:location</tt> - The location of the sendmail executable. Defaults to <tt>/usr/sbin/sendmail</tt>.
214 # * <tt>:arguments</tt> - The command line arguments. Defaults to <tt>-i -t</tt>.
dc4eec1 @lifo Merge docrails:
lifo authored May 9, 2008
215 #
fbe6c3c @edavis10 Adds a :file delivery_method to save email to a file on disk
edavis10 authored Aug 7, 2009
216 # * <tt>file_settings</tt> - Allows you to override options for the <tt>:file</tt> delivery method.
217 # * <tt>:location</tt> - The directory into which emails will be written. Defaults to the application <tt>tmp/mails</tt>.
218 #
dc4eec1 @lifo Merge docrails:
lifo authored May 9, 2008
219 # * <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
220 #
fbe6c3c @edavis10 Adds a :file delivery_method to save email to a file on disk
edavis10 authored Aug 8, 2009
221 # * <tt>delivery_method</tt> - Defines a delivery method. Possible values are <tt>:smtp</tt> (default), <tt>:sendmail</tt>, <tt>:test</tt>,
f4f7677 @matthewrudy abstract all of the ActionMailer delivery methods into their own clas…
matthewrudy authored Oct 28, 2009
222 # and <tt>:file</tt>. Or you may provide a custom delivery method object eg. MyOwnDeliveryMethodClass.new
c927aa0 @dhh Updated documentation
dhh authored Dec 16, 2004
223 #
dc4eec1 @lifo Merge docrails:
lifo authored May 9, 2008
224 # * <tt>perform_deliveries</tt> - Determines whether <tt>deliver_*</tt> methods are actually carried out. By default they are,
c927aa0 @dhh Updated documentation
dhh authored Dec 16, 2004
225 # but this can be turned off to help functional testing.
226 #
64092de @fxn Improve documentation coverage and markup
fxn authored May 2, 2008
227 # * <tt>deliveries</tt> - Keeps an array of all the emails sent out through the Action Mailer with <tt>delivery_method :test</tt>. Most useful
c927aa0 @dhh Updated documentation
dhh authored Dec 16, 2004
228 # for unit and functional testing.
af56c80 @dhh Updated documentation
dhh authored Feb 24, 2005
229 #
452bb1e @jeremy Rename 'defaults' class method to 'default' to reflect that it's a de…
jeremy authored Jan 28, 2010
230 # * <tt>default_charset</tt> - This is now deprecated, use the +default+ method above to
21dcc20 @mikel Fixed up documentation to reflect code change and cleaned up tests of…
mikel authored Jan 26, 2010
231 # set the default +:charset+.
c2e7851 @josevalim Add ActionMailer::Base#enable_starttls_auto option for enabling/disab…
josevalim authored Jan 11, 2009
232 #
452bb1e @jeremy Rename 'defaults' class method to 'default' to reflect that it's a de…
jeremy authored Jan 28, 2010
233 # * <tt>default_content_type</tt> - This is now deprecated, use the +default+ method above
21dcc20 @mikel Fixed up documentation to reflect code change and cleaned up tests of…
mikel authored Jan 26, 2010
234 # to set the default +:content_type+.
c2e7851 @josevalim Add ActionMailer::Base#enable_starttls_auto option for enabling/disab…
josevalim authored Jan 11, 2009
235 #
452bb1e @jeremy Rename 'defaults' class method to 'default' to reflect that it's a de…
jeremy authored Jan 28, 2010
236 # * <tt>default_mime_version</tt> - This is now deprecated, use the +default+ method above
21dcc20 @mikel Fixed up documentation to reflect code change and cleaned up tests of…
mikel authored Jan 26, 2010
237 # to set the default +:mime_version+.
c2e7851 @josevalim Add ActionMailer::Base#enable_starttls_auto option for enabling/disab…
josevalim authored Jan 11, 2009
238 #
452bb1e @jeremy Rename 'defaults' class method to 'default' to reflect that it's a de…
jeremy authored Jan 28, 2010
239 # * <tt>default_implicit_parts_order</tt> - This is now deprecated, use the +default+ method above
21dcc20 @mikel Fixed up documentation to reflect code change and cleaned up tests of…
mikel authored Jan 26, 2010
240 # to set the default +:parts_order+. Parts Order is used when a message is built implicitly
241 # (i.e. multiple parts are assembled from templates which specify the content type in their
242 # filenames) this variable controls how the parts are ordered.
4964d3b @josevalim Make ActionMailer::Base inherit from AbstractController::Base
josevalim authored Dec 22, 2009
243 class Base < AbstractController::Base
0d931fe Finish cleaning up delivery methods implementation.
José Valim and Mikel Lindsaar authored Jan 24, 2010
244 include DeliveryMethods, Quoting
f30d73b Add new class delivery method API.
José Valim and Mikel Lindsaar authored Jan 24, 2010
245 abstract!
246
c03c40b @josevalim Expose a _render_partial hook as thhe _render_template one and make u…
josevalim authored Dec 31, 2009
247 include AbstractController::Logger
83f4d86 @dhh Rename the RenderingController module to just plain Rendering
dhh authored Dec 20, 2009
248 include AbstractController::Rendering
976c264 @josevalim Extracted localized_cache.rb from ActionController, added it to Abstr…
josevalim authored Oct 28, 2009
249 include AbstractController::LocalizedCache
a9751a7 @josevalim Refactor ActionMailer layout and remove legacy one.
josevalim authored Oct 17, 2009
250 include AbstractController::Layouts
684c2dc @josevalim Remove ActionMailer helpers and rely on AbstractController one.
josevalim authored Oct 18, 2009
251 include AbstractController::Helpers
48a3985 @josevalim Also include translation in ActionMailer.
josevalim authored Jan 26, 2010
252 include AbstractController::Translation
0e063f4 @josevalim Fix some backward incompatible behavior on AM.
josevalim authored Jan 30, 2010
253 include AbstractController::Compatibility
359caef @jamis A very thorough refactoring, resulting in new mail property setters a…
jamis authored May 29, 2005
254
ee70d1b @josevalim adv_attr_accessors in ActionMailer are not sent to the views, use the…
josevalim authored Dec 25, 2009
255 helper ActionMailer::MailHelper
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored Jan 24, 2010
256
5dead5b Maintain old_api and deprecated_api in different files.
José Valim and Mikel Lindsaar authored Jan 24, 2010
257 include ActionMailer::OldApi
f30d73b Add new class delivery method API.
José Valim and Mikel Lindsaar authored Jan 24, 2010
258 include ActionMailer::DeprecatedApi
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored Jan 24, 2010
259
c927aa0 @dhh Updated documentation
dhh authored Dec 16, 2004
260 private_class_method :new #:nodoc:
db045db @dhh Initial
dhh authored Nov 24, 2004
261
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored Jan 26, 2010
262 extlib_inheritable_accessor :default_params
263 self.default_params = {
264 :mime_version => "1.0",
265 :charset => "utf-8",
266 :content_type => "text/plain",
267 :parts_order => [ "text/plain", "text/enriched", "text/html" ]
268 }
e1c1318 Added delivers_from.
José Valim and Mikel Lindsaar authored Jan 25, 2010
269
eda1719 @jamis ActionMailer::Base.deliver(email) had been accidentally removed, but …
jamis authored Jul 31, 2005
270 class << self
0b05acd @mikel Implementing class level :defaults hash, instead of delivers_from et al
mikel authored Jan 26, 2010
271
bd5ed65 @technoweenie Update ActionMailer so it treats ActionView the same way that ActionC…
technoweenie authored Nov 26, 2007
272 def mailer_name
273 @mailer_name ||= name.underscore
274 end
0750304 @mikel Migrated over to Mail doing delivery.
mikel authored Jan 16, 2010
275 attr_writer :mailer_name
276 alias :controller_path :mailer_name
81c416b @josevalim More refactoring on ActionMailer::Base.
josevalim authored Oct 28, 2009
277
452bb1e @jeremy Rename 'defaults' class method to 'default' to reflect that it's a de…
jeremy authored Jan 28, 2010
278 def default(value=nil)
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored Jan 26, 2010
279 self.default_params.merge!(value) if value
280 self.default_params
281 end
282
59f1df1 @jamis Update/extend ActionMailer documentation (rdoc)
jamis authored Oct 16, 2005
283 # Receives a raw email, parses it into an email object, decodes it,
284 # instantiates a new mailer, and passes the email object to the mailer
98dc582 @lifo Merge docrails.
lifo authored May 25, 2008
285 # object's +receive+ method. If you want your mailer to be able to
286 # process incoming messages, you'll need to implement a +receive+
59f1df1 @jamis Update/extend ActionMailer documentation (rdoc)
jamis authored Oct 16, 2005
287 # method that accepts the email object as a parameter:
288 #
289 # class MyMailer < ActionMailer::Base
290 # def receive(mail)
291 # ...
292 # end
293 # end
704daad @josevalim Ensure we just send Ruby Stdlib objects in ActionMailer notifications.
josevalim authored Jan 15, 2010
294 def receive(raw_mail)
295 ActiveSupport::Notifications.instrument("action_mailer.receive") do |payload|
296 mail = Mail.new(raw_mail)
297 set_payload_for_mail(payload, mail)
2a6bc12 @josevalim Add subscriber to ActionMailer.
josevalim authored Jan 13, 2010
298 new.receive(mail)
299 end
eda1719 @jamis ActionMailer::Base.deliver(email) had been accidentally removed, but …
jamis authored Jul 31, 2005
300 end
301
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
302 # Delivers a mail object. This is actually called by the <tt>Mail::Message</tt> object
303 # itself through a call back when you call <tt>:deliver</tt> on the Mail::Message,
304 # calling +deliver_mail+ directly and passing an Mail::Message will do nothing.
e4a989e Added delivery_handler method to mail and implemented in ActionMailer…
José Valim and Mikel Lindsaar authored Jan 25, 2010
305 def deliver_mail(mail) #:nodoc:
99f960a Handle some TODOs and deprecations.
José Valim and Mikel Lindsaar authored Jan 24, 2010
306 ActiveSupport::Notifications.instrument("action_mailer.deliver") do |payload|
258ca14 Delegated ActionMailer::Base.deliveries to Mail.deliveries, added cal…
José Valim and Mikel Lindsaar authored Jan 24, 2010
307 self.set_payload_for_mail(payload, mail)
ace7497 Got AM working with Mail yield on delivery_handler and updated tests
José Valim and Mikel Lindsaar authored Jan 25, 2010
308 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
309 end
310 end
311
99f960a Handle some TODOs and deprecations.
José Valim and Mikel Lindsaar authored Jan 24, 2010
312 def respond_to?(method, *args) #:nodoc:
313 super || action_methods.include?(method.to_s)
314 end
315
316 protected
317
704daad @josevalim Ensure we just send Ruby Stdlib objects in ActionMailer notifications.
josevalim authored Jan 15, 2010
318 def set_payload_for_mail(payload, mail) #:nodoc:
99f960a Handle some TODOs and deprecations.
José Valim and Mikel Lindsaar authored Jan 24, 2010
319 payload[:mailer] = self.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
320 payload[:message_id] = mail.message_id
321 payload[:subject] = mail.subject
322 payload[:to] = mail.to
323 payload[:from] = mail.from
324 payload[:bcc] = mail.bcc if mail.bcc.present?
325 payload[:cc] = mail.cc if mail.cc.present?
326 payload[:date] = mail.date
327 payload[:mail] = mail.encoded
704daad @josevalim Ensure we just send Ruby Stdlib objects in ActionMailer notifications.
josevalim authored Jan 15, 2010
328 end
f30d73b Add new class delivery method API.
José Valim and Mikel Lindsaar authored Jan 24, 2010
329
99f960a Handle some TODOs and deprecations.
José Valim and Mikel Lindsaar authored Jan 24, 2010
330 def method_missing(method, *args) #:nodoc:
f30d73b Add new class delivery method API.
José Valim and Mikel Lindsaar authored Jan 24, 2010
331 if action_methods.include?(method.to_s)
332 new(method, *args).message
333 else
334 super
335 end
336 end
eda1719 @jamis ActionMailer::Base.deliver(email) had been accidentally removed, but …
jamis authored Jul 31, 2005
337 end
338
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored Jan 24, 2010
339 attr_internal :message
340
6ba9446 Make implicit and explicit templates pass through the same part creat…
José Valim and Mikel Lindsaar authored Jan 23, 2010
341 # Instantiate a new mailer object. If +method_name+ is not +nil+, the mailer
342 # will be initialized according to the named method. If not, the mailer will
343 # remain uninitialized (useful when you only need to invoke the "receive"
344 # method, for instance).
345 def initialize(method_name=nil, *args)
346 super()
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored Jan 24, 2010
347 @_message = Mail.new
6ba9446 Make implicit and explicit templates pass through the same part creat…
José Valim and Mikel Lindsaar authored Jan 23, 2010
348 process(method_name, *args) if method_name
349 end
350
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
351 # Allows you to pass random and unusual headers to the new +Mail::Message+ object
352 # which will add them to itself.
353 #
354 # headers['X-Special-Domain-Specific-Header'] = "SecretValue"
355 #
9520166 @mikel Fixed up being able to pass random headers in with headers, or mail. …
mikel authored Jan 26, 2010
356 # You can also pass a hash into headers of header field names and values, which
357 # will then be set on the Mail::Message object:
358 #
05c4ad9 Tidy up tests and docs.
José Valim and Mikel Lindsaar authored Jan 26, 2010
359 # headers 'X-Special-Domain-Specific-Header' => "SecretValue",
360 # 'In-Reply-To' => incoming.message_id
9520166 @mikel Fixed up being able to pass random headers in with headers, or mail. …
mikel authored Jan 26, 2010
361 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
362 # The resulting Mail::Message will have the following in it's header:
363 #
364 # X-Special-Domain-Specific-Header: SecretValue
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored Jan 24, 2010
365 def headers(args=nil)
366 if args
9520166 @mikel Fixed up being able to pass random headers in with headers, or mail. …
mikel authored Jan 26, 2010
367 @_message.headers(args)
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored Jan 24, 2010
368 else
369 @_message
370 end
371 end
c34cfcc @mikel Created mail method for new API
mikel authored Jan 20, 2010
372
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
373 # Allows you to add attachments to an email, like so:
374 #
375 # mail.attachments['filename.jpg'] = File.read('/path/to/filename.jpg')
376 #
377 # If you do this, then Mail will take the file name and work out the mime type
378 # set the Content-Type, Content-Disposition, Content-Transfer-Encoding and
379 # base64 encode the contents of the attachment all for you.
380 #
381 # You can also specify overrides if you want by passing a hash instead of a string:
382 #
383 # mail.attachments['filename.jpg'] = {:mime_type => 'application/x-gzip',
384 # :content => File.read('/path/to/filename.jpg')}
385 #
386 # If you want to use a different encoding than Base64, you can pass an encoding in,
387 # but then it is up to you to pass in the content pre-encoded, and don't expect
388 # Mail to know how to decode this data:
389 #
390 # file_content = SpecialEncode(File.read('/path/to/filename.jpg'))
391 # mail.attachments['filename.jpg'] = {:mime_type => 'application/x-gzip',
392 # :encoding => 'SpecialEncoding',
393 # :content => file_content }
394 #
395 # You can also search for specific attachments:
396 #
397 # # By Filename
398 # mail.attachments['filename.jpg'] #=> Mail::Part object or nil
399 #
400 # # or by index
401 # mail.attachments[0] #=> Mail::Part (first attachment)
402 #
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored Jan 24, 2010
403 def attachments
404 @_message.attachments
405 end
dcb9253 Add basic template rendering to new DSL.
José Valim and Mikel Lindsaar authored Jan 22, 2010
406
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
407 # The main method that creates the message and renders the email templates. There are
408 # two ways to call this method, with a block, or without a block.
409 #
6589976 Remove old files, add some information to docs and improve test suite.
José Valim and Mikel Lindsaar authored Jan 26, 2010
410 # Both methods accept a headers hash. This hash allows you to specify the most used headers
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
411 # in an email message, these are:
412 #
413 # * <tt>:subject</tt> - The subject of the message, if this is omitted, ActionMailer will
414 # ask the Rails I18n class for a translated <tt>:subject</tt> in the scope of
415 # <tt>[:actionmailer, mailer_scope, action_name]</tt> or if this is missing, will translate the
416 # humanized version of the <tt>action_name</tt>
417 # * <tt>:to</tt> - Who the message is destined for, can be a string of addresses, or an array
418 # of addresses.
0b05acd @mikel Implementing class level :defaults hash, instead of delivers_from et al
mikel authored Jan 26, 2010
419 # * <tt>:from</tt> - Who the message is from
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
420 # * <tt>:cc</tt> - Who you would like to Carbon-Copy on this email, can be a string of addresses,
421 # or an array of addresses.
422 # * <tt>:bcc</tt> - Who you would like to Blind-Carbon-Copy on this email, can be a string of
423 # addresses, or an array of addresses.
424 # * <tt>:reply_to</tt> - Who to set the Reply-To header of the email to.
425 # * <tt>:date</tt> - The date to say the email was sent on.
426 #
452bb1e @jeremy Rename 'defaults' class method to 'default' to reflect that it's a de…
jeremy authored Jan 28, 2010
427 # You can set default values for any of the above headers (except :date) by using the <tt>default</tt>
0b05acd @mikel Implementing class level :defaults hash, instead of delivers_from et al
mikel authored Jan 26, 2010
428 # class method:
429 #
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored Jan 26, 2010
430 # class Notifier < ActionMailer::Base
452bb1e @jeremy Rename 'defaults' class method to 'default' to reflect that it's a de…
jeremy authored Jan 28, 2010
431 # self.default :from => 'no-reply@test.lindsaar.net',
432 # :bcc => 'email_logger@test.lindsaar.net',
433 # :reply_to => 'bounces@test.lindsaar.net'
0b05acd @mikel Implementing class level :defaults hash, instead of delivers_from et al
mikel authored Jan 26, 2010
434 # end
435 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
436 # If you need other headers not listed above, use the <tt>headers['name'] = value</tt> method.
437 #
6589976 Remove old files, add some information to docs and improve test suite.
José Valim and Mikel Lindsaar authored Jan 26, 2010
438 # When a <tt>:return_path</tt> is specified as header, that value will be used as the 'envelope from'
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
439 # address for the Mail message. Setting this is useful when you want delivery notifications
440 # sent to a different address than the one in <tt>:from</tt>. Mail will actually use the
441 # <tt>:return_path</tt> in preference to the <tt>:sender</tt> in preference to the <tt>:from</tt>
442 # field for the 'envelope from' value.
443 #
444 # If you do not pass a block to the +mail+ method, it will find all templates in the
445 # template path that match the method name that it is being called from, it will then
446 # create parts for each of these templates intelligently, making educated guesses
447 # on correct content type and sequence, and return a fully prepared Mail::Message
448 # ready to call <tt>:deliver</tt> on to send.
449 #
450 # If you do pass a block, you can render specific templates of your choice:
451 #
452 # mail(:to => 'mikel@test.lindsaar.net') do |format|
453 # format.text
454 # format.html
455 # end
456 #
457 # You can even render text directly without using a template:
458 #
459 # mail(:to => 'mikel@test.lindsaar.net') do |format|
460 # format.text { render :text => "Hello Mikel!" }
461 # format.html { render :text => "<h1>Hello Mikel!</h1>" }
462 # end
463 #
74a5889 Refactor content type setting, added tests to ensure boundary exists …
José Valim and Mikel Lindsaar authored Jan 26, 2010
464 # Which will render a <tt>multipart/alternative</tt> email with <tt>text/plain</tt> and
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
465 # <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
466 #
467 # The block syntax also allows you to customize the part headers if desired:
468 #
469 # mail(:to => 'mikel@test.lindsaar.net') do |format|
470 # format.text(:content_transfer_encoding => "base64")
471 # format.html
472 # end
473 #
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored Jan 24, 2010
474 def mail(headers={}, &block)
475 # Guard flag to prevent both the old and the new API from firing
476 # Should be removed when old API is removed
477 @mail_was_called = true
478 m = @_message
258ca14 Delegated ActionMailer::Base.deliveries to Mail.deliveries, added cal…
José Valim and Mikel Lindsaar authored Jan 24, 2010
479
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored Jan 26, 2010
480 # At the beginning, do not consider class default for parts order neither content_type
481 content_type = headers[:content_type]
482 parts_order = headers[:parts_order]
1cd5592 First work on implicit multipart.
José Valim and Mikel Lindsaar authored Jan 22, 2010
483
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored Jan 26, 2010
484 # Merge defaults from class
452bb1e @jeremy Rename 'defaults' class method to 'default' to reflect that it's a de…
jeremy authored Jan 28, 2010
485 headers = headers.reverse_merge(self.class.default)
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored Jan 26, 2010
486 charset = headers[:charset]
0b05acd @mikel Implementing class level :defaults hash, instead of delivers_from et al
mikel authored Jan 26, 2010
487
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored Jan 26, 2010
488 # Quote fields
489 headers[:subject] ||= default_i18n_subject
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored Jan 24, 2010
490 quote_fields!(headers, charset)
951397b Get implicit multipart and attachments working together.
José Valim and Mikel Lindsaar authored Jan 22, 2010
491
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored Jan 24, 2010
492 # Render the templates and blocks
39a1b06 Deprecate old defaults API.
José Valim and Mikel Lindsaar authored Jan 26, 2010
493 responses, explicit_order = collect_responses_and_parts_order(headers, &block)
74a5889 Refactor content type setting, added tests to ensure boundary exists …
José Valim and Mikel Lindsaar authored Jan 26, 2010
494 create_parts_from_responses(m, responses, charset)
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored Jan 24, 2010
495
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored Jan 26, 2010
496 # Finally setup content type and parts order
497 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
498 m.charset = charset
499
e7e4ed4 Set sort order for explicit parts from the collector's template sequence
José Valim and Mikel Lindsaar authored Jan 24, 2010
500 if m.multipart?
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored Jan 26, 2010
501 parts_order ||= explicit_order || headers[:parts_order]
502 m.body.set_sort_order(parts_order)
951397b Get implicit multipart and attachments working together.
José Valim and Mikel Lindsaar authored Jan 22, 2010
503 m.body.sort_parts!
504 end
bb9d71f Move class methods to deprecated stuff.
José Valim and Mikel Lindsaar authored Jan 22, 2010
505
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored Jan 26, 2010
506 # Set configure delivery behavior
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored Jan 24, 2010
507 wrap_delivery_behavior!(headers[:delivery_method])
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored Jan 26, 2010
508
509 # Remove headers already treated and assign all others
510 headers.except!(:subject, :to, :from, :cc, :bcc, :reply_to)
511 headers.except!(:body, :parts_order, :content_type, :charset, :delivery_method)
512 headers.each { |k, v| m[k] = v }
513
c34cfcc @mikel Created mail method for new API
mikel authored Jan 20, 2010
514 m
515 end
516
6ba9446 Make implicit and explicit templates pass through the same part creat…
José Valim and Mikel Lindsaar authored Jan 23, 2010
517 protected
518
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored Jan 26, 2010
519 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
520 params = m.content_type_parameters || {}
521 case
522 when user_content_type.present?
523 user_content_type
524 when m.has_attachments?
525 ["multipart", "mixed", params]
526 when m.multipart?
527 ["multipart", "alternative", params]
528 else
b6b3db6 @mikel Fixed bug on HTML only emails getting set to text/plain
mikel authored Jan 28, 2010
529 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
530 end
531 end
532
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored Jan 26, 2010
533 def default_i18n_subject #:nodoc:
5c3ef8c Refactor subject with i18n.
José Valim and Mikel Lindsaar authored Jan 23, 2010
534 mailer_scope = self.class.mailer_name.gsub('/', '.')
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored Jan 26, 2010
535 I18n.t(:subject, :scope => [:actionmailer, mailer_scope, action_name], :default => action_name.humanize)
5c3ef8c Refactor subject with i18n.
José Valim and Mikel Lindsaar authored Jan 23, 2010
536 end
537
73a9000 Adding failing tests for calling just the action, instead of :create_…
José Valim and Mikel Lindsaar authored Jan 24, 2010
538 # TODO: Move this into Mail
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored Jan 24, 2010
539 def quote_fields!(headers, charset) #:nodoc:
540 m = @_message
541 m.subject ||= quote_if_necessary(headers[:subject], charset) if headers[:subject]
542 m.to ||= quote_address_if_necessary(headers[:to], charset) if headers[:to]
543 m.from ||= quote_address_if_necessary(headers[:from], charset) if headers[:from]
544 m.cc ||= quote_address_if_necessary(headers[:cc], charset) if headers[:cc]
545 m.bcc ||= quote_address_if_necessary(headers[:bcc], charset) if headers[:bcc]
546 m.reply_to ||= quote_address_if_necessary(headers[:reply_to], charset) if headers[:reply_to]
547 end
548
39a1b06 Deprecate old defaults API.
José Valim and Mikel Lindsaar authored Jan 26, 2010
549 def collect_responses_and_parts_order(headers) #:nodoc:
550 responses, parts_order = [], nil
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored Jan 24, 2010
551
552 if block_given?
553 collector = ActionMailer::Collector.new(self) { render(action_name) }
554 yield(collector)
39a1b06 Deprecate old defaults API.
José Valim and Mikel Lindsaar authored Jan 26, 2010
555 parts_order = collector.responses.map { |r| r[:content_type] }
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored Jan 24, 2010
556 responses = collector.responses
557 elsif headers[:body]
558 responses << {
559 :body => headers[:body],
452bb1e @jeremy Rename 'defaults' class method to 'default' to reflect that it's a de…
jeremy authored Jan 28, 2010
560 :content_type => self.class.default[:content_type] || "text/plain"
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored Jan 24, 2010
561 }
562 else
99f960a Handle some TODOs and deprecations.
José Valim and Mikel Lindsaar authored Jan 24, 2010
563 each_template do |template|
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored Jan 24, 2010
564 responses << {
565 :body => render_to_body(:_template => template),
566 :content_type => template.mime_type.to_s
567 }
568 end
569 end
570
39a1b06 Deprecate old defaults API.
José Valim and Mikel Lindsaar authored Jan 26, 2010
571 [responses, parts_order]
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored Jan 24, 2010
572 end
573
99f960a Handle some TODOs and deprecations.
José Valim and Mikel Lindsaar authored Jan 24, 2010
574 def each_template(&block) #:nodoc:
575 self.class.view_paths.each do |load_paths|
576 templates = load_paths.find_all(action_name, {}, self.class.mailer_name)
0ece244 Ensure implicit multipart templates with locale works as expected.
José Valim and Mikel Lindsaar authored Jan 24, 2010
577 templates = templates.uniq_by { |t| t.details[:formats] }
578
99f960a Handle some TODOs and deprecations.
José Valim and Mikel Lindsaar authored Jan 24, 2010
579 unless templates.empty?
580 templates.each(&block)
581 return
582 end
583 end
584 end
585
6ba9446 Make implicit and explicit templates pass through the same part creat…
José Valim and Mikel Lindsaar authored Jan 23, 2010
586 def create_parts_from_responses(m, responses, charset) #:nodoc:
587 if responses.size == 1 && !m.has_attachments?
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored Jan 26, 2010
588 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
589 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
590 container = Mail::Part.new
74a5889 Refactor content type setting, added tests to ensure boundary exists …
José Valim and Mikel Lindsaar authored Jan 26, 2010
591 container.content_type = "multipart/alternative"
6ba9446 Make implicit and explicit templates pass through the same part creat…
José Valim and Mikel Lindsaar authored Jan 23, 2010
592 responses.each { |r| insert_part(container, r, charset) }
593 m.add_part(container)
594 else
595 responses.each { |r| insert_part(m, r, charset) }
596 end
359caef @jamis A very thorough refactoring, resulting in new mail property setters a…
jamis authored May 29, 2005
597 end
598
6ba9446 Make implicit and explicit templates pass through the same part creat…
José Valim and Mikel Lindsaar authored Jan 23, 2010
599 def insert_part(container, response, charset) #:nodoc:
600 response[:charset] ||= charset
601 part = Mail::Part.new(response)
602 container.add_part(part)
359caef @jamis A very thorough refactoring, resulting in new mail property setters a…
jamis authored May 29, 2005
603 end
3fad0cd @dhh Added support for charsets for both subject and body. The default cha…
dhh authored Feb 19, 2005
604
db045db @dhh Initial
dhh authored Nov 24, 2004
605 end
606 end
Something went wrong with that request. Please try again.