mail 2.1.3 → 2.1.5

data/CHANGELOG.rdoc

@@ -1,9 +1,46 @@
+== Sun Mar 28 02:55:42 UTC 2010 Mikel Lindsaar <raasdnil@gmail.com>
+
+* Version bump to 2.1.4
+
+== Sun Mar 28 00:26:27 UTC 2010 Mikel Lindsaar <raasdnil@gmail.com>
+
+* Merged in Jeremy/treetop to vendored treetop
+* Merged in nathansobo/treetop to vendored treetop
+* Merged in pzbowen/mail into mail - Adds body auto encoding - awesome work
+* Fixed content-transfer-encoding parser to be more compliant per RFC, also now handles trailing semi-colons correctly
+* Fixed content-transfer-encoding parser to handle weird "from the wild" misspellings
+* Added message.errors, header.errors arrays, returns array of [field_name, value, error_object] for each field that failed to parse
+* Removed bundler require from Rakefile
+
+== Sun Mar 17 03:03:03 UTC 2010 Mikel Lindsaar <raasdnil@gmail.com>
+
+* Keep header name case when failing to unstructured field
+
+== Wed Feb 24 09:14:56 UTC 2010 Mikel Lindsaar <raasdnil@gmail.com>
+
+* Fixed multiaddress bounce messages crashing when calling .bounced?  Now just take the first report and return that.
+* Closes issue 38 - final_recipient method give problem when one bounce email for multiple email ids
+* Fixing up TODO and Docs
+
+== Sun Mar 22 03:24:15 UTC 2010 Mikel Lindsaar <raasdnil@gmail.com>
+
+* Version bump to 2.1.3
+
 == Thu Jan 28 00:25:02 UTC 2010 Mikel Lindsaar <raasdnil@gmail.com>
 
 * Added TMM1's patch to not raise errors if a email is not multipart/report
 * Added html_part and text_part now return the first text/html or text/plain part they find. Order is from top to bottom of the email, all parts, flattened.
+* Cleaning up register_interceptor and register_observer including documentation
+* Renamed #register_for_delivery_notification to #register_observer
+* Renamed #register_for_delivery_interception to #register_interceptor
+* Adding spec to check for folding of non ASCII words that have been encoded
+* Updating Message#inspect to be a bit more friendly... it is for us mere mortals after all
 * Version bump to 2.1.2
 
+== Sun Jan 28 02:59:34 UTC 2010 Mikel Lindsaar <raasdnil@gmail.com>
+
+* Removed old method of setting delivery_method 
+
 == Mon Jan 25 11:36:13 UTC 2010 Mikel Lindsaar <raasdnil@gmail.com>
 
 * Added ability for address fields to init on an array instead of just a string.

data/README.rdoc

@@ -471,7 +471,7 @@ will try and guess the mime_type for you.
   @mail.attachments.first.mime_type #=> 'application/pdf'
   @mail.attachments.first.decoded == File.read('path/to/myfile.pdf') #=> true
 
-You can also override the guessed mime type if you really know better
+You can also override the guessed MIME media type if you really know better
 than mail (this should be rarely needed)
 
   @mail = Mail.new

data/Rakefile

@@ -8,11 +8,10 @@ require 'rake/gempackagetask'
 require 'rake/testtask'
 require 'spec/rake/spectask'
 require 'cucumber/rake/task'
-require 'bundler'
 
 spec = Gem::Specification.new do |s|
   s.name        = "mail"
-  s.version     = "2.1.3"
+  s.version     = "2.1.5"
   s.author      = "Mike Lindsaar"
   s.email       = "raasdnil@gmail.com"
   s.homepage    = "http://github.com/mikel/mail"
@@ -42,7 +41,7 @@ end
 Spec::Rake::SpecTask.new(:rcov) do |t|
   t.spec_files = FileList['test/**/tc_*.rb', 'spec/**/*_spec.rb']
   t.rcov = true
