actionmailer 0.8.1 → 0.9.0

data/CHANGELOG

@@ -1,3 +1,14 @@
+*0.9.0* (19th April, 2005)
+
+* Added that deliver_* will now return the email that was sent
+
+* Added that quoting to UTF-8 only happens if the characters used are in that range #955 [Jamis Buck] 
+
+* Fixed quoting for all address headers, not just to #955 [Jamis Buck]
+
+* Fixed unquoting of emails that doesn't have an explicit charset #1036 [wolfgang@stufenlos.net]
+
+
 *0.8.1* (27th March, 2005)
 
 * Fixed that if charset was found that the end of a mime part declaration TMail would throw an error #919 [lon@speedymac.com]

data/install.rb

@@ -18,44 +18,13 @@ unless $sitedir
   end
 end
 
-makedirs = %w{ action_mailer/vendor action_mailer/vendor/text action_mailer/vendor/tmail }
-makedirs.each {|f| File::makedirs(File.join($sitedir, *f.split(/\//)))}
-
-# deprecated files that should be removed
-# deprecated = %w{ }
-
-# files to install in library path
-files = %w-
- action_mailer.rb
- action_mailer/base.rb
- action_mailer/mail_helper.rb
- action_mailer/vendor/text/format.rb
- action_mailer/vendor/tmail.rb
- action_mailer/vendor/tmail/address.rb
- action_mailer/vendor/tmail/base64.rb
- action_mailer/vendor/tmail/config.rb
- action_mailer/vendor/tmail/encode.rb
- action_mailer/vendor/tmail/facade.rb
- action_mailer/vendor/tmail/header.rb
- action_mailer/vendor/tmail/info.rb
- action_mailer/vendor/tmail/loader.rb
- action_mailer/vendor/tmail/mail.rb
- action_mailer/vendor/tmail/mailbox.rb
- action_mailer/vendor/tmail/mbox.rb
- action_mailer/vendor/tmail/net.rb
- action_mailer/vendor/tmail/obsolete.rb
- action_mailer/vendor/tmail/parser.rb
- action_mailer/vendor/tmail/port.rb
- action_mailer/vendor/tmail/scanner.rb
- action_mailer/vendor/tmail/scanner_r.rb
- action_mailer/vendor/tmail/stringio.rb
- action_mailer/vendor/tmail/tmail.rb
- action_mailer/vendor/tmail/utils.rb
--
-
 # the acual gruntwork
 Dir.chdir("lib")
-# File::safe_unlink *deprecated.collect{|f| File.join($sitedir, f.split(/\//))}
-files.each {|f| 
-  File::install(f, File.join($sitedir, *f.split(/\//)), 0644, true)
+
+Find.find("action_mailer", "action_mailer.rb") { |f|
+  if f[-3..-1] == ".rb"
+    File::install(f, File.join($sitedir, *f.split(/\//)), 0644, true)
+  else
+    File::makedirs(File.join($sitedir, *f.split(/\//)))
+  end
 }

data/lib/action_mailer/base.rb

@@ -58,8 +58,6 @@ module ActionMailer #:nodoc:
   #
   # * <tt>default_charset</tt> - 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 <tt>@encoding</tt>.
-  #
-  # * <tt>encode_subject</tt> - Whether or not to encode the subject with the active charset. Defaults to true.
   class Base
     private_class_method :new #:nodoc:
 
@@ -91,24 +89,20 @@ module ActionMailer #:nodoc:
     @@default_charset = "utf-8"
     cattr_accessor :default_charset
 
-    @@encode_subject = true
-    cattr_accessor :encode_subject
-
-    attr_accessor :recipients, :subject, :body, :from, :sent_on, :headers, :bcc, :cc, :charset, :encode_subject
+    attr_accessor :recipients, :subject, :body, :from, :sent_on, :headers, :bcc, :cc, :charset
 
     def initialize
       @bcc = @cc = @from = @recipients = @sent_on = @subject = @body = nil
       @charset = @@default_charset.dup
-      @encode_subject = @@encode_subject
       @headers = {}
     end
 
     class << self
       def method_missing(method_symbol, *parameters)#:nodoc:
         case method_symbol.id2name
-          when /^create_([_a-z]*)/
+          when /^create_([_a-z]\w*)/
             create_from_action($1, *parameters)
-          when /^deliver_([_a-z]*)/
+          when /^deliver_([_a-z]\w*)/
             begin
               deliver(send("create_" + $1, *parameters))
             rescue Object => e
@@ -117,18 +111,16 @@ module ActionMailer #:nodoc:
         end
       end
 
-      def mail(to, subject, body, from, timestamp = nil, headers = {},
-               encode = @@encode_subject, charset = @@default_charset
-      ) #:nodoc:
+      def mail(to, subject, body, from, timestamp = nil, headers = {}, charset = @@default_charset) #:nodoc:
         deliver(create(to, subject, body, from, timestamp, headers, charset))
       end
 
-      def create(to, subject, body, from, timestamp = nil, headers = {},
-                 encode = @@encode_subject, charset = @@default_charset
-      ) #:nodoc:
+      def create(to, subject, body, from, timestamp = nil, headers = {}, charset = @@default_charset) #:nodoc:
         m = TMail::Mail.new
-        m.to, m.subject, m.body, m.from = to,
-          ( encode ? quoted_printable(subject,charset) : subject ), body, from
+        m.body = body
+        m.subject, = quote_any_if_necessary(charset, subject)
+        m.to, m.from = quote_any_address_if_necessary(charset, to, from)
+
         m.date = timestamp.respond_to?("to_time") ? timestamp.to_time : (timestamp || Time.now)    
 
         m.set_content_type "text", "plain", { "charset" => charset }
@@ -143,6 +135,7 @@ module ActionMailer #:nodoc:
       def deliver(mail) #:nodoc:
         logger.info "Sent mail:\n #{mail.encoded}" unless logger.nil?
         send("perform_delivery_#{delivery_method}", mail) if perform_deliveries
+        return mail
       end
 
       def quoted_printable(text, charset)#:nodoc:
@@ -150,6 +143,42 @@ module ActionMailer #:nodoc:
         "=?#{charset}?Q?#{text}?="
       end
 
+      CHARS_NEEDING_QUOTING = /[\000-\011\013\014\016-\037\177-\377]/
+
+      # Quote the given text if it contains any "illegal" characters
+      def quote_if_necessary(text, charset)
+        (text =~ CHARS_NEEDING_QUOTING) ?
+          quoted_printable(text, charset) :
+          text
+      end
+
+      # Quote any of the given strings if they contain any "illegal" characters
+      def quote_any_if_necessary(charset, *args)
+        args.map { |v| quote_if_necessary(v, charset) }
+      end
+
+      # Quote the given address if it needs to be. The address may be a
+      # regular email address, or it can be a phrase followed by an address in
+      # brackets. The phrase is the only part that will be quoted, and only if
+      # it needs to be. This allows extended characters to be used in the
+      # "to", "from", "cc", and "bcc" headers.
+      def quote_address_if_necessary(address, charset)
+        if Array === address
+          address.map { |a| quote_address_if_necessary(a, charset) }
+        elsif address =~ /^(\S.*)\s+(<.*>)$/
+          address = $2
+          phrase = quote_if_necessary($1.gsub(/^['"](.*)['"]$/, '\1'), charset)
+          "#{phrase} #{address}"
+        else
+          address
+        end
+      end
+
+      # Quote any of the given addresses, if they need to be.
+      def quote_any_address_if_necessary(charset, *args)
+        args.map { |v| quote_address_if_necessary(v, charset) }
+      end
+
       def receive(raw_email)
         logger.info "Received mail:\n #{raw_email}" unless logger.nil?
         new.receive(TMail::Mail.parse(raw_email))
@@ -185,10 +214,10 @@ module ActionMailer #:nodoc:
 
           mail = create(mailer.recipients, mailer.subject, mailer.body,
                         mailer.from, mailer.sent_on, mailer.headers,
-                        mailer.encode_subject, mailer.charset)
+                        mailer.charset)
 
-          mail.bcc = mailer.bcc unless mailer.bcc.nil?
-          mail.cc  = mailer.cc  unless mailer.cc.nil?
+          mail.bcc = quote_address_if_necessary(mailer.bcc, mailer.charset) unless mailer.bcc.nil?
+          mail.cc  = quote_address_if_necessary(mailer.cc, mailer.charset)  unless mailer.cc.nil?
 
           return mail
         end

data/lib/action_mailer/vendor/tmail/port.rb

@@ -303,11 +303,11 @@ module TMail
     alias eql? ==
 
     def hash
-      @buffer.id.hash
+      @buffer.object_id.hash
     end
 
     def inspect
-      "#<#{self.class}:id=#{sprintf '0x%x', @buffer.id}>"
+      "#<#{self.class}:id=#{sprintf '0x%x', @buffer.object_id}>"
     end
 
     def reproducible?

data/lib/action_mailer/vendor/tmail/quoting.rb

@@ -9,7 +9,8 @@ begin
       end
 
       def unquoted_body(to_charset = 'utf-8')
-        Unquoter.unquote_and_convert_to(quoted_body, to_charset, header["content-type"]["charset"])
+        from_charset = header['content-type']['charset'] rescue 'us-ascii'
+        Unquoter.unquote_and_convert_to(quoted_body, to_charset, from_charset)
       end
 
       def body(to_charset = 'utf-8', &block)
@@ -97,4 +98,4 @@ rescue LoadError => e
       end
     end
   end
-end
+end

data/rakefile

@@ -8,7 +8,7 @@ require 'rake/contrib/rubyforgepublisher'
 
 PKG_BUILD     = ENV['PKG_BUILD'] ? '.' + ENV['PKG_BUILD'] : ''
 PKG_NAME      = 'actionmailer'
-PKG_VERSION   = '0.8.1' + PKG_BUILD
+PKG_VERSION   = '0.9.0' + PKG_BUILD
 PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
 
 RELEASE_NAME  = "REL #{PKG_VERSION}"
@@ -52,7 +52,7 @@ spec = Gem::Specification.new do |s|
   s.rubyforge_project = "actionmailer"
   s.homepage = "http://www.rubyonrails.org"
 
-  s.add_dependency('actionpack', '= 1.7.0' + PKG_BUILD)
+  s.add_dependency('actionpack', '= 1.8.0' + PKG_BUILD)
 
   s.has_rdoc = true
   s.requirements << 'none'
@@ -73,12 +73,12 @@ end
 
 desc "Publish the API documentation"
 task :pgem => [:package] do 
-  Rake::SshFilePublisher.new("davidhh@comox.textdrive.com", "public_html/gems/gems", "pkg", "#{PKG_FILE_NAME}.gem").upload
+  Rake::SshFilePublisher.new("davidhh@wrath.rubyonrails.com", "public_html/gems/gems", "pkg", "#{PKG_FILE_NAME}.gem").upload
 end
 
 desc "Publish the API documentation"
 task :pdoc => [:rdoc] do 
-  Rake::SshDirPublisher.new("davidhh@comox.textdrive.com", "public_html/am", "doc").upload
+  Rake::SshDirPublisher.new("davidhh@wrath.rubyonrails.com", "public_html/am", "doc").upload
 end
 
 desc "Publish the release files to RubyForge."

data/test/mail_service_test.rb

@@ -33,7 +33,7 @@ class TestMailer < ActionMailer::Base
 
   def iso_charset(recipient)
     @recipients = recipient
-    @subject    = "testing iso charsets"
+    @subject    = "testing isø charsets"
     @from       = "system@loudthinking.com"
     @sent_on    = Time.local 2004, 12, 12
     @cc         = "nobody@loudthinking.com"
@@ -50,9 +50,29 @@ class TestMailer < ActionMailer::Base
     @cc         = "nobody@loudthinking.com"
     @bcc        = "root@loudthinking.com"
     @body       = "Nothing to see here."
-    @encode_subject = false
   end
 
+  def extended_headers(recipient)
+    @recipients = recipient
+    @subject    = "testing extended headers"
+    @from       = "Grytøyr <stian1@example.net>"
+    @sent_on    = Time.local 2004, 12, 12
+    @cc         = "Grytøyr <stian2@example.net>"
+    @bcc        = "Grytøyr <stian3@example.net>"
+    @body       = "Nothing to see here."
+    @charset    = "iso-8859-1"
+  end
+
+  def utf8_body(recipient)
+    @recipients = recipient
+    @subject    = "testing utf-8 body"
+    @from       = "Foo áëô îü <extended@example.net>"
+    @sent_on    = Time.local 2004, 12, 12
+    @cc         = "Foo áëô îü <extended@example.net>"
+    @bcc        = "Foo áëô îü <extended@example.net>"
+    @body       = "åœö blah"
+    @charset    = "utf-8"
+  end
 end
 
 TestMailer.template_root = File.dirname(__FILE__) + "/fixtures"
@@ -82,7 +102,7 @@ class ActionMailerTest < Test::Unit::TestCase
   def test_signed_up
     expected = new_mail
     expected.to      = @recipient
-    expected.subject = encode "[Signed up] Welcome #{@recipient}"
+    expected.subject = "[Signed up] Welcome #{@recipient}"
     expected.body    = "Hello there, \n\nMr. #{@recipient}"
     expected.from    = "system@loudthinking.com"
     expected.date    = Time.local(2004, 12, 12)
@@ -100,7 +120,7 @@ class ActionMailerTest < Test::Unit::TestCase
   def test_cancelled_account
     expected = new_mail
     expected.to      = @recipient
-    expected.subject = encode "[Cancelled] Goodbye #{@recipient}"
+    expected.subject = "[Cancelled] Goodbye #{@recipient}"
     expected.body    = "Goodbye, Mr. #{@recipient}"
     expected.from    = "system@loudthinking.com"
     expected.date    = Time.local(2004, 12, 12)
@@ -118,7 +138,7 @@ class ActionMailerTest < Test::Unit::TestCase
   def test_cc_bcc
     expected = new_mail
     expected.to      = @recipient
-    expected.subject = encode "testing bcc/cc"
+    expected.subject = "testing bcc/cc"
     expected.body    = "Nothing to see here."
     expected.from    = "system@loudthinking.com"
     expected.cc      = "nobody@loudthinking.com"
@@ -143,7 +163,7 @@ class ActionMailerTest < Test::Unit::TestCase
   def test_iso_charset
     expected = new_mail( "iso-8859-1" )
     expected.to      = @recipient
-    expected.subject = encode "testing iso charsets", "iso-8859-1"
+    expected.subject = encode "testing isø charsets", "iso-8859-1"
     expected.body    = "Nothing to see here."
     expected.from    = "system@loudthinking.com"
     expected.cc      = "nobody@loudthinking.com"
@@ -228,5 +248,64 @@ EOF
     assert_equal "This_is_a_test\n2 + 2 =3D 4\n", mail.quoted_body
   end
 
+  def test_extended_headers
+    @recipient = "Grytøyr <test@localhost>"
+
+    expected = new_mail "iso-8859-1"
+    expected.to      = TestMailer.quote_address_if_necessary @recipient, "iso-8859-1"
+    expected.subject = "testing extended headers"
+    expected.body    = "Nothing to see here."
+    expected.from    = TestMailer.quote_address_if_necessary "Grytøyr <stian1@example.net>", "iso-8859-1"
+    expected.cc      = TestMailer.quote_address_if_necessary "Grytøyr <stian2@example.net>", "iso-8859-1"
+    expected.bcc     = TestMailer.quote_address_if_necessary "Grytøyr <stian3@example.net>", "iso-8859-1"
+    expected.date    = Time.local 2004, 12, 12
+
+    created = nil
+    assert_nothing_raised do
+      created = TestMailer.create_extended_headers @recipient
+    end
+
+    assert_not_nil created
+    assert_equal expected.encoded, created.encoded
+
+    assert_nothing_raised do
+      TestMailer.deliver_extended_headers @recipient
+    end
+
+    assert_not_nil ActionMailer::Base.deliveries.first
+    assert_equal expected.encoded, ActionMailer::Base.deliveries.first.encoded
+  end
+  
+  def test_utf8_body_is_not_quoted
+    @recipient = "Foo áëô îü <extended@example.net>"
+    expected = new_mail "utf-8"
+    expected.to      = TestMailer.quote_address_if_necessary @recipient, "utf-8"
+    expected.subject = "testing utf-8 body"
+    expected.body    = "åœö blah"
+    expected.from    = TestMailer.quote_address_if_necessary @recipient, "utf-8"
+    expected.cc      = TestMailer.quote_address_if_necessary @recipient, "utf-8"
+    expected.bcc     = TestMailer.quote_address_if_necessary @recipient, "utf-8"
+    expected.date    = Time.local 2004, 12, 12
+
+    created = TestMailer.create_utf8_body @recipient
+    assert_match(/åœö blah/, created.encoded)
+  end
+
+  def test_multiple_utf8_recipients
+    @recipient = ["\"Foo áëô îü\" <extended@example.net>", "\"Example Recipient\" <me@example.com>"]
+    expected = new_mail "utf-8"
+    expected.to      = TestMailer.quote_address_if_necessary @recipient, "utf-8"
+    expected.subject = "testing utf-8 body"
+    expected.body    = "åœö blah"
+    expected.from    = TestMailer.quote_address_if_necessary @recipient.first, "utf-8"
+    expected.cc      = TestMailer.quote_address_if_necessary @recipient, "utf-8"
+    expected.bcc     = TestMailer.quote_address_if_necessary @recipient, "utf-8"
+    expected.date    = Time.local 2004, 12, 12
+
+    created = TestMailer.create_utf8_body @recipient
+    assert_match(/\nFrom: =\?utf-8\?Q\?Foo_.*?\?= <extended@example.net>\r/, created.encoded)
+    assert_match(/\nTo: =\?utf-8\?Q\?Foo_.*?\?= <extended@example.net>, Example Recipient <me/, created.encoded)
+  end
+
 end
 

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.8
 specification_version: 1
 name: actionmailer
 version: !ruby/object:Gem::Version 
-  version: 0.8.1
-date: 2005-03-27
+  version: 0.9.0
+date: 2005-04-19
 summary: Service layer for easy email delivery and testing.
 require_paths: 
   - lib
@@ -85,5 +85,5 @@ dependencies:
         - 
           - "="
           - !ruby/object:Gem::Version 
-            version: 1.7.0
+            version: 1.8.0
       version: