Skip to content
Newer
Older
100644 751 lines (701 sloc) 30.7 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'
41af6d9 @jeremy Use Array.wrap not Array()
jeremy authored Mar 17, 2010
4 require 'active_support/core_ext/array/wrap'
76f024a @fxn adds missing requires for Object#blank? and Object#present?
fxn authored Mar 28, 2010
5 require 'active_support/core_ext/object/blank'
fa5f936 @spastorino Added missing require, we are using bind method defined on active_sup…
spastorino authored May 16, 2010
6 require 'active_support/core_ext/proc'
6788db8 @josevalim Move Rails::LogSubscriber to ActiveSupport::LogSubscriber, allowing f…
josevalim authored Jun 24, 2010
7 require 'action_mailer/log_subscriber'
a63caa4 Get tests to run (with failures) without old base around
Yehuda Katz + Carl Lerche authored Jun 15, 2009
8
c4590d5 @dhh Fixed docs
dhh authored Mar 28, 2006
9 module ActionMailer #:nodoc:
98dc582 @lifo Merge docrails.
lifo authored May 25, 2008
10 # Action Mailer allows you to send email from your application using a mailer model and views.
db045db @dhh Initial
dhh authored Nov 24, 2004
11 #
0a407bc ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, …
Marcel Molina authored May 10, 2006
12 # = Mailer Models
20bd4bd @dhh Updated docs and otherwise
dhh authored Sep 2, 2006
13 #
98dc582 @lifo Merge docrails.
lifo authored May 25, 2008
14 # 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
15 #
f44a0b1 @romdi fix usage examples and more to use new invocations
romdi authored Feb 6, 2010
16 # $ rails generate mailer Notifier
0a407bc ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, …
Marcel Molina authored May 10, 2006
17 #
058f7fe @mikel Cleaning up Action Mailer spelling with and without the space
mikel authored May 2, 2010
18 # The generated model inherits from <tt>ActionMailer::Base</tt>. Emails are defined by creating methods
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
19 # within the model which are then used to set variables to be used in the mail template, to
20 # change options on the mail, or to add attachments.
0a407bc ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, …
Marcel Molina authored May 10, 2006
21 #
22 # Examples:
23 #
24 # class Notifier < ActionMailer::Base
452bb1e @jeremy Rename 'defaults' class method to 'default' to reflect that it's a de…
jeremy authored Jan 27, 2010
25 # default :from => 'no-reply@example.com',
26 # :return_path => 'system@example.com'
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
27 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
28 # def welcome(recipient)
29 # @account = recipient
6589976 Remove old files, add some information to docs and improve test suite.
José Valim and Mikel Lindsaar authored Jan 26, 2010
30 # mail(:to => recipient.email_address_with_name,
31 # :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
32 # end
0a407bc ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, …
Marcel Molina authored May 10, 2006
33 # end
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
34 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
35 # Within the mailer method, you have access to the following methods:
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
36 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
37 # * <tt>attachments[]=</tt> - Allows you to add attachments to your email in an intuitive
38 # 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
39 #
3762362 @mikel Updating readme for ActionMailer::Base
mikel authored Jun 7, 2010
40 # * <tt>attachments.inline[]=</tt> - Allows you to add an inline attachment to your email
41 # in the same manner as <tt>attachments[]=</tt>
42 #
bb2c7b4 @mikel Updating Action Mailer documentation
mikel authored Jan 29, 2010
43 # * <tt>headers[]=</tt> - Allows you to specify any header field in your email such
44 # as <tt>headers['X-No-Spam'] = 'True'</tt>. Note, while most fields (like <tt>To:</tt>
45 # <tt>From:</tt> can only appear once in an email header, other fields like <tt>X-Anything</tt>
46 # can appear multiple times. If you want to change a field that can appear multiple times,
47 # you need to set it to nil first so that Mail knows you are replacing it, not adding
48 # another field of the same name.)
6589976 Remove old files, add some information to docs and improve test suite.
José Valim and Mikel Lindsaar authored Jan 26, 2010
49 #
9520166 @mikel Fixed up being able to pass random headers in with headers, or mail. …
mikel authored Jan 27, 2010
50 # * <tt>headers(hash)</tt> - Allows you to specify multiple headers in your email such
51 # as <tt>headers({'X-No-Spam' => 'True', 'In-Reply-To' => '1234@message.id'})</tt>
52 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
53 # * <tt>mail</tt> - Allows you to specify your email to send.
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
54 #
9520166 @mikel Fixed up being able to pass random headers in with headers, or mail. …
mikel authored Jan 26, 2010
55 # The hash passed to the mail method allows you to specify any header that a Mail::Message
bb2c7b4 @mikel Updating Action Mailer documentation
mikel authored Jan 29, 2010
56 # will accept (any valid Email header including optional fields).
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
57 #
58 # The mail method, if not passed a block, will inspect your views and send all the views with
bb2c7b4 @mikel Updating Action Mailer documentation
mikel authored Jan 29, 2010
59 # the same name as the method, so the above action would send the +welcome.text.plain.erb+ view
60 # file as well as the +welcome.text.html.erb+ view file in a +multipart/alternative+ email.
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
61 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
62 # If you want to explicitly render only certain templates, pass a block:
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
63 #
c125116 @dchelimsky docfix (email instead of emai)
dchelimsky authored Jun 12, 2010
64 # mail(:to => user.email) do |format|
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
65 # format.text
66 # format.html
67 # end
20bd4bd @dhh Updated docs and otherwise
dhh authored Sep 2, 2006
68 #
6589976 Remove old files, add some information to docs and improve test suite.
José Valim and Mikel Lindsaar authored Jan 26, 2010
69 # The block syntax is useful if also need to specify information specific to a part:
70 #
c125116 @dchelimsky docfix (email instead of emai)
dchelimsky authored Jun 12, 2010
71 # mail(:to => user.email) do |format|
6589976 Remove old files, add some information to docs and improve test suite.
José Valim and Mikel Lindsaar authored Jan 26, 2010
72 # format.text(:content_transfer_encoding => "base64")
73 # format.html
74 # end
75 #
bb2c7b4 @mikel Updating Action Mailer documentation
mikel authored Jan 29, 2010
76 # Or even to render a special view:
6589976 Remove old files, add some information to docs and improve test suite.
José Valim and Mikel Lindsaar authored Jan 26, 2010
77 #
c125116 @dchelimsky docfix (email instead of emai)
dchelimsky authored Jun 12, 2010
78 # mail(:to => user.email) do |format|
6589976 Remove old files, add some information to docs and improve test suite.
José Valim and Mikel Lindsaar authored Jan 26, 2010
79 # format.text
80 # format.html { render "some_other_template" }
81 # end
82 #
20bd4bd @dhh Updated docs and otherwise
dhh authored Sep 2, 2006
83 # = Mailer views
84 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
85 # Like Action Controller, each mailer class has a corresponding view directory in which each
86 # method of the class looks for a template with its name.
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
87 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
88 # To define a template to be used with a mailing, create an <tt>.erb</tt> file with the same
89 # name as the method in your mailer model. For example, in the mailer defined above, the template at
bb2c7b4 @mikel Updating Action Mailer documentation
mikel authored Jan 29, 2010
90 # <tt>app/views/notifier/signup_notification.text.plain.erb</tt> would be used to generate the email.
0a407bc ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, …
Marcel Molina authored May 10, 2006
91 #
92 # Variables defined in the model are accessible as instance variables in the view.
93 #
94 # Emails by default are sent in plain text, so a sample view for our model example might look like this:
95 #
96 # Hi <%= @account.name %>,
97 # Thanks for joining our service! Please check back often.
98 #
20bd4bd @dhh Updated docs and otherwise
dhh authored Sep 2, 2006
99 # You can even use Action Pack helpers in these views. For example:
100 #
101 # 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
102 # <%= truncate(@note.body, 25) %>
103 #
6589976 Remove old files, add some information to docs and improve test suite.
José Valim and Mikel Lindsaar authored Jan 26, 2010
104 # 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
105 #
6589976 Remove old files, add some information to docs and improve test suite.
José Valim and Mikel Lindsaar authored Jan 26, 2010
106 # 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
107 # <%= truncate(@note.body, 25) %>
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Infl…
josh authored May 14, 2008
108 #
20bd4bd @dhh Updated docs and otherwise
dhh authored Sep 2, 2006
109 #
4809dcc * Remove default_url_options from mailer generator
Cody Fauser authored Apr 21, 2008
110 # = Generating URLs
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Infl…
josh authored May 14, 2008
111 #
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
112 # URLs can be generated in mailer views using <tt>url_for</tt> or named routes. Unlike controllers from
bb2c7b4 @mikel Updating Action Mailer documentation
mikel authored Jan 29, 2010
113 # Action Pack, the mailer instance doesn't have any context about the incoming request, so you'll need
114 # to provide all of the details needed to generate a URL.
20bd4bd @dhh Updated docs and otherwise
dhh authored Sep 2, 2006
115 #
4809dcc * Remove default_url_options from mailer generator
Cody Fauser authored Apr 21, 2008
116 # 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
117 #
4809dcc * Remove default_url_options from mailer generator
Cody Fauser authored Apr 21, 2008
118 # <%= url_for(:host => "example.com", :controller => "welcome", :action => "greeting") %>
20bd4bd @dhh Updated docs and otherwise
dhh authored Sep 2, 2006
119 #
4809dcc * Remove default_url_options from mailer generator
Cody Fauser authored Apr 21, 2008
120 # 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
121 #
4809dcc * Remove default_url_options from mailer generator
Cody Fauser authored Apr 21, 2008
122 # <%= users_url(:host => "example.com") %>
123 #
bb2c7b4 @mikel Updating Action Mailer documentation
mikel authored Jan 29, 2010
124 # You will want to avoid using the <tt>name_of_route_path</tt> form of named routes because it doesn't
125 # make sense to generate relative URLs in email messages.
4809dcc * Remove default_url_options from mailer generator
Cody Fauser authored Apr 21, 2008
126 #
bb2c7b4 @mikel Updating Action Mailer documentation
mikel authored Jan 29, 2010
127 # It is also possible to set a default host that will be used in all mailers by setting the <tt>:host</tt>
ab62aa1 @jeroenvandijk Mention that ActionMailer::Base.default_url_options is now deprecated
jeroenvandijk authored Jul 21, 2010
128 # option as a configuration option in <tt>config/application.rb</tt>:
4809dcc * Remove default_url_options from mailer generator
Cody Fauser authored Apr 21, 2008
129 #
130 # config.action_mailer.default_url_options = { :host => "example.com" }
20bd4bd @dhh Updated docs and otherwise
dhh authored Sep 2, 2006
131 #
ab62aa1 @jeroenvandijk Mention that ActionMailer::Base.default_url_options is now deprecated
jeroenvandijk authored Jul 21, 2010
132 # Setting <tt>ActionMailer::Base.default_url_options</tt> directly is now deprecated, use the configuration
133 # option mentioned above to set the default host.
134 #
4809dcc * Remove default_url_options from mailer generator
Cody Fauser authored Apr 21, 2008
135 # If you do decide to set a default <tt>:host</tt> for your mailers you will want to use the
bb2c7b4 @mikel Updating Action Mailer documentation
mikel authored Jan 29, 2010
136 # <tt>:only_path => false</tt> option when using <tt>url_for</tt>. This will ensure that absolute URLs are
137 # generated because the <tt>url_for</tt> view helper will, by default, generate relative URLs when a
138 # <tt>:host</tt> option isn't explicitly provided.
20bd4bd @dhh Updated docs and otherwise
dhh authored Sep 2, 2006
139 #
140 # = Sending mail
141 #
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Infl…
josh authored May 14, 2008
142 # 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
143 # for delivery later:
144 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
145 # Notifier.welcome(david).deliver # sends the email
146 # mail = Notifier.welcome(david) # => a Mail::Message object
147 # mail.deliver # sends the email
0a407bc ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, …
Marcel Molina authored May 10, 2006
148 #
bb2c7b4 @mikel Updating Action Mailer documentation
mikel authored Jan 29, 2010
149 # You never instantiate your mailer class. Rather, you just call the method you defined on the class itself.
20bd4bd @dhh Updated docs and otherwise
dhh authored Sep 2, 2006
150 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
151 # = Multipart Emails
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Infl…
josh authored May 14, 2008
152 #
98dc582 @lifo Merge docrails.
lifo authored May 25, 2008
153 # 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
154 # detect and use multipart templates, where each template is named after the name of the action, followed
155 # 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
156 #
0a407bc ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, …
Marcel Molina authored May 10, 2006
157 # For example, if the following templates existed:
21187c0 @dhh Apply the rest of Chads patch
dhh authored Feb 21, 2007
158 # * signup_notification.text.plain.erb
159 # * signup_notification.text.html.erb
160 # * 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
161 # * signup_notification.text.yaml.erb
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Infl…
josh authored May 14, 2008
162 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
163 # Each would be rendered and added as a separate part to the message, with the corresponding content
164 # type. The content type for the entire message is automatically set to <tt>multipart/alternative</tt>,
165 # which indicates that the email contains multiple different representations of the same email
166 # 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
167 #
46f30f9 @lifo Merge documentation changes from docrails.
lifo authored May 16, 2008
168 # Implicit template rendering is not performed if any attachments or parts have been added to the email.
169 # This means that you'll have to manually add each part to the email and set the content type of the email
170 # to <tt>multipart/alternative</tt>.
20bd4bd @dhh Updated docs and otherwise
dhh authored Sep 2, 2006
171 #
0a407bc ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, …
Marcel Molina authored May 10, 2006
172 # = Attachments
20bd4bd @dhh Updated docs and otherwise
dhh authored Sep 2, 2006
173 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
174 # You can see above how to make a multipart HTML / Text email, to send attachments is just
175 # as easy:
0a407bc ActionMailer::Base documentation rewrite. Closes #4991 [Kevin Clark, …
Marcel Molina authored May 10, 2006
176 #
177 # class ApplicationMailer < ActionMailer::Base
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
178 # def welcome(recipient)
3762362 @mikel Updating readme for ActionMailer::Base
mikel authored Jun 8, 2010
179 # attachments['free_book.pdf'] = File.read('path/to/file.pdf')
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
180 # mail(:to => recipient, :subject => "New account information")
db045db @dhh Initial
dhh authored Nov 24, 2004
181 # end
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Infl…
josh authored May 14, 2008
182 # end
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
183 #
bb2c7b4 @mikel Updating Action Mailer documentation
mikel authored Jan 29, 2010
184 # Which will (if it had both a <tt>welcome.text.plain.erb</tt> and <tt>welcome.text.html.erb</tt>
ccf9577 @dolzenko Fix a bunch of minor spelling mistakes
dolzenko authored Jun 11, 2010
185 # template in the view directory), send a complete <tt>multipart/mixed</tt> email with two parts,
bb2c7b4 @mikel Updating Action Mailer documentation
mikel authored Jan 29, 2010
186 # the first part being a <tt>multipart/alternative</tt> with the text and HTML email parts inside,
187 # and the second being a <tt>application/pdf</tt> with a Base64 encoded copy of the file.pdf book
188 # with the filename +free_book.pdf+.
c927aa0 @dhh Updated documentation
dhh authored Dec 16, 2004
189 #
3762362 @mikel Updating readme for ActionMailer::Base
mikel authored Jun 8, 2010
190 # = Inline Attachments
191 #
192 # You can also specify that a file should be displayed inline with other HTML. For example a
193 # corporate logo or a photo or the like.
194 #
195 # To do this is simple, in the Mailer:
196 #
197 # class ApplicationMailer < ActionMailer::Base
198 # def welcome(recipient)
199 # attachments.inline['photo.png'] = File.read('path/to/photo.png')
200 # mail(:to => recipient, :subject => "Here is what we look like")
201 # end
202 # end
203 #
204 # And then to reference the image in the view, you create a <tt>welcome.html.erb</tt> file and
205 # make a call to +image_tag+ passing in the attachment you want to display and then call
206 # +url+ on the attachment to get the relative content id path for the image source:
207 #
208 # <h1>Please Don't Cringe</h1>
209 #
210 # <%= image_tag attachments['photo.png'].url -%>
211 #
f17159b @fxn edit pass: the names of Rails components have a space, ie, "Active Re…
fxn authored Jun 14, 2010
212 # As we are using Action View's +image_tag+ method, you can pass in any other options you want:
3762362 @mikel Updating readme for ActionMailer::Base
mikel authored Jun 8, 2010
213 #
214 # <h1>Please Don't Cringe</h1>
215 #
216 # <%= image_tag attachments['photo.png'].url, :alt => 'Our Photo', :class => 'photo' -%>
217 #
cefc136 @mikel Adding options to register observers and interceptors through ActionM…
mikel authored Feb 22, 2010
218 # = Observing and Intercepting Mails
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
219 #
058f7fe @mikel Cleaning up Action Mailer spelling with and without the space
mikel authored May 2, 2010
220 # Action Mailer provides hooks into the Mail observer and interceptor methods. These allow you to
cefc136 @mikel Adding options to register observers and interceptors through ActionM…
mikel authored Feb 22, 2010
221 # register objects that are called during the mail delivery life cycle.
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
222 #
cefc136 @mikel Adding options to register observers and interceptors through ActionM…
mikel authored Feb 22, 2010
223 # An observer object must implement the <tt>:delivered_email(message)</tt> method which will be
224 # called once for every email sent after the email has been sent.
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
225 #
cefc136 @mikel Adding options to register observers and interceptors through ActionM…
mikel authored Feb 22, 2010
226 # An interceptor object must implement the <tt>:delivering_email(message)</tt> method which will be
227 # called before the email is sent, allowing you to make modifications to the email before it hits
228 # the delivery agents. Your object should make and needed modifications directly to the passed
229 # in Mail::Message instance.
20bd4bd @dhh Updated docs and otherwise
dhh authored Sep 2, 2006
230 #
fb30feb @mikel Adding more docs to ActionMailer
mikel authored May 2, 2010
231 # = Default Hash
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
232 #
058f7fe @mikel Cleaning up Action Mailer spelling with and without the space
mikel authored May 2, 2010
233 # Action Mailer provides some intelligent defaults for your emails, these are usually specified in a
fb30feb @mikel Adding more docs to ActionMailer
mikel authored May 2, 2010
234 # default method inside the class definition:
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
235 #
fb30feb @mikel Adding more docs to ActionMailer
mikel authored May 2, 2010
236 # class Notifier < ActionMailer::Base
237 # default :sender => 'system@example.com'
238 # end
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
239 #
fb30feb @mikel Adding more docs to ActionMailer
mikel authored May 2, 2010
240 # You can pass in any header value that a <tt>Mail::Message</tt>, out of the box, <tt>ActionMailer::Base</tt>
241 # sets the following:
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
242 #
fb30feb @mikel Adding more docs to ActionMailer
mikel authored May 2, 2010
243 # * <tt>:mime_version => "1.0"</tt>
244 # * <tt>:charset => "UTF-8",</tt>
245 # * <tt>:content_type => "text/plain",</tt>
246 # * <tt>:parts_order => [ "text/plain", "text/enriched", "text/html" ]</tt>
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
247 #
fb30feb @mikel Adding more docs to ActionMailer
mikel authored May 2, 2010
248 # <tt>parts_order</tt> and <tt>charset</tt> are not actually valid <tt>Mail::Message</tt> header fields,
058f7fe @mikel Cleaning up Action Mailer spelling with and without the space
mikel authored May 2, 2010
249 # but Action Mailer translates them appropriately and sets the correct values.
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
250 #
fb30feb @mikel Adding more docs to ActionMailer
mikel authored May 2, 2010
251 # As you can pass in any header, you need to either quote the header as a string, or pass it in as
252 # an underscorised symbol, so the following will work:
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
253 #
fb30feb @mikel Adding more docs to ActionMailer
mikel authored May 2, 2010
254 # class Notifier < ActionMailer::Base
255 # default 'Content-Transfer-Encoding' => '7bit',
256 # :content_description => 'This is a description'
257 # end
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
258 #
058f7fe @mikel Cleaning up Action Mailer spelling with and without the space
mikel authored May 2, 2010
259 # Finally, Action Mailer also supports passing <tt>Proc</tt> objects into the default hash, so you
fb30feb @mikel Adding more docs to ActionMailer
mikel authored May 2, 2010
260 # can define methods that evaluate as the message is being generated:
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
261 #
fb30feb @mikel Adding more docs to ActionMailer
mikel authored May 2, 2010
262 # class Notifier < ActionMailer::Base
263 # default 'X-Special-Header' => Proc.new { my_method }
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
264 #
fb30feb @mikel Adding more docs to ActionMailer
mikel authored May 2, 2010
265 # private
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
266 #
fb30feb @mikel Adding more docs to ActionMailer
mikel authored May 2, 2010
267 # def my_method
268 # 'some complex call'
269 # end
270 # end
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
271 #
fb30feb @mikel Adding more docs to ActionMailer
mikel authored May 2, 2010
272 # Note that the proc is evaluated right at the start of the mail message generation, so if you
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
273 # set something in the defaults using a proc, and then set the same thing inside of your
fb30feb @mikel Adding more docs to ActionMailer
mikel authored May 2, 2010
274 # mailer method, it will get over written by the mailer method.
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
275 #
c927aa0 @dhh Updated documentation
dhh authored Dec 16, 2004
276 # = Configuration options
277 #
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
278 # These options are specified on the class level, like
fb30feb @mikel Adding more docs to ActionMailer
mikel authored May 2, 2010
279 # <tt>ActionMailer::Base.template_root = "/my/templates"</tt>
c927aa0 @dhh Updated documentation
dhh authored Dec 16, 2004
280 #
fb30feb @mikel Adding more docs to ActionMailer
mikel authored May 2, 2010
281 # * <tt>default</tt> - You can pass this in at a class level as well as within the class itself as
282 # per the above section.
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
283 #
c927aa0 @dhh Updated documentation
dhh authored Dec 16, 2004
284 # * <tt>logger</tt> - the logger is used for generating information on the mailing run if available.
285 # Can be set to nil for no logging. Compatible with both Ruby's own Logger and Log4r loggers.
286 #
64092de @fxn Improve documentation coverage and markup
fxn authored May 2, 2008
287 # * <tt>smtp_settings</tt> - Allows detailed configuration for <tt>:smtp</tt> delivery method:
bb2c7b4 @mikel Updating Action Mailer documentation
mikel authored Jan 29, 2010
288 # * <tt>:address</tt> - Allows you to use a remote mail server. Just change it from its default
289 # "localhost" setting.
dc4eec1 @lifo Merge docrails:
lifo authored May 9, 2008
290 # * <tt>:port</tt> - On the off chance that your mail server doesn't run on port 25, you can change it.
291 # * <tt>:domain</tt> - If you need to specify a HELO domain, you can do it here.
292 # * <tt>:user_name</tt> - If your mail server requires authentication, set the username in this setting.
293 # * <tt>:password</tt> - If your mail server requires authentication, set the password in this setting.
bb2c7b4 @mikel Updating Action Mailer documentation
mikel authored Jan 29, 2010
294 # * <tt>:authentication</tt> - If your mail server requires authentication, you need to specify the
295 # authentication type here.
46f30f9 @lifo Merge documentation changes from docrails.
lifo authored May 16, 2008
296 # This is a symbol and one of <tt>:plain</tt>, <tt>:login</tt>, <tt>:cram_md5</tt>.
bb2c7b4 @mikel Updating Action Mailer documentation
mikel authored Jan 29, 2010
297 # * <tt>:enable_starttls_auto</tt> - When set to true, detects if STARTTLS is enabled in your SMTP server
298 # and starts to use it.
c927aa0 @dhh Updated documentation
dhh authored Dec 16, 2004
299 #
46f30f9 @lifo Merge documentation changes from docrails.
lifo authored May 16, 2008
300 # * <tt>sendmail_settings</tt> - Allows you to override options for the <tt>:sendmail</tt> delivery method.
301 # * <tt>:location</tt> - The location of the sendmail executable. Defaults to <tt>/usr/sbin/sendmail</tt>.
bb2c7b4 @mikel Updating Action Mailer documentation
mikel authored Jan 29, 2010
302 # * <tt>:arguments</tt> - The command line arguments. Defaults to <tt>-i -t</tt> with <tt>-f sender@addres</tt>
303 # added automatically before the message is sent.
dc4eec1 @lifo Merge docrails:
lifo authored May 9, 2008
304 #
fbe6c3c @edavis10 Adds a :file delivery_method to save email to a file on disk
edavis10 authored Aug 7, 2009
305 # * <tt>file_settings</tt> - Allows you to override options for the <tt>:file</tt> delivery method.
bb2c7b4 @mikel Updating Action Mailer documentation
mikel authored Jan 29, 2010
306 # * <tt>:location</tt> - The directory into which emails will be written. Defaults to the application
307 # <tt>tmp/mails</tt>.
fbe6c3c @edavis10 Adds a :file delivery_method to save email to a file on disk
edavis10 authored Aug 8, 2009
308 #
dc4eec1 @lifo Merge docrails:
lifo authored May 9, 2008
309 # * <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
310 #
bb2c7b4 @mikel Updating Action Mailer documentation
mikel authored Jan 29, 2010
311 # * <tt>delivery_method</tt> - Defines a delivery method. Possible values are <tt>:smtp</tt> (default),
312 # <tt>:sendmail</tt>, <tt>:test</tt>, and <tt>:file</tt>. Or you may provide a custom delivery method
313 # object eg. MyOwnDeliveryMethodClass.new. See the Mail gem documentation on the interface you need to
314 # implement for a custom delivery agent.
c927aa0 @dhh Updated documentation
dhh authored Dec 16, 2004
315 #
bb2c7b4 @mikel Updating Action Mailer documentation
mikel authored Jan 29, 2010
316 # * <tt>perform_deliveries</tt> - Determines whether emails are actually sent from Action Mailer when you
317 # call <tt>.deliver</tt> on an mail message or on an Action Mailer method. This is on by default but can
318 # be turned off to aid in functional testing.
c927aa0 @dhh Updated documentation
dhh authored Dec 16, 2004
319 #
bb2c7b4 @mikel Updating Action Mailer documentation
mikel authored Jan 29, 2010
320 # * <tt>deliveries</tt> - Keeps an array of all the emails sent out through the Action Mailer with
321 # <tt>delivery_method :test</tt>. Most useful for unit and functional testing.
af56c80 @dhh Updated documentation
dhh authored Feb 24, 2005
322 #
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
323 # * <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 27, 2010
324 # set the default +:charset+.
c2e7851 @josevalim Add ActionMailer::Base#enable_starttls_auto option for enabling/disab…
josevalim authored Jan 11, 2009
325 #
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
326 # * <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
327 # to set the default +:content_type+.
c2e7851 @josevalim Add ActionMailer::Base#enable_starttls_auto option for enabling/disab…
josevalim authored Jan 11, 2009
328 #
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
329 # * <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
330 # to set the default +:mime_version+.
c2e7851 @josevalim Add ActionMailer::Base#enable_starttls_auto option for enabling/disab…
josevalim authored Jan 11, 2009
331 #
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
332 # * <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
333 # to set the default +:parts_order+. Parts Order is used when a message is built implicitly
334 # (i.e. multiple parts are assembled from templates which specify the content type in their
335 # filenames) this variable controls how the parts are ordered.
4964d3b @josevalim Make ActionMailer::Base inherit from AbstractController::Base
josevalim authored Dec 22, 2009
336 class Base < AbstractController::Base
dbcf01e @mikel Removing quoting.rb, upgrade to 2.1.3.6, changing all utf-8 reference…
mikel authored Apr 8, 2010
337 include DeliveryMethods
f30d73b Add new class delivery method API.
José Valim and Mikel Lindsaar authored Jan 24, 2010
338 abstract!
339
c03c40b @josevalim Expose a _render_partial hook as thhe _render_template one and make u…
josevalim authored Dec 31, 2009
340 include AbstractController::Logger
83f4d86 @dhh Rename the RenderingController module to just plain Rendering
dhh authored Dec 20, 2009
341 include AbstractController::Rendering
a9751a7 @josevalim Refactor ActionMailer layout and remove legacy one.
josevalim authored Oct 17, 2009
342 include AbstractController::Layouts
684c2dc @josevalim Remove ActionMailer helpers and rely on AbstractController one.
josevalim authored Oct 18, 2009
343 include AbstractController::Helpers
48a3985 @josevalim Also include translation in ActionMailer.
josevalim authored Jan 26, 2010
344 include AbstractController::Translation
08baa34 @dhh Extract assets paths and make them available to Action Mailer as well
dhh authored Jun 2, 2010
345 include AbstractController::AssetPaths
359caef @jamis A very thorough refactoring, resulting in new mail property setters a…
jamis authored May 29, 2005
346
ee70d1b @josevalim adv_attr_accessors in ActionMailer are not sent to the views, use the…
josevalim authored Dec 25, 2009
347 helper ActionMailer::MailHelper
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored Jan 24, 2010
348
5dead5b Maintain old_api and deprecated_api in different files.
José Valim and Mikel Lindsaar authored Jan 24, 2010
349 include ActionMailer::OldApi
f30d73b Add new class delivery method API.
José Valim and Mikel Lindsaar authored Jan 24, 2010
350 include ActionMailer::DeprecatedApi
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
351
cefc136 @mikel Adding options to register observers and interceptors through ActionM…
mikel authored Feb 22, 2010
352 delegate :register_observer, :to => Mail
353 delegate :register_interceptor, :to => Mail
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored Jan 24, 2010
354
c927aa0 @dhh Updated documentation
dhh authored Dec 16, 2004
355 private_class_method :new #:nodoc:
db045db @dhh Initial
dhh authored Nov 24, 2004
356
e5ab4b0 @jeremy Convert to class_attribute
jeremy authored Jan 31, 2010
357 class_attribute :default_params
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored Jan 26, 2010
358 self.default_params = {
359 :mime_version => "1.0",
dbcf01e @mikel Removing quoting.rb, upgrade to 2.1.3.6, changing all utf-8 reference…
mikel authored Apr 8, 2010
360 :charset => "UTF-8",
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored Jan 26, 2010
361 :content_type => "text/plain",
362 :parts_order => [ "text/plain", "text/enriched", "text/html" ]
e5ab4b0 @jeremy Convert to class_attribute
jeremy authored Feb 1, 2010
363 }.freeze
e1c1318 Added delivers_from.
José Valim and Mikel Lindsaar authored Jan 25, 2010
364
eda1719 @jamis ActionMailer::Base.deliver(email) had been accidentally removed, but …
jamis authored Jul 31, 2005
365 class << self
0b05acd @mikel Implementing class level :defaults hash, instead of delivers_from et al
mikel authored Jan 26, 2010
366
bd5ed65 @technoweenie Update ActionMailer so it treats ActionView the same way that ActionC…
technoweenie authored Nov 26, 2007
367 def mailer_name
368 @mailer_name ||= name.underscore
369 end
0750304 @mikel Migrated over to Mail doing delivery.
mikel authored Jan 16, 2010
370 attr_writer :mailer_name
371 alias :controller_path :mailer_name
81c416b @josevalim More refactoring on ActionMailer::Base.
josevalim authored Oct 28, 2009
372
e5ab4b0 @jeremy Convert to class_attribute
jeremy authored Feb 1, 2010
373 def default(value = nil)
374 self.default_params = default_params.merge(value).freeze if value
375 default_params
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored Jan 26, 2010
376 end
377
59f1df1 @jamis Update/extend ActionMailer documentation (rdoc)
jamis authored Oct 16, 2005
378 # Receives a raw email, parses it into an email object, decodes it,
379 # instantiates a new mailer, and passes the email object to the mailer
98dc582 @lifo Merge docrails.
lifo authored May 25, 2008
380 # object's +receive+ method. If you want your mailer to be able to
381 # process incoming messages, you'll need to implement a +receive+
bb2c7b4 @mikel Updating Action Mailer documentation
mikel authored Jan 29, 2010
382 # method that accepts the raw email string as a parameter:
59f1df1 @jamis Update/extend ActionMailer documentation (rdoc)
jamis authored Oct 16, 2005
383 #
384 # class MyMailer < ActionMailer::Base
385 # def receive(mail)
386 # ...
387 # end
388 # end
704daad @josevalim Ensure we just send Ruby Stdlib objects in ActionMailer notifications.
josevalim authored Jan 15, 2010
389 def receive(raw_mail)
731d439 @jaggederest Change event namespace ordering to most-significant first [#4504 stat…
jaggederest authored Apr 27, 2010
390 ActiveSupport::Notifications.instrument("receive.action_mailer") do |payload|
704daad @josevalim Ensure we just send Ruby Stdlib objects in ActionMailer notifications.
josevalim authored Jan 15, 2010
391 mail = Mail.new(raw_mail)
392 set_payload_for_mail(payload, mail)
2a6bc12 @josevalim Add subscriber to ActionMailer.
josevalim authored Jan 13, 2010
393 new.receive(mail)
394 end
eda1719 @jamis ActionMailer::Base.deliver(email) had been accidentally removed, but …
jamis authored Jul 31, 2005
395 end
396
bb2c7b4 @mikel Updating Action Mailer documentation
mikel authored Jan 29, 2010
397 # Wraps an email delivery inside of Active Support Notifications instrumentation. This
de65c82 @rizwanreza Changes call backs to callbacks.
rizwanreza authored Jun 15, 2010
398 # method is actually called by the <tt>Mail::Message</tt> object itself through a callback
bb2c7b4 @mikel Updating Action Mailer documentation
mikel authored Jan 29, 2010
399 # when you call <tt>:deliver</tt> on the Mail::Message, calling +deliver_mail+ directly
400 # and passing a Mail::Message will do nothing except tell the logger you sent the email.
e4a989e Added delivery_handler method to mail and implemented in ActionMailer…
José Valim and Mikel Lindsaar authored Jan 25, 2010
401 def deliver_mail(mail) #:nodoc:
731d439 @jaggederest Change event namespace ordering to most-significant first [#4504 stat…
jaggederest authored Apr 28, 2010
402 ActiveSupport::Notifications.instrument("deliver.action_mailer") do |payload|
258ca14 Delegated ActionMailer::Base.deliveries to Mail.deliveries, added cal…
José Valim and Mikel Lindsaar authored Jan 24, 2010
403 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
404 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
405 end
406 end
407
99f960a Handle some TODOs and deprecations.
José Valim and Mikel Lindsaar authored Jan 24, 2010
408 def respond_to?(method, *args) #:nodoc:
409 super || action_methods.include?(method.to_s)
410 end
411
412 protected
413
704daad @josevalim Ensure we just send Ruby Stdlib objects in ActionMailer notifications.
josevalim authored Jan 15, 2010
414 def set_payload_for_mail(payload, mail) #:nodoc:
99f960a Handle some TODOs and deprecations.
José Valim and Mikel Lindsaar authored Jan 24, 2010
415 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
416 payload[:message_id] = mail.message_id
417 payload[:subject] = mail.subject
418 payload[:to] = mail.to
419 payload[:from] = mail.from
420 payload[:bcc] = mail.bcc if mail.bcc.present?
421 payload[:cc] = mail.cc if mail.cc.present?
422 payload[:date] = mail.date
423 payload[:mail] = mail.encoded
704daad @josevalim Ensure we just send Ruby Stdlib objects in ActionMailer notifications.
josevalim authored Jan 15, 2010
424 end
f30d73b Add new class delivery method API.
José Valim and Mikel Lindsaar authored Jan 24, 2010
425
99f960a Handle some TODOs and deprecations.
José Valim and Mikel Lindsaar authored Jan 24, 2010
426 def method_missing(method, *args) #:nodoc:
f30d73b Add new class delivery method API.
José Valim and Mikel Lindsaar authored Jan 24, 2010
427 if action_methods.include?(method.to_s)
428 new(method, *args).message
429 else
430 super
431 end
432 end
eda1719 @jamis ActionMailer::Base.deliver(email) had been accidentally removed, but …
jamis authored Jul 31, 2005
433 end
434
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored Jan 24, 2010
435 attr_internal :message
436
6ba9446 Make implicit and explicit templates pass through the same part creat…
José Valim and Mikel Lindsaar authored Jan 23, 2010
437 # Instantiate a new mailer object. If +method_name+ is not +nil+, the mailer
438 # will be initialized according to the named method. If not, the mailer will
439 # remain uninitialized (useful when you only need to invoke the "receive"
440 # method, for instance).
441 def initialize(method_name=nil, *args)
442 super()
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored Jan 24, 2010
443 @_message = Mail.new
6ba9446 Make implicit and explicit templates pass through the same part creat…
José Valim and Mikel Lindsaar authored Jan 23, 2010
444 process(method_name, *args) if method_name
445 end
446
3fc609e @josevalim Fix ActionMailer test broken in 99d5459
josevalim authored Apr 12, 2010
447 def process(*args) #:nodoc:
448 lookup_context.skip_default_locale!
449 super
450 end
451
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
452 # Allows you to pass random and unusual headers to the new +Mail::Message+ object
453 # which will add them to itself.
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
454 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
455 # headers['X-Special-Domain-Specific-Header'] = "SecretValue"
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
456 #
9520166 @mikel Fixed up being able to pass random headers in with headers, or mail. …
mikel authored Jan 26, 2010
457 # You can also pass a hash into headers of header field names and values, which
458 # will then be set on the Mail::Message object:
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
459 #
05c4ad9 Tidy up tests and docs.
José Valim and Mikel Lindsaar authored Jan 26, 2010
460 # headers 'X-Special-Domain-Specific-Header' => "SecretValue",
461 # 'In-Reply-To' => incoming.message_id
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
462 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
463 # The resulting Mail::Message will have the following in it's header:
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
464 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
465 # X-Special-Domain-Specific-Header: SecretValue
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored Jan 24, 2010
466 def headers(args=nil)
467 if args
9520166 @mikel Fixed up being able to pass random headers in with headers, or mail. …
mikel authored Jan 26, 2010
468 @_message.headers(args)
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored Jan 24, 2010
469 else
470 @_message
471 end
472 end
c34cfcc @mikel Created mail method for new API
mikel authored Jan 20, 2010
473
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
474 # Allows you to add attachments to an email, like so:
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
475 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
476 # mail.attachments['filename.jpg'] = File.read('/path/to/filename.jpg')
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
477 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
478 # If you do this, then Mail will take the file name and work out the mime type
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
479 # set the Content-Type, Content-Disposition, Content-Transfer-Encoding and
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
480 # base64 encode the contents of the attachment all for you.
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
481 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
482 # You can also specify overrides if you want by passing a hash instead of a string:
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
483 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
484 # mail.attachments['filename.jpg'] = {:mime_type => 'application/x-gzip',
485 # :content => File.read('/path/to/filename.jpg')}
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
486 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
487 # If you want to use a different encoding than Base64, you can pass an encoding in,
488 # but then it is up to you to pass in the content pre-encoded, and don't expect
489 # Mail to know how to decode this data:
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
490 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
491 # file_content = SpecialEncode(File.read('/path/to/filename.jpg'))
492 # mail.attachments['filename.jpg'] = {:mime_type => 'application/x-gzip',
493 # :encoding => 'SpecialEncoding',
494 # :content => file_content }
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
495 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
496 # You can also search for specific attachments:
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
497 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
498 # # By Filename
755af49 @fxn edit pass to apply API guideline wrt the use of "# =>" in example code
fxn authored Jul 30, 2010
499 # mail.attachments['filename.jpg'] # => Mail::Part object or nil
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
500 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
501 # # or by index
755af49 @fxn edit pass to apply API guideline wrt the use of "# =>" in example code
fxn authored Jul 30, 2010
502 # mail.attachments[0] # => Mail::Part (first attachment)
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
503 #
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored Jan 24, 2010
504 def attachments
505 @_message.attachments
506 end
dcb9253 Add basic template rendering to new DSL.
José Valim and Mikel Lindsaar authored Jan 22, 2010
507
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
508 # The main method that creates the message and renders the email templates. There are
509 # two ways to call this method, with a block, or without a block.
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
510 #
6589976 Remove old files, add some information to docs and improve test suite.
José Valim and Mikel Lindsaar authored Jan 26, 2010
511 # 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
512 # in an email message, these are:
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
513 #
058f7fe @mikel Cleaning up Action Mailer spelling with and without the space
mikel authored May 2, 2010
514 # * <tt>:subject</tt> - The subject of the message, if this is omitted, Action Mailer will
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
515 # ask the Rails I18n class for a translated <tt>:subject</tt> in the scope of
516 # <tt>[:actionmailer, mailer_scope, action_name]</tt> or if this is missing, will translate the
517 # humanized version of the <tt>action_name</tt>
518 # * <tt>:to</tt> - Who the message is destined for, can be a string of addresses, or an array
519 # of addresses.
0b05acd @mikel Implementing class level :defaults hash, instead of delivers_from et al
mikel authored Jan 26, 2010
520 # * <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
521 # * <tt>:cc</tt> - Who you would like to Carbon-Copy on this email, can be a string of addresses,
522 # or an array of addresses.
523 # * <tt>:bcc</tt> - Who you would like to Blind-Carbon-Copy on this email, can be a string of
524 # addresses, or an array of addresses.
525 # * <tt>:reply_to</tt> - Who to set the Reply-To header of the email to.
526 # * <tt>:date</tt> - The date to say the email was sent on.
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
527 #
528 # 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
529 # class method:
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
530 #
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored Jan 26, 2010
531 # class Notifier < ActionMailer::Base
452bb1e @jeremy Rename 'defaults' class method to 'default' to reflect that it's a de…
jeremy authored Jan 28, 2010
532 # self.default :from => 'no-reply@test.lindsaar.net',
533 # :bcc => 'email_logger@test.lindsaar.net',
534 # :reply_to => 'bounces@test.lindsaar.net'
0b05acd @mikel Implementing class level :defaults hash, instead of delivers_from et al
mikel authored Jan 26, 2010
535 # end
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
536 #
52c56f9 @wincent docs: note that mail() accepts arbitrary headers
wincent authored Jun 29, 2010
537 # If you need other headers not listed above, you can either pass them in
538 # as part of the headers hash or use the <tt>headers['name'] = value</tt>
539 # method.
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
540 #
6589976 Remove old files, add some information to docs and improve test suite.
José Valim and Mikel Lindsaar authored Jan 26, 2010
541 # 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
542 # address for the Mail message. Setting this is useful when you want delivery notifications
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
543 # sent to a different address than the one in <tt>:from</tt>. Mail will actually use the
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
544 # <tt>:return_path</tt> in preference to the <tt>:sender</tt> in preference to the <tt>:from</tt>
545 # field for the 'envelope from' value.
546 #
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
547 # If you do not pass a block to the +mail+ method, it will find all templates in the
be35a15 @josevalim Allow to choose the template path and template name used in implicit …
josevalim authored Feb 19, 2010
548 # view paths using by default the mailer name and the method name that it is being
549 # called from, it will then create parts for each of these templates intelligently,
550 # making educated guesses on correct content type and sequence, and return a fully
551 # prepared Mail::Message ready to call <tt>:deliver</tt> on to send.
552 #
553 # For example:
554 #
555 # class Notifier < ActionMailer::Base
556 # default :from => 'no-reply@test.lindsaar.net',
557 #
558 # def welcome
559 # mail(:to => 'mikel@test.lindsaar.net')
560 # end
561 # end
562 #
563 # Will look for all templates at "app/views/notifier" with name "welcome". However, those
564 # can be customized:
565 #
566 # mail(:template_path => 'notifications', :template_name => 'another')
567 #
568 # And now it will look for all templates at "app/views/notifications" with name "another".
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
569 #
570 # If you do pass a block, you can render specific templates of your choice:
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
571 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
572 # mail(:to => 'mikel@test.lindsaar.net') do |format|
573 # format.text
574 # format.html
575 # end
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
576 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
577 # You can even render text directly without using a template:
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
578 #
4a6eba3 Added initial documentation for the new API
José Valim and Mikel Lindsaar authored Jan 25, 2010
579 # mail(:to => 'mikel@test.lindsaar.net') do |format|
580 # format.text { render :text => "Hello Mikel!" }
581 # format.html { render :text => "<h1>Hello Mikel!</h1>" }
582 # end
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
583 #
74a5889 Refactor content type setting, added tests to ensure boundary exists …
José Valim and Mikel Lindsaar authored Jan 26, 2010
584 # 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
585 # <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
586 #
587 # The block syntax also allows you to customize the part headers if desired:
588 #
589 # mail(:to => 'mikel@test.lindsaar.net') do |format|
590 # format.text(:content_transfer_encoding => "base64")
591 # format.html
592 # end
593 #
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored Jan 24, 2010
594 def mail(headers={}, &block)
595 # Guard flag to prevent both the old and the new API from firing
596 # Should be removed when old API is removed
597 @mail_was_called = true
598 m = @_message
258ca14 Delegated ActionMailer::Base.deliveries to Mail.deliveries, added cal…
José Valim and Mikel Lindsaar authored Jan 24, 2010
599
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored Jan 26, 2010
600 # At the beginning, do not consider class default for parts order neither content_type
601 content_type = headers[:content_type]
602 parts_order = headers[:parts_order]
1cd5592 First work on implicit multipart.
José Valim and Mikel Lindsaar authored Jan 22, 2010
603
08b07b6 @mikel Adding ability to pass proc's to the ActionMailer class default method
mikel authored May 2, 2010
604 # Call all the procs (if any)
605 default_values = self.class.default.merge(self.class.default) do |k,v|
ceaa100 @mikel Adding ability for the procs to be called within the instance, allows…
mikel authored May 2, 2010
606 v.respond_to?(:call) ? v.bind(self).call : v
08b07b6 @mikel Adding ability to pass proc's to the ActionMailer class default method
mikel authored May 2, 2010
607 end
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
608
b5f9a9f @josevalim Move set_fields! to the old API module.
josevalim authored Apr 12, 2010
609 # Handle defaults
08b07b6 @mikel Adding ability to pass proc's to the ActionMailer class default method
mikel authored May 2, 2010
610 headers = headers.reverse_merge(default_values)
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored Jan 26, 2010
611 headers[:subject] ||= default_i18n_subject
b5f9a9f @josevalim Move set_fields! to the old API module.
josevalim authored Apr 12, 2010
612
613 # Apply charset at the beginning so all fields are properly quoted
614 m.charset = charset = headers[:charset]
615
616 # Set configure delivery behavior
617 wrap_delivery_behavior!(headers.delete(:delivery_method))
618
619 # Assign all headers except parts_order, content_type and body
b4fd5e6 @josevalim template_name and template_path should not be added to mail headers.
josevalim authored Apr 13, 2010
620 assignable = headers.except(:parts_order, :content_type, :body, :template_name, :template_path)
b5f9a9f @josevalim Move set_fields! to the old API module.
josevalim authored Apr 12, 2010
621 assignable.each { |k, v| m[k] = v }
951397b Get implicit multipart and attachments working together.
José Valim and Mikel Lindsaar authored Jan 22, 2010
622
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored Jan 24, 2010
623 # Render the templates and blocks
39a1b06 Deprecate old defaults API.
José Valim and Mikel Lindsaar authored Jan 26, 2010
624 responses, explicit_order = collect_responses_and_parts_order(headers, &block)
b5f9a9f @josevalim Move set_fields! to the old API module.
josevalim authored Apr 12, 2010
625 create_parts_from_responses(m, responses)
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored Jan 24, 2010
626
b5f9a9f @josevalim Move set_fields! to the old API module.
josevalim authored Apr 12, 2010
627 # Setup content type, reapply charset and handle parts order
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored Jan 26, 2010
628 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
629 m.charset = charset
630
e7e4ed4 Set sort order for explicit parts from the collector's template sequence
José Valim and Mikel Lindsaar authored Jan 24, 2010
631 if m.multipart?
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored Jan 26, 2010
632 parts_order ||= explicit_order || headers[:parts_order]
633 m.body.set_sort_order(parts_order)
951397b Get implicit multipart and attachments working together.
José Valim and Mikel Lindsaar authored Jan 22, 2010
634 m.body.sort_parts!
635 end
bb9d71f Move class methods to deprecated stuff.
José Valim and Mikel Lindsaar authored Jan 22, 2010
636
c34cfcc @mikel Created mail method for new API
mikel authored Jan 20, 2010
637 m
638 end
639
6ba9446 Make implicit and explicit templates pass through the same part creat…
José Valim and Mikel Lindsaar authored Jan 23, 2010
640 protected
641
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored Jan 26, 2010
642 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
643 params = m.content_type_parameters || {}
644 case
645 when user_content_type.present?
646 user_content_type
647 when m.has_attachments?
311d99e @mikel Adding inline attachment support to ActionMailer
mikel authored Jun 7, 2010
648 if m.attachments.detect { |a| a.inline? }
649 ["multipart", "related", params]
650 else
651 ["multipart", "mixed", params]
652 end
74a5889 Refactor content type setting, added tests to ensure boundary exists …
José Valim and Mikel Lindsaar authored Jan 26, 2010
653 when m.multipart?
654 ["multipart", "alternative", params]
655 else
b6b3db6 @mikel Fixed bug on HTML only emails getting set to text/plain
mikel authored Jan 28, 2010
656 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
657 end
658 end
659
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored Jan 26, 2010
660 def default_i18n_subject #:nodoc:
5c3ef8c Refactor subject with i18n.
José Valim and Mikel Lindsaar authored Jan 23, 2010
661 mailer_scope = self.class.mailer_name.gsub('/', '.')
30eaecb @josevalim subject is automatically looked up on I18n using mailer_name and acti…
josevalim authored Jun 12, 2010
662 I18n.t(:subject, :scope => [mailer_scope, action_name], :default => action_name.humanize)
5c3ef8c Refactor subject with i18n.
José Valim and Mikel Lindsaar authored Jan 23, 2010
663 end
664
39a1b06 Deprecate old defaults API.
José Valim and Mikel Lindsaar authored Jan 26, 2010
665 def collect_responses_and_parts_order(headers) #:nodoc:
666 responses, parts_order = [], nil
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored Jan 24, 2010
667
668 if block_given?
a09e992 @josevalim Ensure details are frozen after @details_keys lookup. The implementat…
josevalim authored Mar 27, 2010
669 collector = ActionMailer::Collector.new(lookup_context) { render(action_name) }
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored Jan 24, 2010
670 yield(collector)
39a1b06 Deprecate old defaults API.
José Valim and Mikel Lindsaar authored Jan 26, 2010
671 parts_order = collector.responses.map { |r| r[:content_type] }
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored Jan 24, 2010
672 responses = collector.responses
673 elsif headers[:body]
674 responses << {
be35a15 @josevalim Allow to choose the template path and template name used in implicit …
josevalim authored Feb 19, 2010
675 :body => headers.delete(:body),
452bb1e @jeremy Rename 'defaults' class method to 'default' to reflect that it's a de…
jeremy authored Jan 28, 2010
676 :content_type => self.class.default[:content_type] || "text/plain"
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored Jan 24, 2010
677 }
678 else
be35a15 @josevalim Allow to choose the template path and template name used in implicit …
josevalim authored Feb 19, 2010
679 templates_path = headers.delete(:template_path) || self.class.mailer_name
680 templates_name = headers.delete(:template_name) || action_name
681
682 each_template(templates_path, templates_name) do |template|
f28d856 @josevalim Improve performance of the rendering stack by freezing formats as a s…
josevalim authored Mar 19, 2010
683 self.formats = template.formats
684
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored Jan 24, 2010
685 responses << {
2a12686 @josevalim Allow anything that responds to render to be given as :template and u…
josevalim authored Mar 12, 2010
686 :body => render(:template => template),
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored Jan 24, 2010
687 :content_type => template.mime_type.to_s
688 }
689 end
690 end
691
39a1b06 Deprecate old defaults API.
José Valim and Mikel Lindsaar authored Jan 26, 2010
692 [responses, parts_order]
7409b73 Some refactoring.
José Valim and Mikel Lindsaar authored Jan 24, 2010
693 end
694
be35a15 @josevalim Allow to choose the template path and template name used in implicit …
josevalim authored Feb 19, 2010
695 def each_template(paths, name, &block) #:nodoc:
41af6d9 @jeremy Use Array.wrap not Array()
jeremy authored Mar 18, 2010
696 Array.wrap(paths).each do |path|
36eb1a6 @josevalim Bring AM up to date with new rendering stack.
josevalim authored Mar 8, 2010
697 templates = lookup_context.find_all(name, path)
00d6271 @josevalim Clean up the API required from ActionView::Template.
josevalim authored Mar 9, 2010
698 templates = templates.uniq_by { |t| t.formats }
0ece244 Ensure implicit multipart templates with locale works as expected.
José Valim and Mikel Lindsaar authored Jan 24, 2010
699
36eb1a6 @josevalim Bring AM up to date with new rendering stack.
josevalim authored Mar 8, 2010
700 unless templates.empty?
701 templates.each(&block)
702 return
99f960a Handle some TODOs and deprecations.
José Valim and Mikel Lindsaar authored Jan 24, 2010
703 end
704 end
705 end
706
b5f9a9f @josevalim Move set_fields! to the old API module.
josevalim authored Apr 12, 2010
707 def create_parts_from_responses(m, responses) #:nodoc:
6ba9446 Make implicit and explicit templates pass through the same part creat…
José Valim and Mikel Lindsaar authored Jan 23, 2010
708 if responses.size == 1 && !m.has_attachments?
9dd65c3 Make defaults accept a hash.
José Valim and Mikel Lindsaar authored Jan 26, 2010
709 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
710 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
711 container = Mail::Part.new
74a5889 Refactor content type setting, added tests to ensure boundary exists …
José Valim and Mikel Lindsaar authored Jan 26, 2010
712 container.content_type = "multipart/alternative"
b5f9a9f @josevalim Move set_fields! to the old API module.
josevalim authored Apr 12, 2010
713 responses.each { |r| insert_part(container, r, m.charset) }
6ba9446 Make implicit and explicit templates pass through the same part creat…
José Valim and Mikel Lindsaar authored Jan 23, 2010
714 m.add_part(container)
715 else
b5f9a9f @josevalim Move set_fields! to the old API module.
josevalim authored Apr 12, 2010
716 responses.each { |r| insert_part(m, r, m.charset) }
6ba9446 Make implicit and explicit templates pass through the same part creat…
José Valim and Mikel Lindsaar authored Jan 23, 2010
717 end
359caef @jamis A very thorough refactoring, resulting in new mail property setters a…
jamis authored May 29, 2005
718 end
719
6ba9446 Make implicit and explicit templates pass through the same part creat…
José Valim and Mikel Lindsaar authored Jan 23, 2010
720 def insert_part(container, response, charset) #:nodoc:
721 response[:charset] ||= charset
722 part = Mail::Part.new(response)
723 container.add_part(part)
359caef @jamis A very thorough refactoring, resulting in new mail property setters a…
jamis authored May 29, 2005
724 end
3fad0cd @dhh Added support for charsets for both subject and body. The default cha…
dhh authored Feb 19, 2005
725
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
726 module DeprecatedUrlOptions
727 def default_url_options
728 deprecated_url_options
729 end
730
731 def default_url_options=(val)
732 deprecated_url_options
733 end
734
735 def deprecated_url_options
736 raise "You can no longer call ActionMailer::Base.default_url_options " \
737 "directly. You need to set config.action_mailer.default_url_options. " \
738 "If you are using ActionMailer standalone, you need to include the " \
75b32a6 @wincent Fixes for "router" and "routes" terminology
wincent authored Jul 3, 2010
739 "routing url_helpers directly."
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
740 end
741 end
742
743 # This module will complain if the user tries to set default_url_options
f17159b @fxn edit pass: the names of Rails components have a space, ie, "Active Re…
fxn authored Jun 14, 2010
744 # directly instead of through the config object. In Action Mailer's Railtie,
75b32a6 @wincent Fixes for "router" and "routes" terminology
wincent authored Jul 3, 2010
745 # we include the router's url_helpers, which will override this module.
458f571 @wycats Remove the need for a special action_mailer.url_for initializer that …
wycats authored May 15, 2010
746 extend DeprecatedUrlOptions
747
ef5dada @nex3 Only run load hooks once a file has been fully loaded.
nex3 authored Apr 27, 2010
748 ActiveSupport.run_load_hooks(:action_mailer, self)
db045db @dhh Initial
dhh authored Nov 24, 2004
749 end
750 end
Something went wrong with that request. Please try again.