Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 704 lines (622 sloc) 28.128 kb
c4590d5 @dhh Fixed docs
dhh authored
1 module ActionMailer #:nodoc:
98dc582 @lifo Merge docrails.
lifo authored
2 # Action Mailer allows you to send email from your application using a mailer model and views.
db045db @dhh Initial
dhh authored
3 #
20bd4bd @dhh Updated docs and otherwise
dhh authored
4 #
0a407bc ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, Mar...
Marcel Molina authored
5 # = Mailer Models
20bd4bd @dhh Updated docs and otherwise
dhh authored
6 #
98dc582 @lifo Merge docrails.
lifo authored
7 # To use Action Mailer, you need to create a mailer model.
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Inflect...
josh authored
8 #
0a407bc ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, Mar...
Marcel Molina authored
9 # $ script/generate mailer Notifier
10 #
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Inflect...
josh authored
11 # The generated model inherits from ActionMailer::Base. Emails are defined by creating methods within the model which are then
12 # used to set variables to be used in the mail template, to change options on the mail, or
0a407bc ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, Mar...
Marcel Molina authored
13 # to add attachments.
14 #
15 # Examples:
16 #
17 # class Notifier < ActionMailer::Base
18 # def signup_notification(recipient)
19 # recipients recipient.email_address_with_name
c3f53f4 @lifo Merge docrails
lifo authored
20 # bcc ["bcc@example.com", "Order Watcher <watcher@example.com>"]
0a407bc ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, Mar...
Marcel Molina authored
21 # from "system@example.com"
22 # subject "New account information"
20bd4bd @dhh Updated docs and otherwise
dhh authored
23 # body :account => recipient
0a407bc ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, Mar...
Marcel Molina authored
24 # end
25 # end
26 #
27 # Mailer methods have the following configuration methods available.
28 #
29 # * <tt>recipients</tt> - Takes one or more email addresses. These addresses are where your email will be delivered to. Sets the <tt>To:</tt> header.
30 # * <tt>subject</tt> - The subject of your email. Sets the <tt>Subject:</tt> header.
31 # * <tt>from</tt> - Who the email you are sending is from. Sets the <tt>From:</tt> header.
32 # * <tt>cc</tt> - Takes one or more email addresses. These addresses will receive a carbon copy of your email. Sets the <tt>Cc:</tt> header.
cf6299d Add ActionMailer#reply_to. [#245 state:resolved]
Adam authored
33 # * <tt>bcc</tt> - Takes one or more email addresses. These addresses will receive a blind carbon copy of your email. Sets the <tt>Bcc:</tt> header.
34 # * <tt>reply_to</tt> - Takes one or more email addresses. These addresses will be listed as the default recipients when replying to your email. Sets the <tt>Reply-To:</tt> header.
0a407bc ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, Mar...
Marcel Molina authored
35 # * <tt>sent_on</tt> - The date on which the message was sent. If not set, the header wil be set by the delivery agent.
36 # * <tt>content_type</tt> - Specify the content type of the message. Defaults to <tt>text/plain</tt>.
37 # * <tt>headers</tt> - Specify additional headers to be set for the message, e.g. <tt>headers 'X-Mail-Count' => 107370</tt>.
38 #
5c0d38f @dhh Fixed that a return-path header would be ignored (closes #7572) [joost]
dhh authored
39 # When a <tt>headers 'return-path'</tt> is specified, that value will be used as the 'envelope from'
40 # address. Setting this is useful when you want delivery notifications sent to a different address than
41 # the one in <tt>from</tt>.
42 #
0a407bc ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, Mar...
Marcel Molina authored
43 # The <tt>body</tt> method has special behavior. It takes a hash which generates an instance variable
44 # named after each key in the hash containing the value that that key points to.
45 #
5c0d38f @dhh Fixed that a return-path header would be ignored (closes #7572) [joost]
dhh authored
46 # So, for example, <tt>body :account => recipient</tt> would result
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Inflect...
josh authored
47 # in an instance variable <tt>@account</tt> with the value of <tt>recipient</tt> being accessible in the
0a407bc ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, Mar...
Marcel Molina authored
48 # view.
49 #
20bd4bd @dhh Updated docs and otherwise
dhh authored
50 #
51 # = Mailer views
52 #
98dc582 @lifo Merge docrails.
lifo authored
53 # Like Action Controller, each mailer class has a corresponding view directory
0a407bc ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, Mar...
Marcel Molina authored
54 # in which each method of the class looks for a template with its name.
21187c0 @dhh Apply the rest of Chads patch
dhh authored
55 # To define a template to be used with a mailing, create an <tt>.erb</tt> file with the same name as the method
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Inflect...
josh authored
56 # in your mailer model. For example, in the mailer defined above, the template at
21187c0 @dhh Apply the rest of Chads patch
dhh authored
57 # <tt>app/views/notifier/signup_notification.erb</tt> would be used to generate the email.
0a407bc ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, Mar...
Marcel Molina authored
58 #
59 # Variables defined in the model are accessible as instance variables in the view.
60 #
61 # Emails by default are sent in plain text, so a sample view for our model example might look like this:
62 #
63 # Hi <%= @account.name %>,
64 # Thanks for joining our service! Please check back often.
65 #
20bd4bd @dhh Updated docs and otherwise
dhh authored
66 # You can even use Action Pack helpers in these views. For example:
67 #
68 # You got a new note!
69 # <%= truncate(note.body, 25) %>
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Inflect...
josh authored
70 #
20bd4bd @dhh Updated docs and otherwise
dhh authored
71 #
4809dcc * Remove default_url_options from mailer generator
Cody Fauser authored
72 # = Generating URLs
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Inflect...
josh authored
73 #
4809dcc * Remove default_url_options from mailer generator
Cody Fauser authored
74 # 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 Inflect...
josh authored
75 # Unlike controllers from Action Pack, the mailer instance doesn't have any context about the incoming request,
76 # so you'll need to provide all of the details needed to generate a URL.
20bd4bd @dhh Updated docs and otherwise
dhh authored
77 #
4809dcc * Remove default_url_options from mailer generator
Cody Fauser authored
78 # 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 Inflect...
josh authored
79 #
4809dcc * Remove default_url_options from mailer generator
Cody Fauser authored
80 # <%= url_for(:host => "example.com", :controller => "welcome", :action => "greeting") %>
20bd4bd @dhh Updated docs and otherwise
dhh authored
81 #
4809dcc * Remove default_url_options from mailer generator
Cody Fauser authored
82 # When using named routes you only need to supply the <tt>:host</tt>:
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Inflect...
josh authored
83 #
4809dcc * Remove default_url_options from mailer generator
Cody Fauser authored
84 # <%= users_url(:host => "example.com") %>
85 #
86 # You will want to avoid using the <tt>name_of_route_path</tt> form of named routes because it doesn't make sense to
87 # generate relative URLs in email messages.
88 #
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Inflect...
josh authored
89 # 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
90 # the <tt>ActionMailer::Base.default_url_options</tt> hash as follows:
91 #
92 # ActionMailer::Base.default_url_options[:host] = "example.com"
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Inflect...
josh authored
93 #
dc4eec1 @lifo Merge docrails:
lifo authored
94 # 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
95 #
96 # config.action_mailer.default_url_options = { :host => "example.com" }
20bd4bd @dhh Updated docs and otherwise
dhh authored
97 #
4809dcc * Remove default_url_options from mailer generator
Cody Fauser authored
98 # If you do decide to set a default <tt>:host</tt> for your mailers you will want to use the
99 # <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 Inflect...
josh authored
100 # 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
101 # explicitly provided.
20bd4bd @dhh Updated docs and otherwise
dhh authored
102 #
103 # = Sending mail
104 #
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Inflect...
josh authored
105 # 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, Mar...
Marcel Molina authored
106 # for delivery later:
107 #
108 # Notifier.deliver_signup_notification(david) # sends the email
109 # mail = Notifier.create_signup_notification(david) # => a tmail object
110 # Notifier.deliver(mail)
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Inflect...
josh authored
111 #
0a407bc ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, Mar...
Marcel Molina authored
112 # You never instantiate your mailer class. Rather, your delivery instance
113 # methods are automatically wrapped in class methods that start with the word
114 # <tt>deliver_</tt> followed by the name of the mailer method that you would
115 # like to deliver. The <tt>signup_notification</tt> method defined above is
116 # delivered by invoking <tt>Notifier.deliver_signup_notification</tt>.
117 #
20bd4bd @dhh Updated docs and otherwise
dhh authored
118 #
119 # = HTML email
120 #
21187c0 @dhh Apply the rest of Chads patch
dhh authored
121 # To send mail as HTML, make sure your view (the <tt>.erb</tt> file) generates HTML and
0a407bc ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, Mar...
Marcel Molina authored
122 # set the content type to html.
123 #
124 # class MyMailer < ActionMailer::Base
359caef @jamis A very thorough refactoring, resulting in new mail property setters and ...
jamis authored
125 # def signup_notification(recipient)
46f30f9 @lifo Merge documentation changes from docrails.
lifo authored
126 # recipients recipient.email_address_with_name
127 # subject "New account information"
128 # from "system@example.com"
129 # body :account => recipient
130 # content_type "text/html"
359caef @jamis A very thorough refactoring, resulting in new mail property setters and ...
jamis authored
131 # end
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Inflect...
josh authored
132 # end
0a407bc ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, Mar...
Marcel Molina authored
133 #
20bd4bd @dhh Updated docs and otherwise
dhh authored
134 #
135 # = Multipart email
136 #
0a407bc ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, Mar...
Marcel Molina authored
137 # You can explicitly specify multipart messages:
359caef @jamis A very thorough refactoring, resulting in new mail property setters and ...
jamis authored
138 #
0a407bc ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, Mar...
Marcel Molina authored
139 # class ApplicationMailer < ActionMailer::Base
359caef @jamis A very thorough refactoring, resulting in new mail property setters and ...
jamis authored
140 # def signup_notification(recipient)
141 # recipients recipient.email_address_with_name
142 # subject "New account information"
143 # from "system@example.com"
46f30f9 @lifo Merge documentation changes from docrails.
lifo authored
144 # content_type "multipart/alternative"
359caef @jamis A very thorough refactoring, resulting in new mail property setters and ...
jamis authored
145 #
146 # part :content_type => "text/html",
147 # :body => render_message("signup-as-html", :account => recipient)
148 #
149 # part "text/plain" do |p|
150 # p.body = render_message("signup-as-plain", :account => recipient)
151 # p.transfer_encoding = "base64"
152 # end
153 # end
0a407bc ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, Mar...
Marcel Molina authored
154 # end
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Inflect...
josh authored
155 #
98dc582 @lifo Merge docrails.
lifo authored
156 # Multipart messages can also be used implicitly because Action Mailer will automatically
0a407bc ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, Mar...
Marcel Molina authored
157 # detect and use multipart templates, where each template is named after the name of the action, followed
158 # 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 Inflect...
josh authored
159 #
0a407bc ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, Mar...
Marcel Molina authored
160 # For example, if the following templates existed:
21187c0 @dhh Apply the rest of Chads patch
dhh authored
161 # * signup_notification.text.plain.erb
162 # * signup_notification.text.html.erb
163 # * signup_notification.text.xml.builder
164 # * signup_notification.text.x-yaml.erb
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Inflect...
josh authored
165 #
0a407bc ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, Mar...
Marcel Molina authored
166 # Each would be rendered and added as a separate part to the message,
46f30f9 @lifo Merge documentation changes from docrails.
lifo authored
167 # with the corresponding content type. The content type for the entire
168 # message is automatically set to <tt>multipart/alternative</tt>, which indicates
169 # that the email contains multiple different representations of the same email
170 # body. The same body hash is passed to each template.
359caef @jamis A very thorough refactoring, resulting in new mail property setters and ...
jamis authored
171 #
46f30f9 @lifo Merge documentation changes from docrails.
lifo authored
172 # Implicit template rendering is not performed if any attachments or parts have been added to the email.
173 # This means that you'll have to manually add each part to the email and set the content type of the email
174 # to <tt>multipart/alternative</tt>.
20bd4bd @dhh Updated docs and otherwise
dhh authored
175 #
0a407bc ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, Mar...
Marcel Molina authored
176 # = Attachments
20bd4bd @dhh Updated docs and otherwise
dhh authored
177 #
0a407bc ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, Mar...
Marcel Molina authored
178 # Attachments can be added by using the +attachment+ method.
179 #
180 # Example:
181 #
182 # class ApplicationMailer < ActionMailer::Base
359caef @jamis A very thorough refactoring, resulting in new mail property setters and ...
jamis authored
183 # # attachments
184 # def signup_notification(recipient)
185 # recipients recipient.email_address_with_name
186 # subject "New account information"
187 # from "system@example.com"
188 #
189 # attachment :content_type => "image/jpeg",
190 # :body => File.read("an-image.jpg")
191 #
192 # attachment "application/pdf" do |a|
193 # a.body = generate_your_pdf_here()
194 # end
db045db @dhh Initial
dhh authored
195 # end
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Inflect...
josh authored
196 # end
c927aa0 @dhh Updated documentation
dhh authored
197 #
20bd4bd @dhh Updated docs and otherwise
dhh authored
198 #
c927aa0 @dhh Updated documentation
dhh authored
199 # = Configuration options
200 #
201 # These options are specified on the class level, like <tt>ActionMailer::Base.template_root = "/my/templates"</tt>
202 #
64092de @fxn Improve documentation coverage and markup
fxn authored
203 # * <tt>template_root</tt> - Determines the base from which template references will be made.
c927aa0 @dhh Updated documentation
dhh authored
204 #
205 # * <tt>logger</tt> - the logger is used for generating information on the mailing run if available.
206 # Can be set to nil for no logging. Compatible with both Ruby's own Logger and Log4r loggers.
207 #
64092de @fxn Improve documentation coverage and markup
fxn authored
208 # * <tt>smtp_settings</tt> - Allows detailed configuration for <tt>:smtp</tt> delivery method:
dc4eec1 @lifo Merge docrails:
lifo authored
209 # * <tt>:address</tt> - Allows you to use a remote mail server. Just change it from its default "localhost" setting.
210 # * <tt>:port</tt> - On the off chance that your mail server doesn't run on port 25, you can change it.
211 # * <tt>:domain</tt> - If you need to specify a HELO domain, you can do it here.
212 # * <tt>:user_name</tt> - If your mail server requires authentication, set the username in this setting.
213 # * <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 cach...
josh authored
214 # * <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
215 # 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/disablin...
josevalim authored
216 # * <tt>:enable_starttls_auto</tt> - When set to true, detects if STARTTLS is enabled in your SMTP server and starts to use it.
217 # It works only on Ruby >= 1.8.7 and Ruby >= 1.9. Default is true.
c927aa0 @dhh Updated documentation
dhh authored
218 #
46f30f9 @lifo Merge documentation changes from docrails.
lifo authored
219 # * <tt>sendmail_settings</tt> - Allows you to override options for the <tt>:sendmail</tt> delivery method.
220 # * <tt>:location</tt> - The location of the sendmail executable. Defaults to <tt>/usr/sbin/sendmail</tt>.
221 # * <tt>:arguments</tt> - The command line arguments. Defaults to <tt>-i -t</tt>.
dc4eec1 @lifo Merge docrails:
lifo authored
222 #
223 # * <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
224 #
64092de @fxn Improve documentation coverage and markup
fxn authored
225 # * <tt>delivery_method</tt> - Defines a delivery method. Possible values are <tt>:smtp</tt> (default), <tt>:sendmail</tt>, and <tt>:test</tt>.
c927aa0 @dhh Updated documentation
dhh authored
226 #
dc4eec1 @lifo Merge docrails:
lifo authored
227 # * <tt>perform_deliveries</tt> - Determines whether <tt>deliver_*</tt> methods are actually carried out. By default they are,
c927aa0 @dhh Updated documentation
dhh authored
228 # but this can be turned off to help functional testing.
229 #
64092de @fxn Improve documentation coverage and markup
fxn authored
230 # * <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
231 # for unit and functional testing.
af56c80 @dhh Updated documentation
dhh authored
232 #
b2504f8 @josh Tidy up ActionMailer rendering logic to take advantage of view path cach...
josh authored
233 # * <tt>default_charset</tt> - The default charset used for the body and to encode the subject. Defaults to UTF-8. You can also
46f30f9 @lifo Merge documentation changes from docrails.
lifo authored
234 # pick a different charset from inside a method with +charset+.
c2e7851 @josevalim Add ActionMailer::Base#enable_starttls_auto option for enabling/disablin...
josevalim authored
235 #
475bd74 @dhh Fix docs (closes #2598)
dhh authored
236 # * <tt>default_content_type</tt> - The default content type used for the main part of the message. Defaults to "text/plain". You
b2504f8 @josh Tidy up ActionMailer rendering logic to take advantage of view path cach...
josh authored
237 # can also pick a different content type from inside a method with +content_type+.
c2e7851 @josevalim Add ActionMailer::Base#enable_starttls_auto option for enabling/disablin...
josevalim authored
238 #
46f30f9 @lifo Merge documentation changes from docrails.
lifo authored
239 # * <tt>default_mime_version</tt> - The default mime version used for the message. Defaults to <tt>1.0</tt>. You
240 # can also pick a different value from inside a method with +mime_version+.
c2e7851 @josevalim Add ActionMailer::Base#enable_starttls_auto option for enabling/disablin...
josevalim authored
241 #
475bd74 @dhh Fix docs (closes #2598)
dhh authored
242 # * <tt>default_implicit_parts_order</tt> - When a message is built implicitly (i.e. multiple parts are assembled from templates
5c98152 @jamis Better multipart support with implicit multipart/alternative and sorting...
jamis authored
243 # which specify the content type in their filenames) this variable controls how the parts are ordered. Defaults to
46f30f9 @lifo Merge documentation changes from docrails.
lifo authored
244 # <tt>["text/html", "text/enriched", "text/plain"]</tt>. Items that appear first in the array have higher priority in the mail client
5c98152 @jamis Better multipart support with implicit multipart/alternative and sorting...
jamis authored
245 # and appear last in the mime encoded message. You can also pick a different order from inside a method with
46f30f9 @lifo Merge documentation changes from docrails.
lifo authored
246 # +implicit_parts_order+.
db045db @dhh Initial
dhh authored
247 class Base
e201fc7 @josh use autoload instead of explicit requires for ActionMailer
josh authored
248 include AdvAttrAccessor, PartContainer, Quoting, Utils
6228220 @dhh Revert "Revert "Add layout functionality to mailers.""
dhh authored
249 if Object.const_defined?(:ActionController)
250 include ActionController::UrlWriter
251 include ActionController::Layout
252 end
359caef @jamis A very thorough refactoring, resulting in new mail property setters and ...
jamis authored
253
c927aa0 @dhh Updated documentation
dhh authored
254 private_class_method :new #:nodoc:
db045db @dhh Initial
dhh authored
255
cb21db1 @josh Treat ActionMailer template_root as a view path set internally to avoid ...
josh authored
256 class_inheritable_accessor :view_paths
db045db @dhh Initial
dhh authored
257 cattr_accessor :logger
258
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Inflect...
josh authored
259 @@smtp_settings = {
c2e7851 @josevalim Add ActionMailer::Base#enable_starttls_auto option for enabling/disablin...
josevalim authored
260 :address => "localhost",
261 :port => 25,
262 :domain => 'localhost.localdomain',
263 :user_name => nil,
264 :password => nil,
265 :authentication => nil,
266 :enable_starttls_auto => true,
db045db @dhh Initial
dhh authored
267 }
27bb903 @NZKoz Rename server_settings to smtp_settings, add sendmail_settings to allow...
NZKoz authored
268 cattr_accessor :smtp_settings
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Inflect...
josh authored
269
27bb903 @NZKoz Rename server_settings to smtp_settings, add sendmail_settings to allow...
NZKoz authored
270 @@sendmail_settings = {
271 :location => '/usr/sbin/sendmail',
272 :arguments => '-i -t'
273 }
274 cattr_accessor :sendmail_settings
db045db @dhh Initial
dhh authored
275
276 @@raise_delivery_errors = true
277 cattr_accessor :raise_delivery_errors
278
57cde63 @dhh Allow ActionMailer subclasses to individually set their delivery method ...
dhh authored
279 superclass_delegating_accessor :delivery_method
280 self.delivery_method = :smtp
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Inflect...
josh authored
281
db045db @dhh Initial
dhh authored
282 @@perform_deliveries = true
283 cattr_accessor :perform_deliveries
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Inflect...
josh authored
284
db045db @dhh Initial
dhh authored
285 @@deliveries = []
286 cattr_accessor :deliveries
287
3fad0cd @dhh Added support for charsets for both subject and body. The default charse...
dhh authored
288 @@default_charset = "utf-8"
289 cattr_accessor :default_charset
290
100fd72 @jamis Added a "content_type" accessor to allow messages to explicitly specify ...
jamis authored
291 @@default_content_type = "text/plain"
292 cattr_accessor :default_content_type
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Inflect...
josh authored
293
45b5555 @jamis Make mime version default to 1.0. closes #2323
jamis authored
294 @@default_mime_version = "1.0"
dca4d4e @jamis Multipart messages specify a MIME-Version header automatically #2003 [Jo...
jamis authored
295 cattr_accessor :default_mime_version
100fd72 @jamis Added a "content_type" accessor to allow messages to explicitly specify ...
jamis authored
296
5c98152 @jamis Better multipart support with implicit multipart/alternative and sorting...
jamis authored
297 @@default_implicit_parts_order = [ "text/html", "text/enriched", "text/plain" ]
298 cattr_accessor :default_implicit_parts_order
299
28bf2fa @josh Protect body ivar from being clobbered by the mailer template assigns
josh authored
300 cattr_reader :protected_instance_variables
301 @@protected_instance_variables = %w(@body)
302
59f1df1 @jamis Update/extend ActionMailer documentation (rdoc)
jamis authored
303 # Specify the BCC addresses for the message
304 adv_attr_accessor :bcc
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Inflect...
josh authored
305
59f1df1 @jamis Update/extend ActionMailer documentation (rdoc)
jamis authored
306 # Define the body of the message. This is either a Hash (in which case it
307 # specifies the variables to pass to the template when it is rendered),
308 # or a string, in which case it specifies the actual text of the message.
309 adv_attr_accessor :body
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Inflect...
josh authored
310
59f1df1 @jamis Update/extend ActionMailer documentation (rdoc)
jamis authored
311 # Specify the CC addresses for the message.
312 adv_attr_accessor :cc
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Inflect...
josh authored
313
59f1df1 @jamis Update/extend ActionMailer documentation (rdoc)
jamis authored
314 # Specify the charset to use for the message. This defaults to the
315 # +default_charset+ specified for ActionMailer::Base.
316 adv_attr_accessor :charset
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Inflect...
josh authored
317
59f1df1 @jamis Update/extend ActionMailer documentation (rdoc)
jamis authored
318 # Specify the content type for the message. This defaults to <tt>text/plain</tt>
319 # in most cases, but can be automatically set in some situations.
320 adv_attr_accessor :content_type
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Inflect...
josh authored
321
59f1df1 @jamis Update/extend ActionMailer documentation (rdoc)
jamis authored
322 # Specify the from address for the message.
323 adv_attr_accessor :from
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Inflect...
josh authored
324
cf6299d Add ActionMailer#reply_to. [#245 state:resolved]
Adam authored
325 # Specify the address (if different than the "from" address) to direct
326 # replies to this message.
327 adv_attr_accessor :reply_to
328
59f1df1 @jamis Update/extend ActionMailer documentation (rdoc)
jamis authored
329 # Specify additional headers to be added to the message.
330 adv_attr_accessor :headers
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Inflect...
josh authored
331
59f1df1 @jamis Update/extend ActionMailer documentation (rdoc)
jamis authored
332 # Specify the order in which parts should be sorted, based on content-type.
333 # This defaults to the value for the +default_implicit_parts_order+.
334 adv_attr_accessor :implicit_parts_order
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Inflect...
josh authored
335
59f1df1 @jamis Update/extend ActionMailer documentation (rdoc)
jamis authored
336 # Defaults to "1.0", but may be explicitly given if needed.
337 adv_attr_accessor :mime_version
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Inflect...
josh authored
338
59f1df1 @jamis Update/extend ActionMailer documentation (rdoc)
jamis authored
339 # The recipient addresses for the message, either as a string (for a single
340 # address) or an array (for multiple addresses).
341 adv_attr_accessor :recipients
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Inflect...
josh authored
342
59f1df1 @jamis Update/extend ActionMailer documentation (rdoc)
jamis authored
343 # The date on which the message was sent. If not set (the default), the
344 # header will be set by the delivery agent.
345 adv_attr_accessor :sent_on
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Inflect...
josh authored
346
59f1df1 @jamis Update/extend ActionMailer documentation (rdoc)
jamis authored
347 # Specify the subject of the message.
348 adv_attr_accessor :subject
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Inflect...
josh authored
349
59f1df1 @jamis Update/extend ActionMailer documentation (rdoc)
jamis authored
350 # Specify the template name to use for current message. This is the "base"
351 # template name, without the extension or directory, and may be used to
352 # have multiple mailer methods share the same template.
353 adv_attr_accessor :template
165097e @dhh Added access to custom headers, like cc, bcc, and reply-to #268 [Andreas...
dhh authored
354
bd5ed65 @technoweenie Update ActionMailer so it treats ActionView the same way that ActionCont...
technoweenie authored
355 # Override the mailer name, which defaults to an inflected version of the
356 # mailer's class name. If you want to use a template in a non-standard
357 # location, you can use this to specify that location.
358 def mailer_name(value = nil)
359 if value
360 self.mailer_name = value
361 else
362 self.class.mailer_name
363 end
364 end
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Inflect...
josh authored
365
bd5ed65 @technoweenie Update ActionMailer so it treats ActionView the same way that ActionCont...
technoweenie authored
366 def mailer_name=(value)
367 self.class.mailer_name = value
368 end
369
59f1df1 @jamis Update/extend ActionMailer documentation (rdoc)
jamis authored
370 # The mail object instance referenced by this mailer.
371 attr_reader :mail
6228220 @dhh Revert "Revert "Add layout functionality to mailers.""
dhh authored
372 attr_reader :template_name, :default_template_name, :action_name
359caef @jamis A very thorough refactoring, resulting in new mail property setters and ...
jamis authored
373
eda1719 @jamis ActionMailer::Base.deliver(email) had been accidentally removed, but was...
jamis authored
374 class << self
bd5ed65 @technoweenie Update ActionMailer so it treats ActionView the same way that ActionCont...
technoweenie authored
375 attr_writer :mailer_name
376
377 def mailer_name
378 @mailer_name ||= name.underscore
379 end
380
381 # for ActionView compatibility
382 alias_method :controller_name, :mailer_name
383 alias_method :controller_path, :mailer_name
384
3cf773b @floehopper ActionMailer should respond_to? to methods handled by method_missing [#7...
floehopper authored
385 def respond_to?(method_symbol, include_private = false) #:nodoc:
386 matches_dynamic_method?(method_symbol) || super
387 end
388
389 def method_missing(method_symbol, *parameters) #:nodoc:
a62e9e9 @mocoso Fix for ActionMailer::Base.method_missing so that it raises NoMethodErro...
mocoso authored
390 if match = matches_dynamic_method?(method_symbol)
391 case match[1]
392 when 'create' then new(match[2], *parameters).mail
393 when 'deliver' then new(match[2], *parameters).deliver!
394 when 'new' then nil
c65075f @mocoso Fixed method_missing for ActionMailer so it no longer matches methods wh...
mocoso authored
395 else super
a62e9e9 @mocoso Fix for ActionMailer::Base.method_missing so that it raises NoMethodErro...
mocoso authored
396 end
397 else
398 super
eda1719 @jamis ActionMailer::Base.deliver(email) had been accidentally removed, but was...
jamis authored
399 end
400 end
401
59f1df1 @jamis Update/extend ActionMailer documentation (rdoc)
jamis authored
402 # Receives a raw email, parses it into an email object, decodes it,
403 # instantiates a new mailer, and passes the email object to the mailer
98dc582 @lifo Merge docrails.
lifo authored
404 # object's +receive+ method. If you want your mailer to be able to
405 # process incoming messages, you'll need to implement a +receive+
59f1df1 @jamis Update/extend ActionMailer documentation (rdoc)
jamis authored
406 # method that accepts the email object as a parameter:
407 #
408 # class MyMailer < ActionMailer::Base
409 # def receive(mail)
410 # ...
411 # end
412 # end
413 def receive(raw_email)
eda1719 @jamis ActionMailer::Base.deliver(email) had been accidentally removed, but was...
jamis authored
414 logger.info "Received mail:\n #{raw_email}" unless logger.nil?
415 mail = TMail::Mail.parse(raw_email)
416 mail.base64_decode
417 new.receive(mail)
418 end
419
420 # Deliver the given mail object directly. This can be used to deliver
421 # a preconstructed mail object, like:
422 #
423 # email = MyMailer.create_some_mail(parameters)
424 # email.set_some_obscure_header "frobnicate"
425 # MyMailer.deliver(email)
426 def deliver(mail)
427 new.deliver!(mail)
428 end
271404e @jeremy Register alternative template engines using ActionMailer::Base.register_...
jeremy authored
429
cb21db1 @josh Treat ActionMailer template_root as a view path set internally to avoid ...
josh authored
430 def template_root
431 self.view_paths && self.view_paths.first
432 end
433
61c90a4 @NZKoz Reapply the TemplateFinder first applied in [8669] then reverted in [867...
NZKoz authored
434 def template_root=(root)
cb21db1 @josh Treat ActionMailer template_root as a view path set internally to avoid ...
josh authored
435 self.view_paths = ActionView::Base.process_view_paths(root)
61c90a4 @NZKoz Reapply the TemplateFinder first applied in [8669] then reverted in [867...
NZKoz authored
436 end
3cf773b @floehopper ActionMailer should respond_to? to methods handled by method_missing [#7...
floehopper authored
437
438 private
439 def matches_dynamic_method?(method_name) #:nodoc:
440 method_name = method_name.to_s
c65075f @mocoso Fixed method_missing for ActionMailer so it no longer matches methods wh...
mocoso authored
441 /^(create|deliver)_([_a-z]\w*)/.match(method_name) || /^(new)$/.match(method_name)
3cf773b @floehopper ActionMailer should respond_to? to methods handled by method_missing [#7...
floehopper authored
442 end
eda1719 @jamis ActionMailer::Base.deliver(email) had been accidentally removed, but was...
jamis authored
443 end
444
359caef @jamis A very thorough refactoring, resulting in new mail property setters and ...
jamis authored
445 # Instantiate a new mailer object. If +method_name+ is not +nil+, the mailer
446 # will be initialized according to the named method. If not, the mailer will
447 # remain uninitialized (useful when you only need to invoke the "receive"
448 # method, for instance).
2789b5d @dhh Tuned documentation for release (AM)
dhh authored
449 def initialize(method_name=nil, *parameters) #:nodoc:
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Inflect...
josh authored
450 create!(method_name, *parameters) if method_name
359caef @jamis A very thorough refactoring, resulting in new mail property setters and ...
jamis authored
451 end
452
453 # Initialize the mailer via the given +method_name+. The body will be
454 # rendered and a new TMail::Mail object created.
2789b5d @dhh Tuned documentation for release (AM)
dhh authored
455 def create!(method_name, *parameters) #:nodoc:
f474f33 @jamis Move mailer initialization to a separate (overridable) method, so that s...
jamis authored
456 initialize_defaults(method_name)
c3ff04b @jeremy Allow mailer actions named send by using __send__ internally. Closes #64...
jeremy authored
457 __send__(method_name, *parameters)
359caef @jamis A very thorough refactoring, resulting in new mail property setters and ...
jamis authored
458
459 # If an explicit, textual body has not been set, we check assumptions.
460 unless String === @body
461 # First, we look to see if there are any likely templates that match,
462 # which include the content-type in their file name (i.e.,
21187c0 @dhh Apply the rest of Chads patch
dhh authored
463 # "the_template_file.text.html.erb", etc.). Only do this if parts
dca4d4e @jamis Multipart messages specify a MIME-Version header automatically #2003 [Jo...
jamis authored
464 # have not already been specified manually.
359caef @jamis A very thorough refactoring, resulting in new mail property setters and ...
jamis authored
465 if @parts.empty?
b2504f8 @josh Tidy up ActionMailer rendering logic to take advantage of view path cach...
josh authored
466 Dir.glob("#{template_path}/#{@template}.*").each do |path|
467 template = template_root["#{mailer_name}/#{File.basename(path)}"]
468
469 # Skip unless template has a multipart format
f3f7d16 @macksmind Fixed problem causes by leftover backup templates ending in tilde [state...
macksmind authored
470 next unless template && template.multipart?
b2504f8 @josh Tidy up ActionMailer rendering logic to take advantage of view path cach...
josh authored
471
472 @parts << Part.new(
473 :content_type => template.content_type,
474 :disposition => "inline",
475 :charset => charset,
476 :body => render_message(template, @body)
477 )
359caef @jamis A very thorough refactoring, resulting in new mail property setters and ...
jamis authored
478 end
5c98152 @jamis Better multipart support with implicit multipart/alternative and sorting...
jamis authored
479 unless @parts.empty?
480 @content_type = "multipart/alternative"
481 @parts = sort_parts(@parts, @implicit_parts_order)
482 end
359caef @jamis A very thorough refactoring, resulting in new mail property setters and ...
jamis authored
483 end
db045db @dhh Initial
dhh authored
484
359caef @jamis A very thorough refactoring, resulting in new mail property setters and ...
jamis authored
485 # Then, if there were such templates, we check to see if we ought to
486 # also render a "normal" template (without the content type). If a
487 # normal template exists (or if there were no implicit parts) we render
488 # it.
04248c6 @josh Ensure templates are rendered if all the parts are already processed
josh authored
489 template_exists = @parts.empty?
490 template_exists ||= template_root["#{mailer_name}/#{@template}"]
491 @body = render_message(@template, @body) if template_exists
359caef @jamis A very thorough refactoring, resulting in new mail property setters and ...
jamis authored
492
493 # Finally, if there are other message parts and a textual body exists,
494 # we shift it onto the front of the parts and set the body to nil (so
495 # that create_mail doesn't try to render it in addition to the parts).
496 if !@parts.empty? && String === @body
497 @parts.unshift Part.new(:charset => charset, :body => @body)
498 @body = nil
425aa50 @dhh Added receiver method for incoming email
dhh authored
499 end
db045db @dhh Initial
dhh authored
500 end
501
dca4d4e @jamis Multipart messages specify a MIME-Version header automatically #2003 [Jo...
jamis authored
502 # If this is a multipart e-mail add the mime_version if it is not
503 # already set.
504 @mime_version ||= "1.0" if !@parts.empty?
505
359caef @jamis A very thorough refactoring, resulting in new mail property setters and ...
jamis authored
506 # build the mail object itself
507 @mail = create_mail
508 end
db045db @dhh Initial
dhh authored
509
eda1719 @jamis ActionMailer::Base.deliver(email) had been accidentally removed, but was...
jamis authored
510 # Delivers a TMail::Mail object. By default, it delivers the cached mail
98dc582 @lifo Merge docrails.
lifo authored
511 # object (from the <tt>create!</tt> method). If no cached mail object exists, and
eda1719 @jamis ActionMailer::Base.deliver(email) had been accidentally removed, but was...
jamis authored
512 # no alternate has been given as the parameter, this will fail.
59f1df1 @jamis Update/extend ActionMailer documentation (rdoc)
jamis authored
513 def deliver!(mail = @mail)
eda1719 @jamis ActionMailer::Base.deliver(email) had been accidentally removed, but was...
jamis authored
514 raise "no mail object available for delivery!" unless mail
fbd3eb7 @jeremy Less verbose mail logging: just recipients for :info log level; the whol...
jeremy authored
515 unless logger.nil?
be36455 @jeremy Ruby 1.9 compat: use Array() instead of #to_a.
jeremy authored
516 logger.info "Sent mail to #{Array(recipients).join(', ')}"
fbd3eb7 @jeremy Less verbose mail logging: just recipients for :info log level; the whol...
jeremy authored
517 logger.debug "\n#{mail.encoded}"
518 end
256e800 @dhh Fixed quoting for all address headers, not just to #955 [Jamis Buck] Add...
dhh authored
519
359caef @jamis A very thorough refactoring, resulting in new mail property setters and ...
jamis authored
520 begin
c3ff04b @jeremy Allow mailer actions named send by using __send__ internally. Closes #64...
jeremy authored
521 __send__("perform_delivery_#{delivery_method}", mail) if perform_deliveries
12ff554 @jeremy Tighten rescue clauses. Closes #5985.
jeremy authored
522 rescue Exception => e # Net::SMTP errors or sendmail pipe errors
359caef @jamis A very thorough refactoring, resulting in new mail property setters and ...
jamis authored
523 raise e if raise_delivery_errors
524 end
3fad0cd @dhh Added support for charsets for both subject and body. The default charse...
dhh authored
525
eda1719 @jamis ActionMailer::Base.deliver(email) had been accidentally removed, but was...
jamis authored
526 return mail
359caef @jamis A very thorough refactoring, resulting in new mail property setters and ...
jamis authored
527 end
3fad0cd @dhh Added support for charsets for both subject and body. The default charse...
dhh authored
528
359caef @jamis A very thorough refactoring, resulting in new mail property setters and ...
jamis authored
529 private
f474f33 @jamis Move mailer initialization to a separate (overridable) method, so that s...
jamis authored
530 # Set up the default values for the various instance variables of this
531 # mailer. Subclasses may override this method to provide different
532 # defaults.
533 def initialize_defaults(method_name)
95e8740 @dhh Allow Mailers to have custom initialize methods that set default instanc...
dhh authored
534 @charset ||= @@default_charset.dup
535 @content_type ||= @@default_content_type.dup
536 @implicit_parts_order ||= @@default_implicit_parts_order.dup
537 @template ||= method_name
6228220 @dhh Revert "Revert "Add layout functionality to mailers.""
dhh authored
538 @default_template_name = @action_name = @template
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Inflect...
josh authored
539 @mailer_name ||= self.class.name.underscore
95e8740 @dhh Allow Mailers to have custom initialize methods that set default instanc...
dhh authored
540 @parts ||= []
541 @headers ||= {}
542 @body ||= {}
dca4d4e @jamis Multipart messages specify a MIME-Version header automatically #2003 [Jo...
jamis authored
543 @mime_version = @@default_mime_version.dup if @@default_mime_version
f474f33 @jamis Move mailer initialization to a separate (overridable) method, so that s...
jamis authored
544 end
545
359caef @jamis A very thorough refactoring, resulting in new mail property setters and ...
jamis authored
546 def render_message(method_name, body)
1d4554d ActionMailer should respect content type when choosing layouts
Colin Curtin authored
547 if method_name.respond_to?(:content_type)
548 @current_template_content_type = method_name.content_type
549 end
7461227 @josh Ruby 1.9: Call join on template_root instead of to_s
josh authored
550 render :file => method_name, :body => body
1d4554d ActionMailer should respect content type when choosing layouts
Colin Curtin authored
551 ensure
552 @current_template_content_type = nil
359caef @jamis A very thorough refactoring, resulting in new mail property setters and ...
jamis authored
553 end
ae1e852 @jamis Add a unified render method to ActionMailer (delegates to ActionView::Ba...
jamis authored
554
555 def render(opts)
556 body = opts.delete(:body)
b2504f8 @josh Tidy up ActionMailer rendering logic to take advantage of view path cach...
josh authored
557 if opts[:file] && (opts[:file] !~ /\// && !opts[:file].respond_to?(:render))
bd5ed65 @technoweenie Update ActionMailer so it treats ActionView the same way that ActionCont...
technoweenie authored
558 opts[:file] = "#{mailer_name}/#{opts[:file]}"
559 end
6228220 @dhh Revert "Revert "Add layout functionality to mailers.""
dhh authored
560
561 begin
562 old_template, @template = @template, initialize_template_class(body)
563 layout = respond_to?(:pick_layout, true) ? pick_layout(opts) : false
564 @template.render(opts.merge(:layout => layout))
565 ensure
566 @template = old_template
567 end
568 end
569
570 def default_template_format
1d4554d ActionMailer should respect content type when choosing layouts
Colin Curtin authored
571 if @current_template_content_type
572 Mime::Type.lookup(@current_template_content_type).to_sym
573 else
574 :html
575 end
6228220 @dhh Revert "Revert "Add layout functionality to mailers.""
dhh authored
576 end
577
578 def candidate_for_layout?(options)
858a420 @josh Ensure the template format is always passed to the template finder. Now ...
josh authored
579 !self.view_paths.find_template(default_template_name, default_template_format).exempt_from_layout?
580 rescue ActionView::MissingTemplate
581 return true
ae1e852 @jamis Add a unified render method to ActionMailer (delegates to ActionView::Ba...
jamis authored
582 end
583
cb21db1 @josh Treat ActionMailer template_root as a view path set internally to avoid ...
josh authored
584 def template_root
585 self.class.template_root
586 end
587
588 def template_root=(root)
589 self.class.template_root = root
590 end
591
359caef @jamis A very thorough refactoring, resulting in new mail property setters and ...
jamis authored
592 def template_path
e23156e @josh Only create a path for ActionMailer template root instead of a path set....
josh authored
593 "#{template_root}/#{mailer_name}"
db045db @dhh Initial
dhh authored
594 end
595
5ec990a @jamis Helper support for ActionMailer
jamis authored
596 def initialize_template_class(assigns)
1d4554d ActionMailer should respect content type when choosing layouts
Colin Curtin authored
597 template = ActionView::Base.new(view_paths, assigns, self)
598 template.template_format = default_template_format
599 template
5ec990a @jamis Helper support for ActionMailer
jamis authored
600 end
601
5c98152 @jamis Better multipart support with implicit multipart/alternative and sorting...
jamis authored
602 def sort_parts(parts, order = [])
603 order = order.collect { |s| s.downcase }
604
605 parts = parts.sort do |a, b|
606 a_ct = a.content_type.downcase
607 b_ct = b.content_type.downcase
608
609 a_in = order.include? a_ct
610 b_in = order.include? b_ct
611
612 s = case
613 when a_in && b_in
614 order.index(a_ct) <=> order.index(b_ct)
615 when a_in
616 -1
617 when b_in
618 1
619 else
620 a_ct <=> b_ct
621 end
622
623 # reverse the ordering because parts that come last are displayed
624 # first in mail clients
625 (s * -1)
626 end
627
628 parts
629 end
630
359caef @jamis A very thorough refactoring, resulting in new mail property setters and ...
jamis authored
631 def create_mail
632 m = TMail::Mail.new
74a612c @dhh Added that delivery errors are caught in a way so the mail is still retu...
dhh authored
633
cf6299d Add ActionMailer#reply_to. [#245 state:resolved]
Adam authored
634 m.subject, = quote_any_if_necessary(charset, subject)
635 m.to, m.from = quote_any_address_if_necessary(charset, recipients, from)
636 m.bcc = quote_address_if_necessary(bcc, charset) unless bcc.nil?
637 m.cc = quote_address_if_necessary(cc, charset) unless cc.nil?
638 m.reply_to = quote_address_if_necessary(reply_to, charset) unless reply_to.nil?
dca4d4e @jamis Multipart messages specify a MIME-Version header automatically #2003 [Jo...
jamis authored
639 m.mime_version = mime_version unless mime_version.nil?
cf6299d Add ActionMailer#reply_to. [#245 state:resolved]
Adam authored
640 m.date = sent_on.to_time rescue sent_on if sent_on
641
359caef @jamis A very thorough refactoring, resulting in new mail property setters and ...
jamis authored
642 headers.each { |k, v| m[k] = v }
db045db @dhh Initial
dhh authored
643
db0e8ff @jamis Parse content-type apart before using it so that sub-parts of the header...
jamis authored
644 real_content_type, ctype_attrs = parse_content_type
645
359caef @jamis A very thorough refactoring, resulting in new mail property setters and ...
jamis authored
646 if @parts.empty?
db0e8ff @jamis Parse content-type apart before using it so that sub-parts of the header...
jamis authored
647 m.set_content_type(real_content_type, nil, ctype_attrs)
e201fc7 @josh use autoload instead of explicit requires for ActionMailer
josh authored
648 m.body = normalize_new_lines(body)
359caef @jamis A very thorough refactoring, resulting in new mail property setters and ...
jamis authored
649 else
650 if String === body
651 part = TMail::Mail.new
e201fc7 @josh use autoload instead of explicit requires for ActionMailer
josh authored
652 part.body = normalize_new_lines(body)
db0e8ff @jamis Parse content-type apart before using it so that sub-parts of the header...
jamis authored
653 part.set_content_type(real_content_type, nil, ctype_attrs)
359caef @jamis A very thorough refactoring, resulting in new mail property setters and ...
jamis authored
654 part.set_content_disposition "inline"
655 m.parts << part
656 end
3fad0cd @dhh Added support for charsets for both subject and body. The default charse...
dhh authored
657
359caef @jamis A very thorough refactoring, resulting in new mail property setters and ...
jamis authored
658 @parts.each do |p|
659 part = (TMail::Mail === p ? p : p.to_mail(self))
660 m.parts << part
661 end
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Inflect...
josh authored
662
49efa02 @jamis Nil charset caused subject line to be improperly quoted in implicitly mu...
jamis authored
663 if real_content_type =~ /multipart/
664 ctype_attrs.delete "charset"
665 m.set_content_type(real_content_type, nil, ctype_attrs)
666 end
359caef @jamis A very thorough refactoring, resulting in new mail property setters and ...
jamis authored
667 end
256e800 @dhh Fixed quoting for all address headers, not just to #955 [Jamis Buck] Add...
dhh authored
668
359caef @jamis A very thorough refactoring, resulting in new mail property setters and ...
jamis authored
669 @mail = m
256e800 @dhh Fixed quoting for all address headers, not just to #955 [Jamis Buck] Add...
dhh authored
670 end
671
359caef @jamis A very thorough refactoring, resulting in new mail property setters and ...
jamis authored
672 def perform_delivery_smtp(mail)
508c26c @jamis BCC headers are removed when sending via SMTP
jamis authored
673 destinations = mail.destinations
674 mail.ready_to_send
5c0d38f @dhh Fixed that a return-path header would be ignored (closes #7572) [joost]
dhh authored
675 sender = mail['return-path'] || mail.from
508c26c @jamis BCC headers are removed when sending via SMTP
jamis authored
676
732c724 @granth Turn on STARTTLS if it is available in Net::SMTP (added in Ruby 1.8.7) a...
granth authored
677 smtp = Net::SMTP.new(smtp_settings[:address], smtp_settings[:port])
c2e7851 @josevalim Add ActionMailer::Base#enable_starttls_auto option for enabling/disablin...
josevalim authored
678 smtp.enable_starttls_auto if smtp_settings[:enable_starttls_auto] && smtp.respond_to?(:enable_starttls_auto)
732c724 @granth Turn on STARTTLS if it is available in Net::SMTP (added in Ruby 1.8.7) a...
granth authored
679 smtp.start(smtp_settings[:domain], smtp_settings[:user_name], smtp_settings[:password],
680 smtp_settings[:authentication]) do |smtp|
5c0d38f @dhh Fixed that a return-path header would be ignored (closes #7572) [joost]
dhh authored
681 smtp.sendmail(mail.encoded, sender, destinations)
359caef @jamis A very thorough refactoring, resulting in new mail property setters and ...
jamis authored
682 end
256e800 @dhh Fixed quoting for all address headers, not just to #955 [Jamis Buck] Add...
dhh authored
683 end
684
359caef @jamis A very thorough refactoring, resulting in new mail property setters and ...
jamis authored
685 def perform_delivery_sendmail(mail)
77730f7 @NZKoz Avoid modifying the sendmail_settings hash when using the return path. C...
NZKoz authored
686 sendmail_args = sendmail_settings[:arguments]
687 sendmail_args += " -f \"#{mail['return-path']}\"" if mail['return-path']
688 IO.popen("#{sendmail_settings[:location]} #{sendmail_args}","w+") do |sm|
bb62568 @dhh Fix problem with sendmail delivery where headers should be delimited by ...
dhh authored
689 sm.print(mail.encoded.gsub(/\r/, ''))
359caef @jamis A very thorough refactoring, resulting in new mail property setters and ...
jamis authored
690 sm.flush
256e800 @dhh Fixed quoting for all address headers, not just to #955 [Jamis Buck] Add...
dhh authored
691 end
692 end
693
359caef @jamis A very thorough refactoring, resulting in new mail property setters and ...
jamis authored
694 def perform_delivery_test(mail)
695 deliveries << mail
696 end
db045db @dhh Initial
dhh authored
697 end
e201fc7 @josh use autoload instead of explicit requires for ActionMailer
josh authored
698
699 Base.class_eval do
700 include Helpers
701 helper MailHelper
702 end
db045db @dhh Initial
dhh authored
703 end
Something went wrong with that request. Please try again.