-  t.rcov_opts = t.rcov_opts << ['--exclude', '/Library,/opt,/System']
+  t.rcov_opts = t.rcov_opts << ['--exclude', '/Library,/opt,/System,/usr']
 end
 
 Spec::Rake::SpecTask.new(:spec) do |t|

data/TODO.rdoc

@@ -1,17 +1,7 @@
 == Not really in any order:
 
-* Make body, part, field, header, message all responding correctly to :encoded
-  and :decoded messages.  And remove ":to_s" as a method on these
-  classes.  Encoded needs to return the field, encoded, ready to send in the
-  mail system, that is, US-ASCII.  Decoded needs to return the field decoded ready to
-  view.  :to_s is (unfortunately) ambiguous in this case.  Maybe return a warning 
-  with :to_s and say "please use encoded or decoded instead" or :to_s returns
-  "Showing you the encoded view by default, call :decoded to see the decoded view"
-
-* Refactor out the multibyte and string handling.  Make ActiveSupport a dependancy
-
-* Clean up the relationship between message, parts and bodies.  Need to make sure
-  once parsed, that a body knows what encoding it is, for example.
+* Add multibyte handling to fields, if they get a multibyte string, try encoding it into 
+  UTF-8 B first, if this fails, throw an error.
 
 * Cleanup the treetop parsers......... do I _really_ need that many entrance files?
 

data/lib/mail.rb

@@ -102,10 +102,13 @@ module Mail # :doc:
   end
   
   # Load in all transfer encodings
-  elems = Dir.glob(File.join(File.dirname(__FILE__), 'mail', 'encodings', '*.rb'))
-  elems.each do |elem|
-    require "mail/encodings/#{File.basename(elem, '.rb')}"
-  end
+  require "mail/encodings/encodings"
+  require "mail/encodings/transfer_encoding"
+  require "mail/encodings/binary"
+  require "mail/encodings/8bit"
+  require "mail/encodings/7bit"
+  require "mail/encodings/base64"
+  require "mail/encodings/quoted_printable"
   
   # Finally... require all the Mail.methods
   require File.join('mail', 'mail')

data/lib/mail/attachments_list.rb

@@ -30,7 +30,7 @@ module Mail
 
     def []=(name, value)
       default_values = { :content_type => "#{set_mime_type(name)}; filename=\"#{name}\"",
-                         :content_transfer_encoding => 'Base64',
+                         :content_transfer_encoding => "#{guess_encoding}",
                          :content_disposition => "attachment; filename=\"#{name}\"" }
 
       if value.is_a?(Hash)
@@ -39,28 +39,46 @@ module Mail
 
         default_values[:body] = value.delete(:data) if value[:data]
 
-        # Only force encode base64 if the user has not specified an encoding
-        if value[:transfer_encoding]
-          default_values[:content_transfer_encoding] = value.delete(:transfer_encoding)
-        elsif value[:encoding]
-          default_values[:content_transfer_encoding] = value.delete(:encoding)
-        else
-          default_values[:body] = Mail::Encodings::Base64.encode(default_values[:body])
+        encoding = value.delete(:transfer_encoding) || value.delete(:encoding)
+        if encoding
+          if Mail::Encodings.defined? encoding
+            default_values[:content_transfer_encoding] = encoding
+          else
+            raise "Do not know how to handle Content Transfer Encoding #{encoding}, please choose either quoted-printable or base64"
+          end
         end
 
         if value[:mime_type]
           default_values[:content_type] = value.delete(:mime_type)
+          @mime_type = MIME::Types[default_values[:content_type]].first
+          default_values[:content_transfer_encoding] = guess_encoding
         end
 
         hash = default_values.merge(value)
       else
-        default_values[:body] = Mail::Encodings::Base64.encode(value)
+        default_values[:body] = value
         hash = default_values
       end
 
+      if hash[:body].respond_to? :force_encoding and hash[:body].respond_to? :valid_encoding?
+        if not hash[:body].valid_encoding? and default_values[:content_transfer_encoding].downcase == "binary"
+          hash[:body].force_encoding("BINARY")
+        end
+      end
+
       @parts_list << Part.new(hash)
     end
-    
+   
+    # Uses the mime type to try and guess the encoding, if it is a binary type, or unknown, then we
+    # set it to binary, otherwise as set to plain text
+    def guess_encoding
+      if @mime_type && !@mime_type.binary?
+        "7bit"
+      else
+        "binary"
+      end
+    end 
+ 
     def set_mime_type(filename)
       # Have to do this because MIME::Types is not Ruby 1.9 safe yet
       if RUBY_VERSION >= '1.9'

data/lib/mail/body.rb

@@ -44,7 +44,7 @@ module Mail
           raise "You can only assign a string or an object that responds_to? :join or :to_s to a body."
         end
       end
-      @encoding = nil
+      @encoding = (only_us_ascii? ? '7bit' : '8bit')
       set_charset
     end
     
@@ -123,22 +123,39 @@ module Mail
     def raw_source
       @raw_source
     end
-    
-    # Returns a US-ASCII 7-bit compliant body.  Right now just returns the
-    # raw source.  Need to implement
-    def encoded
+   
+    def get_best_encoding(target)
+        te = Mail::Encodings.get_encoding(target)
+        te.get_best_compatible(encoding, raw_source)
+    end
+ 
+    # Returns a body encoded using transfer_encoding.  Multipart always uses an
+    # identiy encoding (i.e. no encoding).
+    # Calling this directly is not a good idea, but supported for compatibility
+    # TODO: Validate that preamble and epilogue are valid for requested encoding
+    def encoded(transfer_encoding = '8bit')
       if multipart?
         self.sort_parts!
         encoded_parts = parts.map { |p| p.encoded }
         ([preamble] + encoded_parts).join(crlf_boundary) + end_boundary + epilogue.to_s
       else
-        raw_source.to_crlf
+        be = get_best_encoding(transfer_encoding)
+        dec = Mail::Encodings::get_encoding(encoding)
+        enc = Mail::Encodings::get_encoding(be)
+        if transfer_encoding == encoding and dec.nil?
+            # Cannot decode, so skip normalization
+            raw_source
+        else
+            # Decode then encode to normalize and allow transforming 
+            # from base64 to Q-P and vice versa
+            enc.encode(dec.decode(raw_source))
+        end
       end
     end
     
     def decoded
-      if encoding.nil? || !Encodings.defined?(encoding)
-        raw_source.to_lf
+      if !Encodings.defined?(encoding)
+        raise UnknownEncodingType, "Don't know how to decode #{encoding}, please call #encoded and decode it yourself."
       else
         Encodings.get_encoding(encoding).decode(raw_source)
       end
@@ -156,12 +173,19 @@ module Mail
       @charset = val
     end
 
-    def encoding
-      @encoding
+    def encoding(val = nil)
+      if val
+        self.encoding = val
+      else
+        @encoding
+      end
     end
     
     def encoding=( val )
-      @encoding = val
+      if val == "text" || val.blank? then
+        val = "8bit"
+      end
+      @encoding = (val == "text") ? "8bit" : val
     end
 
     # Returns the preamble (any text that is before the first MIME boundary)
@@ -169,7 +193,7 @@ module Mail
       @preamble
     end
 
-    # Sets the preamble to a string (adds text before the first mime boundary)
+    # Sets the preamble to a string (adds text before the first MIME boundary)
     def preamble=( val )
       @preamble = val
     end
@@ -179,7 +203,7 @@ module Mail
       @epilogue
     end
     
-    # Sets the epilogue to a string (adds text after the last mime boundary)
+    # Sets the epilogue to a string (adds text after the last MIME boundary)
     def epilogue=( val )
       @epilogue = val
     end
@@ -223,7 +247,12 @@ module Mail
     end
     
     def only_us_ascii?
-      !!raw_source.to_s.ascii_only?
+      raw_source.each_byte {|b| return false if (b == 0 || b > 127)}
+      true
+    end
+    
+    def empty?
+      !!raw_source.to_s.empty?
     end
     
     private
@@ -237,7 +266,7 @@ module Mail
     end
     
     def set_charset
-      raw_source.ascii_only? ? @charset = 'US-ASCII' : @charset = nil
+      only_us_ascii? ? @charset = 'US-ASCII' : @charset = nil
     end
   end
 end

data/lib/mail/core_extensions/string.rb

@@ -16,4 +16,8 @@ class String #:nodoc:
       !(self =~ /[^#{US_ASCII_REGEXP}]/)
     end
   end
+
+  unless method_defined?(:bytesize)
+    alias :bytesize :length
+  end
 end

data/lib/mail/elements/content_transfer_encoding_element.rb

@@ -6,7 +6,10 @@ module Mail
     
     def initialize( string )
       parser = Mail::ContentTransferEncodingParser.new
-      if tree = parser.parse(string.downcase)
+      case
+      when string.blank?
+        @encoding = ''
+      when tree = parser.parse(string.downcase)
         @encoding = tree.encoding.text_value
       else
         raise Mail::Field::ParseError, "ContentTransferEncodingElement can not parse |#{string}|\nReason was: #{parser.failure_reason}\n"

data/lib/mail/encodings/7bit.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+module Mail
+  module Encodings
+    class SevenBit < EightBit
+      NAME = '7bit'
+    
+      PRIORITY = 1
+
+      # 7bit and 8bit operate the same
+      
+      # Decode the string
+      def self.decode(str)
+        super
+      end
+    
+      # Encode the string
+      def self.encode(str)
+        super
+      end
+     
+      # Idenity encodings have a fixed cost, 1 byte out per 1 byte in
+      def self.cost(str)
+        super 
+      end
+
+      Encodings.register(NAME, self) 
+    end
+  end
+end

data/lib/mail/encodings/8bit.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+module Mail
+  module Encodings
+    class EightBit < Binary
+      NAME = '8bit'
+
+      PRIORITY = 4
+
+      # 8bit is an identiy encoding, meaning nothing to do
+      
+      # Decode the string
+      def self.decode(str)
+        str.to_lf
+      end
+    
+      # Encode the string
+      def self.encode(str)
+        str.to_crlf
+      end
+     
+      # Idenity encodings have a fixed cost, 1 byte out per 1 byte in
+      def self.cost(str)
+        1.0
+      end
+
+      Encodings.register(NAME, self) 
+    end
+  end
+end

data/lib/mail/encodings/base64.rb

@@ -1,8 +1,15 @@
 # encoding: utf-8
 module Mail
   module Encodings
-    class Base64
-      
+    class Base64 < SevenBit
+      NAME = 'base64'
+     
+      PRIORITY = 3
+ 
+      def self.can_encode?(enc)
+        true
+      end
+
       # Decode the string from Base64
       def self.decode(str)
         RubyVer.decode_base64( str )
@@ -10,9 +17,15 @@ module Mail
     
       # Encode the string to Base64
       def self.encode(str)
-        RubyVer.encode_base64( str )
+        RubyVer.encode_base64( str ).to_crlf
+      end
+
+      # Base64 has a fixed cost, 4 bytes out per 3 bytes in
+      def self.cost(str)
+        4.0/3
       end
-      
+
+      Encodings.register(NAME, self)      
     end
   end
-end
+end

data/lib/mail/encodings/binary.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+module Mail
+  module Encodings
+    class Binary < TransferEncoding
+      NAME = 'binary'
+
+      PRIORITY = 5
+
+      # Binary is an identiy encoding, meaning nothing to do
+      
+      # Decode the string
+      def self.decode(str)
+        str
+      end
+    
+      # Encode the string
+      def self.encode(str)
+        str
+      end
+     
+      # Idenity encodings have a fixed cost, 1 byte out per 1 byte in
+      def self.cost(str)
+        1.0
+      end
+
+      Encodings.register(NAME, self) 
+    end
+  end
+end