actionmailer 0.4.0 → 0.5.0

data/CHANGELOG

@@ -1,3 +1,16 @@
+*0.5*
+
+* Added access to custom headers, like cc, bcc, and reply-to #268 [Andreas Schwarz]. Example:
+
+    def post_notification(recipients, post)
+      @recipients          = recipients
+      @from                = post.author.email_address_with_name
+      @headers["bcc"]      = SYSTEM_ADMINISTRATOR_EMAIL
+      @headers["reply-to"] = "notifications@example.com"
+      @subject             = "[#{post.account.name} #{post.title}]"
+      @body["post"]        = post
+    end
+
 *0.4* (5)
 
 * Consolidated the server configuration options into Base#server_settings= and expanded that with controls for authentication and more [Marten]

data/lib/action_mailer/base.rb

@@ -3,10 +3,12 @@ module ActionMailer #:nodoc:
   #
   #   class ApplicationMailer < ActionMailer::Base
   #     def post_notification(recipients, post)
-  #       @recipients   = recipients
-  #       @subject      = "[#{post.account.name} #{post.title}]"
-  #       @body["post"] = post
-  #       @from         = post.author.email_address_with_name
+  #       @recipients          = recipients
+  #       @from                = post.author.email_address_with_name
+  #       @headers["bcc"]      = SYSTEM_ADMINISTRATOR_EMAIL
+  #       @headers["reply-to"] = "notifications@example.com"
+  #       @subject             = "[#{post.account.name} #{post.title}]"
+  #       @body["post"]        = post
   #     end
   #     
   #     def comment_notification(recipient, comment)
@@ -24,24 +26,41 @@ module ActionMailer #:nodoc:
   #  
   #   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 <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.
   class Base
-    private_class_method :new
+    private_class_method :new #:nodoc:
 
-    # Template root determines the base from which template references will be made.
     cattr_accessor :template_root
-
-    # 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.
     cattr_accessor :logger
 
-    # 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
     @@server_settings = { 
       :address        => "localhost", 
       :port           => 25, 
@@ -52,27 +71,23 @@ module ActionMailer #:nodoc:
     }
     cattr_accessor :server_settings
 
-
-    # Whether or not errors should be raised if the email fails to be delivered
     @@raise_delivery_errors = true
     cattr_accessor :raise_delivery_errors
 
-    # Defines a delivery method. Possible values are :smtp (default), :sendmail, and :test.
-    # Sendmail is assumed to be present at "/usr/sbin/sendmail".
     @@delivery_method = :smtp
     cattr_accessor :delivery_method
     
-    # Determines whether deliver_* methods are actually carried out. By default they are,
-    # but this can be turned off to help functional testing.
     @@perform_deliveries = true
     cattr_accessor :perform_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.
     @@deliveries = []
     cattr_accessor :deliveries
 
-    attr_accessor :recipients, :subject, :body, :from, :sent_on, :bcc, :cc
+    attr_accessor :recipients, :subject, :body, :from, :sent_on, :headers, :bcc, :cc
+
+    def initialize
+      @headers = {}
+    end
 
     class << self
       def method_missing(method_symbol, *parameters)#:nodoc:
@@ -88,14 +103,18 @@ module ActionMailer #:nodoc:
         end        
       end
 
-      def mail(to, subject, body, from, timestamp = nil) #:nodoc:
-        deliver(create(to, subject, body, from, timestamp))
+      def mail(to, subject, body, from, timestamp = nil, headers = nil) #:nodoc:
+        deliver(create(to, subject, body, from, timestamp, headers))
       end
 
-      def create(to, subject, body, from, timestamp = nil) #:nodoc:
+      def create(to, subject, body, from, timestamp = nil, headers = nil) #:nodoc:
         m = TMail::Mail.new
         m.to, m.subject, m.body, m.from = to, subject, body, from
         m.date = timestamp.respond_to?("to_time") ? timestamp.to_time : (timestamp || Time.now)    
+        headers.each do |k, v|
+          m[k] = v
+        end
+
         return m
       end
 
@@ -129,9 +148,9 @@ module ActionMailer #:nodoc:
           mailer.send(method_name, *parameters)
 
           if String === mailer.body
-            mail = create(mailer.recipients, mailer.subject, mailer.body, mailer.from, mailer.sent_on)
+            mail = create(mailer.recipients, mailer.subject, mailer.body, mailer.from, mailer.sent_on, mailer.headers)
           else
-            mail = create(mailer.recipients, mailer.subject, render_body(mailer, method_name), mailer.from, mailer.sent_on)
+            mail = create(mailer.recipients, mailer.subject, render_body(mailer, method_name), mailer.from, mailer.sent_on, mailer.headers)
           end
 
           mail.bcc = @bcc if @bcc

data/rakefile

@@ -8,7 +8,7 @@ require 'rake/contrib/rubyforgepublisher'
 
 PKG_BUILD     = ENV['PKG_BUILD'] ? '.' + ENV['PKG_BUILD'] : ''
 PKG_NAME      = 'actionmailer'
-PKG_VERSION   = '0.4.0' + PKG_BUILD
+PKG_VERSION   = '0.5.0' + PKG_BUILD
 PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
 
 desc "Default Task"
@@ -58,8 +58,8 @@ spec = Gem::Specification.new do |s|
   s.autorequire = 'action_mailer'
 
   s.files = [ "rakefile", "install.rb", "README", "CHANGELOG", "MIT-LICENSE" ]
-  s.files = s.files + Dir.glob( "lib/**/*" ).delete_if { |item| item.include?( "CVS" ) }
-  s.files = s.files + Dir.glob( "test/**/*" ).delete_if { |item| item.include?( "CVS" ) }
+  s.files = s.files + Dir.glob( "lib/**/*" ).delete_if { |item| item.include?( "\.svn" ) }
+  s.files = s.files + Dir.glob( "test/**/*" ).delete_if { |item| item.include?( "\.svn" ) }
 end
   
 Rake::GemPackageTask.new(spec) do |p|

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.1
 specification_version: 1
 name: actionmailer
 version: !ruby/object:Gem::Version 
-  version: 0.4.0
-date: 2004-11-18
+  version: 0.5.0
+date: 2004-12-16
 summary: Service layer for easy email delivery and testing.
 require_paths: 
   - lib