Class: ActionMailer::Base
- Inherits:
-
Object
- Object
- ActionMailer::Base
- Includes:
- AdvAttrAccessor, PartContainer
- Defined in:
- lib/action_mailer/base.rb
Overview
Usage:
class ApplicationMailer < ActionMailer::Base
# Set up properties
# (Properties can also be specified via accessor methods
# i.e. self.subject = "foo") and instance variables (@subject = "foo").
def signup_notification(recipient)
recipients recipient.email_address_with_name
subject "New account information"
body { "account" => recipient }
from "[email protected]"
end
# explicitly specify multipart messages
def signup_notification(recipient)
recipients recipient.email_address_with_name
subject "New account information"
from "[email protected]"
part :content_type => "text/html",
:body => ("signup-as-html", :account => recipient)
part "text/plain" do |p|
p.body = ("signup-as-plain", :account => recipient)
p.transfer_encoding = "base64"
end
end
# attachments
def signup_notification(recipient)
recipients recipient.email_address_with_name
subject "New account information"
from "[email protected]"
:content_type => "image/jpeg",
:body => File.read("an-image.jpg")
"application/pdf" do |a|
a.body = generate_your_pdf_here()
end
end
# implicitly multipart messages
def signup_notification(recipient)
recipients recipient.email_address_with_name
subject "New account information"
from "[email protected]"
body(:account => "recipient")
# ActionMailer will automatically detect and use multipart templates,
# where each template is named after the name of the action, followed
# by the content type. Each such detected template will be added as
# a separate part to the message.
#
# for example, if the following templates existed:
# * signup_notification.text.plain.rhtml
# * signup_notification.text.html.rhtml
# * signup_notification.text.xml.rxml
# * signup_notification.text.x-yaml.rhtml
#
# Each would be rendered and added as a separate part to the message,
# with the corresponding content type. The same body hash is passed to
# each template.
end
end
# After this post_notification will look for "templates/application_mailer/post_notification.rhtml"
ApplicationMailer.template_root = "templates"
ApplicationMailer.create_comment_notification(david, hello_world) # => a tmail object
ApplicationMailer.deliver_comment_notification(david, hello_world) # sends the email
Configuration options
These options are specified on the class level, like ActionMailer::Base.template_root = "/my/templates"
-
template_root
- template root determines the base from which template references will be made. -
logger
- the logger is used for generating information on the mailing run if available. Can be set to nil for no logging. Compatible with both Ruby’s own Logger and Log4r loggers. -
server_settings
- Allows detailed configuration of the server:-
:address
Allows you to use a remote mail server. Just change it away from it’s default “localhost” setting. -
:port
On the off change that your mail server doesn’t run on port 25, you can change it. -
:domain
If you need to specify a HELO domain, you can do it here. -
:user_name
If your mail server requires authentication, set the username and password in these two settings. -
:password
If your mail server requires authentication, set the username and password in these two settings. -
:authentication
If your mail server requires authentication, you need to specify the authentication type here. This is a symbol and one of :plain, :login, :cram_md5
-
-
raise_delivery_errors
- whether or not errors should be raised if the email fails to be delivered. -
delivery_method
- Defines a delivery method. Possible values are :smtp (default), :sendmail, and :test. Sendmail is assumed to be present at “/usr/sbin/sendmail”. -
perform_deliveries
- Determines whether deliver_* methods are actually carried out. By default they are, but this can be turned off to help functional testing. -
deliveries
- Keeps an array of all the emails sent out through the Action Mailer with delivery_method :test. Most useful for unit and functional testing. -
default_charset
- The default charset used for the body and to encode the subject. Defaults to UTF-8. You can also pick a different charset from inside a method with@charset
. -
default_content_type
- The default content type used for main part of the message. Defaults to “text/plain”. You can also pick a different content type from inside a method with@content_type
. -
default_implicit_parts_order
- When a message is built implicitly (i.e. multiple parts are assemble from templates which specify the content type in their filenames) this variable controls how the parts are ordered. Defaults to [“text/html”, “text/enriched”, “text/plain”]. Items that appear first in the array have higher priority in the mail client and appear last in the mime encoded message. You can also pick a different order from inside a method with@implicit_parts_order
.
Constant Summary collapse
- @@server_settings =
{ :address => "localhost", :port => 25, :domain => 'localhost.localdomain', :user_name => nil, :password => nil, :authentication => nil }
- @@raise_delivery_errors =
true
- @@delivery_method =
:smtp
- @@perform_deliveries =
true
- @@deliveries =
[]
- @@default_charset =
"utf-8"
- @@default_content_type =
"text/plain"
- @@default_implicit_parts_order =
[ "text/html", "text/enriched", "text/plain" ]
Instance Attribute Summary collapse
-
#mail ⇒ Object
readonly
Returns the value of attribute mail.
Attributes included from PartContainer
Class Method Summary collapse
Instance Method Summary collapse
-
#create!(method_name, *parameters) ⇒ Object
Initialize the mailer via the given
method_name
. -
#deliver! ⇒ Object
Delivers the cached TMail::Mail object.
-
#initialize(method_name = nil, *parameters) ⇒ Base
constructor
Instantiate a new mailer object.
Methods included from PartContainer
Methods included from AdvAttrAccessor
Constructor Details
#initialize(method_name = nil, *parameters) ⇒ Base
Instantiate a new mailer object. If method_name
is not nil
, the mailer will be initialized according to the named method. If not, the mailer will remain uninitialized (useful when you only need to invoke the “receive” method, for instance).
168 169 170 |
# File 'lib/action_mailer/base.rb', line 168 def initialize(method_name=nil, *parameters) #:nodoc: create!(method_name, *parameters) if method_name end |
Instance Attribute Details
#mail ⇒ Object (readonly)
Returns the value of attribute mail.
162 163 164 |
# File 'lib/action_mailer/base.rb', line 162 def mail @mail end |
Class Method Details
.method_missing(method_symbol, *parameters) ⇒ Object
:nodoc:
340 341 342 343 344 345 346 347 |
# File 'lib/action_mailer/base.rb', line 340 def method_missing(method_symbol, *parameters)#:nodoc: case method_symbol.id2name when /^create_([_a-z]\w*)/ then new($1, *parameters).mail when /^deliver_([_a-z]\w*)/ then new($1, *parameters).deliver! when "new" then nil else super end end |
Instance Method Details
#create!(method_name, *parameters) ⇒ Object
Initialize the mailer via the given method_name
. The body will be rendered and a new TMail::Mail object created.
174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 |
# File 'lib/action_mailer/base.rb', line 174 def create!(method_name, *parameters) #:nodoc: @bcc = @cc = @from = @recipients = @sent_on = @subject = nil @charset = @@default_charset.dup @content_type = @@default_content_type.dup @implicit_parts_order = @@default_implicit_parts_order.dup @template = method_name @parts = [] @headers = {} @body = {} send(method_name, *parameters) # If an explicit, textual body has not been set, we check assumptions. unless String === @body # First, we look to see if there are any likely templates that match, # which include the content-type in their file name (i.e., # "the_template_file.text.html.rhtml", etc.). if @parts.empty? templates = Dir.glob("#{template_path}/#{@template}.*") templates.each do |path| type = (File.basename(path).split(".")[1..-2] || []).join("/") next if type.empty? @parts << Part.new(:content_type => type, :disposition => "inline", :charset => charset, :body => (File.basename(path).split(".")[0..-2].join('.'), @body)) end unless @parts.empty? @content_type = "multipart/alternative" @parts = sort_parts(@parts, @implicit_parts_order) end end # Then, if there were such templates, we check to see if we ought to # also render a "normal" template (without the content type). If a # normal template exists (or if there were no implicit parts) we render # it. template_exists = @parts.empty? template_exists ||= Dir.glob("#{template_path}/#{@template}.*").any? { |i| i.split(".").length == 2 } @body = (@template, @body) if template_exists # Finally, if there are other message parts and a textual body exists, # we shift it onto the front of the parts and set the body to nil (so # that create_mail doesn't try to render it in addition to the parts). if !@parts.empty? && String === @body @parts.unshift Part.new(:charset => charset, :body => @body) @body = nil end end # build the mail object itself @mail = create_mail end |
#deliver! ⇒ Object
Delivers the cached TMail::Mail object. If no TMail::Mail object has been created (via the #create! method, for instance) this will fail.
229 230 231 232 233 234 235 236 237 238 239 240 |
# File 'lib/action_mailer/base.rb', line 229 def deliver! #:nodoc: raise "no mail object available for delivery!" unless @mail logger.info "Sent mail:\n #{mail.encoded}" unless logger.nil? begin send("perform_delivery_#{delivery_method}", @mail) if perform_deliveries rescue Object => e raise e if raise_delivery_errors end return @mail end |