Adds a :file delivery_method to save email to a file on disk

Signed-off-by: Michael Koziarski <[email protected]>
[rails#2438 state:committed]

Author: edavis10

actionmailer/lib/action_mailer/base.rb

@@ -1,3 +1,5 @@
+require 'tmpdir'
+
 require "active_support/core_ext/class"
 # Use the old layouts until actionmailer gets refactored
 require "action_controller/legacy/layout"
@@ -224,9 +226,13 @@ module ActionMailer #:nodoc:
   #   * <tt>:location</tt> - The location of the sendmail executable. Defaults to <tt>/usr/sbin/sendmail</tt>.
   #   * <tt>:arguments</tt> - The command line arguments. Defaults to <tt>-i -t</tt>.
   #
+  # * <tt>file_settings</tt> - Allows you to override options for the <tt>:file</tt> delivery method.
+  #   * <tt>:location</tt> - The directory into which emails will be written. Defaults to the application <tt>tmp/mails</tt>.
+  #
   # * <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 <tt>:smtp</tt> (default), <tt>:sendmail</tt>, and <tt>:test</tt>.
+  # * <tt>delivery_method</tt> - Defines a delivery method. Possible values are <tt>:smtp</tt> (default), <tt>:sendmail</tt>, <tt>:test</tt>,
+  #   and <tt>:file</tt>.
   #
   # * <tt>perform_deliveries</tt> - Determines whether <tt>deliver_*</tt> methods are actually carried out. By default they are,
   #   but this can be turned off to help functional testing.
@@ -279,6 +285,12 @@ class Base
     }
     cattr_accessor :sendmail_settings
 
+    @@file_settings = {
+      :location       => defined?(Rails) ? "#{Rails.root}/tmp/mails" : "#{Dir.tmpdir}/mails"
+    }
+
+    cattr_accessor :file_settings
+
     @@raise_delivery_errors = true
     cattr_accessor :raise_delivery_errors
 
@@ -724,6 +736,14 @@ def perform_delivery_sendmail(mail)
       def perform_delivery_test(mail)
         deliveries << mail
       end
+
+      def perform_delivery_file(mail)
+        FileUtils.mkdir_p file_settings[:location]
+
+        (mail.to + mail.cc + mail.bcc).uniq.each do |to|
+          File.open(File.join(file_settings[:location], to), 'a') { |f| f.write(mail) }
+        end
+      end
   end
 
   Base.class_eval do

actionmailer/test/delivery_method_test.rb

@@ -7,6 +7,10 @@ class NonDefaultDeliveryMethodMailer < ActionMailer::Base
   self.delivery_method = :sendmail
 end
 
+class FileDeliveryMethodMailer < ActionMailer::Base
+  self.delivery_method = :file
+end
+
 class ActionMailerBase_delivery_method_Test < Test::Unit::TestCase
   def setup
     set_delivery_method :smtp
@@ -49,3 +53,21 @@ def test_should_be_the_set_delivery_method
   end
 end
 
+class FileDeliveryMethodMailer_delivery_method_Test < Test::Unit::TestCase
+  def setup
+    set_delivery_method :smtp
+  end
+
+  def teardown
+    restore_delivery_method
+  end
+
+  def test_should_be_the_set_delivery_method
+    assert_equal :file, FileDeliveryMethodMailer.delivery_method
+  end
+
+  def test_should_default_location_to_the_tmpdir
+    assert_equal "#{Dir.tmpdir}/mails", ActionMailer::Base.file_settings[:location]
+  end
+end
+

actionmailer/test/mail_service_test.rb

@@ -889,6 +889,18 @@ def test_headers_removed_on_smtp_delivery
     assert_no_match %r{^Bcc: [email protected]}, MockSMTP.deliveries[0][0]
   end
 
+   def test_file_delivery_should_create_a_file
+     ActionMailer::Base.delivery_method = :file
+     tmp_location = ActionMailer::Base.file_settings[:location]
+
+     TestMailer.deliver_cc_bcc(@recipient)
+     assert File.exists? tmp_location
+     assert File.directory? tmp_location
+     assert File.exists? File.join(tmp_location, @recipient)
+     assert File.exists? File.join(tmp_location, '[email protected]')
+     assert File.exists? File.join(tmp_location, '[email protected]')
+   end
+
   def test_recursive_multipart_processing
     fixture = File.read(File.dirname(__FILE__) + "/fixtures/raw_email7")
     mail = TMail::Mail.parse(fixture)