2005-05-29 16:36:22 +00:00
|
|
|
require 'action_mailer/adv_attr_accessor'
|
|
|
|
require 'action_mailer/part'
|
2005-06-06 09:32:52 +00:00
|
|
|
require 'tmail/net'
|
2005-05-29 16:36:22 +00:00
|
|
|
|
2004-11-24 01:04:44 +00:00
|
|
|
module ActionMailer #:nodoc:
|
|
|
|
# Usage:
|
|
|
|
#
|
|
|
|
# class ApplicationMailer < ActionMailer::Base
|
2005-05-29 16:36:22 +00:00
|
|
|
# # 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 Hash.new("account" => recipient)
|
|
|
|
# from "system@example.com"
|
|
|
|
# end
|
|
|
|
#
|
|
|
|
# # explicitly specify multipart messages
|
|
|
|
# def signup_notification(recipient)
|
|
|
|
# recipients recipient.email_address_with_name
|
|
|
|
# subject "New account information"
|
|
|
|
# from "system@example.com"
|
|
|
|
#
|
|
|
|
# part :content_type => "text/html",
|
|
|
|
# :body => render_message("signup-as-html", :account => recipient)
|
|
|
|
#
|
|
|
|
# part "text/plain" do |p|
|
|
|
|
# p.body = render_message("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 "system@example.com"
|
|
|
|
#
|
|
|
|
# attachment :content_type => "image/jpeg",
|
|
|
|
# :body => File.read("an-image.jpg")
|
|
|
|
#
|
|
|
|
# attachment "application/pdf" do |a|
|
|
|
|
# a.body = generate_your_pdf_here()
|
|
|
|
# end
|
2004-11-24 01:04:44 +00:00
|
|
|
# end
|
2005-05-29 16:36:22 +00:00
|
|
|
#
|
|
|
|
# # implicitly multipart messages
|
|
|
|
# def signup_notification(recipient)
|
|
|
|
# recipients recipient.email_address_with_name
|
|
|
|
# subject "New account information"
|
|
|
|
# from "system@example.com"
|
|
|
|
# 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.
|
2004-11-24 01:04:44 +00:00
|
|
|
# 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
|
2004-12-16 17:53:19 +00:00
|
|
|
#
|
|
|
|
# = Configuration options
|
|
|
|
#
|
|
|
|
# These options are specified on the class level, like <tt>ActionMailer::Base.template_root = "/my/templates"</tt>
|
|
|
|
#
|
|
|
|
# * <tt>template_root</tt> - template root determines the base from which template references will be made.
|
|
|
|
#
|
|
|
|
# * <tt>logger</tt> - 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.
|
|
|
|
#
|
|
|
|
# * <tt>server_settings</tt> - Allows detailed configuration of the server:
|
|
|
|
# * <tt>:address</tt> Allows you to use a remote mail server. Just change it away from it's default "localhost" setting.
|
|
|
|
# * <tt>:port</tt> On the off change that your mail server doesn't run on port 25, you can change it.
|
|
|
|
# * <tt>:domain</tt> If you need to specify a HELO domain, you can do it here.
|
|
|
|
# * <tt>:user_name</tt> If your mail server requires authentication, set the username and password in these two settings.
|
|
|
|
# * <tt>:password</tt> If your mail server requires authentication, set the username and password in these two settings.
|
|
|
|
# * <tt>:authentication</tt> 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
|
|
|
|
#
|
|
|
|
# * <tt>raise_delivery_errors</tt> - whether or not errors should be raised if the email fails to be delivered.
|
|
|
|
#
|
|
|
|
# * <tt>delivery_method</tt> - Defines a delivery method. Possible values are :smtp (default), :sendmail, and :test.
|
|
|
|
# Sendmail is assumed to be present at "/usr/sbin/sendmail".
|
|
|
|
#
|
|
|
|
# * <tt>perform_deliveries</tt> - Determines whether deliver_* methods are actually carried out. By default they are,
|
|
|
|
# but this can be turned off to help functional testing.
|
|
|
|
#
|
|
|
|
# * <tt>deliveries</tt> - Keeps an array of all the emails sent out through the Action Mailer with delivery_method :test. Most useful
|
|
|
|
# for unit and functional testing.
|
2005-02-24 01:48:29 +00:00
|
|
|
#
|
|
|
|
# * <tt>default_charset</tt> - The default charset used for the body and to encode the subject. Defaults to UTF-8. You can also
|
2005-05-29 16:36:22 +00:00
|
|
|
# pick a different charset from inside a method with <tt>@charset</tt>.
|
2004-11-24 01:04:44 +00:00
|
|
|
class Base
|
2005-05-29 16:36:22 +00:00
|
|
|
include ActionMailer::AdvAttrAccessor
|
|
|
|
|
2004-12-16 17:53:19 +00:00
|
|
|
private_class_method :new #:nodoc:
|
2004-11-24 01:04:44 +00:00
|
|
|
|
|
|
|
cattr_accessor :template_root
|
|
|
|
cattr_accessor :logger
|
|
|
|
|
|
|
|
@@server_settings = {
|
|
|
|
:address => "localhost",
|
|
|
|
:port => 25,
|
|
|
|
:domain => 'localhost.localdomain',
|
|
|
|
:user_name => nil,
|
|
|
|
:password => nil,
|
|
|
|
:authentication => nil
|
|
|
|
}
|
|
|
|
cattr_accessor :server_settings
|
|
|
|
|
|
|
|
@@raise_delivery_errors = true
|
|
|
|
cattr_accessor :raise_delivery_errors
|
|
|
|
|
|
|
|
@@delivery_method = :smtp
|
|
|
|
cattr_accessor :delivery_method
|
|
|
|
|
|
|
|
@@perform_deliveries = true
|
|
|
|
cattr_accessor :perform_deliveries
|
|
|
|
|
|
|
|
@@deliveries = []
|
|
|
|
cattr_accessor :deliveries
|
|
|
|
|
2005-02-19 21:51:16 +00:00
|
|
|
@@default_charset = "utf-8"
|
|
|
|
cattr_accessor :default_charset
|
|
|
|
|
2005-06-03 10:57:06 +00:00
|
|
|
@@default_content_type = "text/plain"
|
|
|
|
cattr_accessor :default_content_type
|
|
|
|
|
2005-05-29 16:36:22 +00:00
|
|
|
adv_attr_accessor :recipients, :subject, :body, :from, :sent_on, :headers,
|
2005-06-03 10:57:06 +00:00
|
|
|
:bcc, :cc, :charset, :content_type
|
2004-12-07 09:10:50 +00:00
|
|
|
|
2005-05-29 16:36:22 +00:00
|
|
|
attr_reader :mail
|
|
|
|
|
|
|
|
# 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).
|
|
|
|
def initialize(method_name=nil, *parameters)
|
|
|
|
create!(method_name, *parameters) if method_name
|
|
|
|
end
|
|
|
|
|
|
|
|
# Initialize the mailer via the given +method_name+. The body will be
|
|
|
|
# rendered and a new TMail::Mail object created.
|
|
|
|
def create!(method_name, *parameters)
|
|
|
|
@bcc = @cc = @from = @recipients = @sent_on = @subject = nil
|
2005-02-19 21:51:16 +00:00
|
|
|
@charset = @@default_charset.dup
|
2005-06-03 10:57:06 +00:00
|
|
|
@content_type = @@default_content_type.dup
|
2005-05-29 16:36:22 +00:00
|
|
|
@parts = []
|
2004-12-07 09:10:50 +00:00
|
|
|
@headers = {}
|
2005-05-29 16:36:22 +00:00
|
|
|
@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}/#{method_name}.*")
|
|
|
|
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 => render_message(File.basename(path).split(".")[0..-2].join('.'), @body))
|
|
|
|
end
|
|
|
|
end
|
2004-11-24 01:04:44 +00:00
|
|
|
|
2005-05-29 16:36:22 +00:00
|
|
|
# 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}/#{method_name}.*").any? { |i| i.split(".").length == 2 }
|
|
|
|
@body = render_message(method_name, @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
|
2005-03-20 17:42:33 +00:00
|
|
|
end
|
2004-11-24 01:04:44 +00:00
|
|
|
end
|
|
|
|
|
2005-05-29 16:36:22 +00:00
|
|
|
# build the mail object itself
|
|
|
|
@mail = create_mail
|
|
|
|
end
|
2004-11-24 01:04:44 +00:00
|
|
|
|
2005-05-29 16:36:22 +00:00
|
|
|
# Delivers the cached TMail::Mail object. If no TMail::Mail object has been
|
|
|
|
# created (via the #create! method, for instance) this will fail.
|
|
|
|
def deliver!
|
|
|
|
raise "no mail object available for delivery!" unless @mail
|
|
|
|
logger.info "Sent mail:\n #{mail.encoded}" unless logger.nil?
|
2005-04-11 10:29:15 +00:00
|
|
|
|
2005-05-29 16:36:22 +00:00
|
|
|
begin
|
|
|
|
send("perform_delivery_#{delivery_method}", @mail) if perform_deliveries
|
|
|
|
rescue Object => e
|
|
|
|
raise e if raise_delivery_errors
|
|
|
|
end
|
2005-02-19 21:51:16 +00:00
|
|
|
|
2005-05-29 16:36:22 +00:00
|
|
|
return @mail
|
|
|
|
end
|
2005-02-19 21:51:16 +00:00
|
|
|
|
2005-05-29 16:36:22 +00:00
|
|
|
# Add a part to a multipart message, with the given content-type. The
|
|
|
|
# part itself is yielded to the block, so that other properties (charset,
|
|
|
|
# body, headers, etc.) can be set on it.
|
|
|
|
def part(params)
|
|
|
|
params = {:content_type => params} if String === params
|
|
|
|
part = Part.new(params)
|
|
|
|
yield part if block_given?
|
|
|
|
@parts << part
|
|
|
|
end
|
|
|
|
|
|
|
|
# Add an attachment to a multipart message. This is simply a part with the
|
|
|
|
# content-disposition set to "attachment".
|
|
|
|
def attachment(params, &block)
|
|
|
|
params = { :content_type => params } if String === params
|
|
|
|
params = { :disposition => "attachment",
|
|
|
|
:transfer_encoding => "base64" }.merge(params)
|
|
|
|
part(params, &block)
|
|
|
|
end
|
2004-12-07 09:10:50 +00:00
|
|
|
|
2005-05-29 16:36:22 +00:00
|
|
|
private
|
|
|
|
def render_message(method_name, body)
|
|
|
|
ActionView::Base.new(template_path, body).render_file(method_name)
|
|
|
|
end
|
|
|
|
|
|
|
|
def template_path
|
|
|
|
template_root + "/" + Inflector.underscore(self.class.name)
|
2004-11-24 01:04:44 +00:00
|
|
|
end
|
|
|
|
|
2005-05-29 16:36:22 +00:00
|
|
|
def create_mail
|
|
|
|
m = TMail::Mail.new
|
2005-05-02 15:03:13 +00:00
|
|
|
|
2005-05-29 16:36:22 +00:00
|
|
|
m.subject, = quote_any_if_necessary(charset, subject)
|
|
|
|
m.to, m.from = quote_any_address_if_necessary(charset, recipients, from)
|
|
|
|
m.bcc = quote_address_if_necessary(bcc, charset) unless bcc.nil?
|
|
|
|
m.cc = quote_address_if_necessary(cc, charset) unless cc.nil?
|
2005-05-02 15:03:13 +00:00
|
|
|
|
2005-05-29 16:36:22 +00:00
|
|
|
m.date = sent_on.to_time rescue sent_on if sent_on
|
|
|
|
headers.each { |k, v| m[k] = v }
|
2004-11-24 01:04:44 +00:00
|
|
|
|
2005-05-29 16:36:22 +00:00
|
|
|
if @parts.empty?
|
2005-06-03 10:57:06 +00:00
|
|
|
m.set_content_type content_type, nil, { "charset" => charset }
|
2005-05-29 16:36:22 +00:00
|
|
|
m.body = body
|
|
|
|
else
|
|
|
|
if String === body
|
|
|
|
part = TMail::Mail.new
|
|
|
|
part.body = body
|
2005-06-03 10:57:06 +00:00
|
|
|
part.set_content_type content_type, nil, { "charset" => charset }
|
2005-05-29 16:36:22 +00:00
|
|
|
part.set_content_disposition "inline"
|
|
|
|
m.parts << part
|
|
|
|
end
|
2005-02-19 21:51:16 +00:00
|
|
|
|
2005-05-29 16:36:22 +00:00
|
|
|
@parts.each do |p|
|
|
|
|
part = (TMail::Mail === p ? p : p.to_mail(self))
|
|
|
|
m.parts << part
|
|
|
|
end
|
|
|
|
end
|
2005-04-11 10:29:15 +00:00
|
|
|
|
2005-05-29 16:36:22 +00:00
|
|
|
@mail = m
|
2005-04-11 10:29:15 +00:00
|
|
|
end
|
|
|
|
|
2005-05-29 16:36:22 +00:00
|
|
|
def perform_delivery_smtp(mail)
|
2005-06-06 09:32:52 +00:00
|
|
|
destinations = mail.destinations
|
|
|
|
mail.ready_to_send
|
|
|
|
|
2005-05-29 16:36:22 +00:00
|
|
|
Net::SMTP.start(server_settings[:address], server_settings[:port], server_settings[:domain],
|
|
|
|
server_settings[:user_name], server_settings[:password], server_settings[:authentication]) do |smtp|
|
2005-06-06 09:32:52 +00:00
|
|
|
smtp.sendmail(mail.encoded, mail.from, destinations)
|
2005-05-29 16:36:22 +00:00
|
|
|
end
|
2005-04-11 10:29:15 +00:00
|
|
|
end
|
|
|
|
|
2005-05-29 16:36:22 +00:00
|
|
|
def perform_delivery_sendmail(mail)
|
|
|
|
IO.popen("/usr/sbin/sendmail -i -t","w+") do |sm|
|
|
|
|
sm.print(mail.encoded)
|
|
|
|
sm.flush
|
2005-04-11 10:29:15 +00:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2005-05-29 16:36:22 +00:00
|
|
|
def perform_delivery_test(mail)
|
|
|
|
deliveries << mail
|
|
|
|
end
|
|
|
|
|
|
|
|
class << self
|
|
|
|
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!
|
|
|
|
end
|
2005-04-11 10:29:15 +00:00
|
|
|
end
|
|
|
|
|
2005-03-20 17:42:33 +00:00
|
|
|
def receive(raw_email)
|
|
|
|
logger.info "Received mail:\n #{raw_email}" unless logger.nil?
|
2005-05-02 17:15:21 +00:00
|
|
|
mail = TMail::Mail.parse(raw_email)
|
|
|
|
mail.base64_decode
|
|
|
|
new.receive(mail)
|
2005-03-20 17:42:33 +00:00
|
|
|
end
|
|
|
|
|
2004-11-24 01:04:44 +00:00
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|