aboutsummaryrefslogtreecommitdiffstats
path: root/actionmailer
diff options
context:
space:
mode:
authorJosé Valim and Mikel Lindsaar <raasdnil@gmail.com>2010-01-20 23:46:59 +1100
committerJosé Valim and Mikel Lindsaar <raasdnil@gmail.com>2010-01-20 23:46:59 +1100
commitc34cfcc29f705c95c2218889cbec1898e008335d (patch)
tree1dd2381d4828645f072f636e81d6a87b37f13256 /actionmailer
parent10c509fbfa70758ece26e8876d1c5c28f659f2f0 (diff)
downloadrails-c34cfcc29f705c95c2218889cbec1898e008335d.tar.gz
rails-c34cfcc29f705c95c2218889cbec1898e008335d.tar.bz2
rails-c34cfcc29f705c95c2218889cbec1898e008335d.zip
Created mail method for new API
Diffstat (limited to 'actionmailer')
-rw-r--r--actionmailer/lib/action_mailer/base.rb59
-rw-r--r--actionmailer/lib/action_mailer/deprecated_api.rb4
-rw-r--r--actionmailer/test/base_test.rb46
3 files changed, 89 insertions, 20 deletions
diff --git a/actionmailer/lib/action_mailer/base.rb b/actionmailer/lib/action_mailer/base.rb
index 9df482cdf6..8825bd35f9 100644
--- a/actionmailer/lib/action_mailer/base.rb
+++ b/actionmailer/lib/action_mailer/base.rb
@@ -297,7 +297,7 @@ module ActionMailer #:nodoc:
@@default_implicit_parts_order = [ "text/plain", "text/enriched", "text/html" ]
cattr_accessor :default_implicit_parts_order
- @@protected_instance_variables = %w(@parts @mail)
+ @@protected_instance_variables = %w(@parts @message)
cattr_reader :protected_instance_variables
# Specify the BCC addresses for the message
@@ -352,8 +352,8 @@ module ActionMailer #:nodoc:
# location, you can use this to specify that location.
adv_attr_accessor :mailer_name
- # Expose the internal mail
- attr_reader :mail
+ # Expose the internal Mail message
+ attr_reader :message
# Alias controller_path to mailer_name so render :partial in views work.
alias :controller_path :mailer_name
@@ -374,7 +374,7 @@ module ActionMailer #:nodoc:
def method_missing(method_symbol, *parameters) #:nodoc:
if match = matches_dynamic_method?(method_symbol)
case match[1]
- when 'create' then new(match[2], *parameters).mail
+ when 'create' then new(match[2], *parameters).message
when 'deliver' then new(match[2], *parameters).deliver!
when 'new' then nil
else super
@@ -461,13 +461,40 @@ module ActionMailer #:nodoc:
end
end
+ def mail(headers = {})
+ # Guard flag to prevent both the old and the new API from firing
+ # TODO - Move this @mail_was_called flag into deprecated_api.rb
+ @mail_was_called = true
+
+ m = @message
+
+ m.content_type ||= headers[:content_type] || @@default_content_type
+ m.charset ||= headers[:charset] || @@default_charset
+ m.mime_version ||= headers[:mime_version] || @@default_mime_version
+
+ m.subject = quote_if_necessary(headers[:subject], m.charset) if headers[:subject]
+ m.to = quote_address_if_necessary(headers[:to], m.charset) if headers[:to]
+ m.from = quote_address_if_necessary(headers[:from], m.charset) if headers[:from]
+ m.cc = quote_address_if_necessary(headers[:cc], m.charset) if headers[:cc]
+ m.bcc = quote_address_if_necessary(headers[:bcc], m.charset) if headers[:bcc]
+ m.reply_to = quote_address_if_necessary(headers[:reply_to], m.charset) if headers[:reply_to]
+ m.mime_version = headers[:mime_version] if headers[:mime_version]
+ m.date = headers[:date] if headers[:date]
+
+ m.body.set_sort_order(headers[:parts_order] || @@default_implicit_parts_order)
+
+ # TODO: m.body.sort_parts!
+ m
+ end
+
# 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, *args)
super()
- @mail = Mail.new
+ @mail_was_called = false
+ @message = Mail.new
process(method_name, *args) if method_name
end
@@ -475,23 +502,27 @@ module ActionMailer #:nodoc:
# rendered and a new Mail object created.
def process(method_name, *args)
initialize_defaults(method_name)
+
super
+
+ unless @mail_was_called
+ # Create e-mail parts
+ create_parts
- # Create e-mail parts
- create_parts
+ # Set the subject if not set yet
+ @subject ||= I18n.t(:subject, :scope => [:actionmailer, mailer_name, method_name],
+ :default => method_name.humanize)
- # Set the subject if not set yet
- @subject ||= I18n.t(:subject, :scope => [:actionmailer, mailer_name, method_name],
- :default => method_name.humanize)
-
- # Build the mail object itself
- create_mail
+ # Build the mail object itself
+ create_mail
+ end
+ @message
end
# Delivers a Mail object. By default, it delivers the cached mail
# object (from the <tt>create!</tt> method). If no cached mail object exists, and
# no alternate has been given as the parameter, this will fail.
- def deliver!(mail = @mail)
+ def deliver!(mail = @message)
self.class.deliver(mail)
end
diff --git a/actionmailer/lib/action_mailer/deprecated_api.rb b/actionmailer/lib/action_mailer/deprecated_api.rb
index 3334b47987..e11dd4c46a 100644
--- a/actionmailer/lib/action_mailer/deprecated_api.rb
+++ b/actionmailer/lib/action_mailer/deprecated_api.rb
@@ -38,7 +38,7 @@ module ActionMailer
private
def create_mail #:nodoc:
- m = @mail
+ m = @message
m.subject, = quote_any_if_necessary(charset, subject)
m.to, m.from = quote_any_address_if_necessary(charset, recipients, from)
@@ -72,7 +72,7 @@ module ActionMailer
m.content_transfer_encoding = '8bit' unless m.body.only_us_ascii?
- @mail
+ @message
end
# Render a message but does not set it as mail body. Useful for rendering
diff --git a/actionmailer/test/base_test.rb b/actionmailer/test/base_test.rb
index dc1fbc07be..83d51274f0 100644
--- a/actionmailer/test/base_test.rb
+++ b/actionmailer/test/base_test.rb
@@ -1,3 +1,6 @@
+# encoding: utf-8
+require 'abstract_unit'
+
# class Notifier < ActionMailer::Base
# delivers_from 'notifications@example.com'
#
@@ -30,10 +33,45 @@
# end
# end
#
-# Notifier.welcome(user) # => returns a Mail object
+# mail = Notifier.welcome(user) # => returns a Mail object
+# mail.deliver
+#
# Notifier.welcome(user).deliver # => creates and sends the Mail in one step
-class BaseTest < ActionMailer::Base
+class BaseTest < Test::Unit::TestCase
+ class TestMailer < ActionMailer::Base
+ def welcome(hash = {})
+ hash = {:to => 'mikel@test.lindsaar.net', :from => 'jose@test.plataformatec.com',
+ :subject => 'The first email on new API!'}.merge!(hash)
+ mail(hash)
+ end
+ end
+
+ def test_the_method_call_to_mail_does_not_raise_error
+ assert_nothing_raised { TestMailer.deliver_welcome }
+ end
+
+ def test_should_set_the_headers_of_the_mail_message
+ email = TestMailer.deliver_welcome
+ assert_equal(email.to, ['mikel@test.lindsaar.net'])
+ assert_equal(email.from, ['jose@test.plataformatec.com'])
+ assert_equal(email.subject, 'The first email on new API!')
+ end
+
+ def test_calling_mail_should_pass_the_header_hash_to_the_new_mail_object
+
+ end
+
+ def test_it_should_guard_against_old_api_if_mail_method_called
+
+ end
+
+ # def test_that_class_defaults_are_set_on_instantiation
+ # pending
+ # end
+ #
+ # def test_should_set_the_subject_from_i18n
+ # pending
+ # end
-
-end
+end \ No newline at end of file