mail 2.1.3 → 2.1.5

data/lib/mail/encodings/encodings.rb

@@ -7,15 +7,25 @@ module Mail
   module Encodings
     
     include Mail::Patterns
-    
+
+    @transfer_encodings = {}
+   
+    # Register transfer encoding
+    #
+    # Example
+    #
+    # Encodings.register "base64", Mail::Encodings::Base64
+    def Encodings.register(name, cls)
+        @transfer_encodings[get_name(name)] = cls
+    end
+ 
     # Is the encoding we want defined?
     # 
     # Example:
     # 
     #  Encodings.defined?(:base64) #=> true
     def Encodings.defined?( str )
-      string = str.to_s.split(/[_-]/).map { |v| v.capitalize }.join('')
-      RubyVer.has_constant?(Mail::Encodings, string)
+      @transfer_encodings.include? get_name(str)
     end
     
     # Gets a defined encoding type, QuotedPrintable or Base64 for now.
@@ -27,8 +37,15 @@ module Mail
     # 
     #  Encodings.get_encoding(:base64) #=> Mail::Encodings::Base64
     def Encodings.get_encoding( str )
-      string = str.to_s.split(/[_-]/).map { |v| v.capitalize }.join('')
-      RubyVer.get_constant(Mail::Encodings, string)
+      @transfer_encodings[get_name(str)]
+    end
+
+    def Encodings.get_all
+      @transfer_encodings.values
+    end
+
+    def Encodings.get_name(enc)
+      enc = enc.to_s.gsub("-", "_").downcase
     end
 
     # Encodes a parameter value using URI Escaping, note the language field 'en' can
@@ -196,6 +213,5 @@ module Mail
     def Encodings.find_encoding(str)
       RUBY_VERSION >= '1.9' ? str.encoding : $KCODE
     end
-    
   end
 end

data/lib/mail/encodings/quoted_printable.rb

@@ -1,18 +1,39 @@
 # encoding: utf-8
 module Mail
   module Encodings
-    class QuotedPrintable
-    
+    class QuotedPrintable < SevenBit
+      NAME='quoted-printable'
+   
+      PRIORITY = 2
+
+      def self.can_encode?(str)
+        EightBit.can_encode? str
+      end
+
       # Decode the string from Quoted-Printable
       def self.decode(str)
         str.unpack("M*").first
       end
 
       def self.encode(str)
-        str.gsub( /[^a-z ]/i ) { quoted_printable_encode($&) }
+        l = []
+        str.each_line{|line| l << qp_encode_line(line)}
+        l.join("\r\n")
       end
 
+      def self.cost(str)
+        # These bytes probably do not need encoding
+        c = str.count("\x9\xA\xD\x20-\x3C\x3E-\x7E")
+        # Everything else turns into =XX where XX is a 
+        # two digit hex number (taking 3 bytes)
+        total = (str.bytesize - c)*3 + c
+        total.to_f/str.bytesize
+      end
+        
       private
+      def self.qp_encode_line(str)
+        str.chomp.gsub( /[^a-z ]/i ) { quoted_printable_encode($&) }
+      end
 
       # Convert the given character to quoted printable format, taking into
       # account multi-byte characters (if executing with $KCODE="u", for instance)
@@ -21,6 +42,8 @@ module Mail
         character.each_byte { |b| result << "=%02X" % b }
         result
       end
+
+      Encodings.register(NAME, self)
     end
   end
-end
+end

data/lib/mail/encodings/transfer_encoding.rb

@@ -0,0 +1,58 @@
+# encoding: utf-8
+module Mail
+  module Encodings
+    class TransferEncoding
+      NAME = ''
+
+      PRIORITY = -1
+
+      def self.can_transport?(enc)
+        enc = Encodings.get_name(enc)
+        if Encodings.defined? enc
+          Encodings.get_encoding(enc).new.is_a? self
+        else
+          false
+        end
+      end
+
+      def self.can_encode?(enc)
+        can_transport? enc 
+      end
+
+      def self.cost(str)
+        raise "Unimplemented"
+      end
+
+      def self.to_s
+        self::NAME
+      end
+
+      def self.get_best_compatible(source_encoding, str)
+        if self.can_transport? source_encoding then
+            source_encoding 
+        else
+            choices = []
+            Encodings.get_all.each do |enc|
+                choices << enc if self.can_transport? enc and enc.can_encode? source_encoding
+            end
+            best = nil 
+            best_cost = 100
+            choices.each do |enc|
+                this_cost = enc.cost str
+                if this_cost < best_cost then
+                    best_cost = this_cost
+                    best = enc
+                elsif this_cost == best_cost then 
+                    best = enc if enc::PRIORITY < best::PRIORITY
+                end
+            end
+            best
+        end
+      end
+
+      def to_s
+        self.class.to_s
+      end
+    end
+  end
+end

data/lib/mail/field.rb

@@ -141,15 +141,17 @@ module Mail
     def create_field(name, value)
       begin
         self.field = new_field(name, value)
-      rescue
+      rescue => e
         self.field = Mail::UnstructuredField.new(name, value)
+        self.field.errors << [name, value, e]
+        self.field
       end
     end
 
     def new_field(name, value)
       # Could do this with constantize and make it "as DRY as", but a simple case 
       # statement is, well, simpler... 
-      case name.to_s
+      case name.to_s.downcase
       when /^to$/i
         ToField.new(name, value)
       when /^cc$/i

data/lib/mail/fields/common/parameter_hash.rb

@@ -2,12 +2,16 @@
 module Mail
 
   # ParameterHash is an intelligent Hash that allows you to add
-  # parameter values including the mime extension paramaters that
+  # parameter values including the MIME extension paramaters that
   # have the name*0="blah", name*1="bleh" keys, and will just return
   # a single key called name="blahbleh" and do any required un-encoding
   # to make that happen
+  # Parameters are defined in RFC2045, split keys are in RFC2231
+
   class ParameterHash < HashWithIndifferentAccess
 
+    include Mail::Utilities
+
     def [](key_name)
       pairs = select { |k,v| k =~ /^#{key_name}\*/ }
       pairs = pairs.to_a if RUBY_VERSION >= '1.9'
@@ -31,9 +35,14 @@ module Mail
           value = Mail::Encodings.param_encode(value)
           key_name = "#{key_name}*"
         end
-        %Q{#{key_name}="#{value}"}
+        %Q{#{key_name}=#{quote_token(value)}}
       end.join(";\r\n\t")
     end
 
+    def decoded
+      map.sort { |a,b| a.first <=> b.first }.map do |key_name, value|
+        %Q{#{key_name}=#{quote_token(value)}}
+      end.join("; ")
+    end
   end
-end
+end

data/lib/mail/fields/content_disposition_field.rb

@@ -49,11 +49,21 @@ module Mail
 
     # TODO: Fix this up
     def encoded
-      "#{CAPITALIZED_FIELD}: #{value}\r\n"
+      if parameters.length > 0
+        p = ";\r\n\t#{parameters.encoded}\r\n"
+      else
+        p = ""
+      end
+      "#{CAPITALIZED_FIELD}: #{disposition_type}" + p
     end
     
     def decoded
-      value
+      if parameters.length > 0
+        p = "; #{parameters.decoded}"
+      else
+        p = ""
+      end
+      "#{disposition_type}" + p
     end
 
   end

data/lib/mail/fields/content_location_field.rb

@@ -31,11 +31,11 @@ module Mail
 
     # TODO: Fix this up
     def encoded
-      "#{CAPITALIZED_FIELD}: #{value}\r\n"
+      "#{CAPITALIZED_FIELD}: #{location}\r\n"
     end
     
     def decoded
-      value
+      location 
     end
 
   end

data/lib/mail/fields/content_transfer_encoding_field.rb

@@ -10,16 +10,18 @@ module Mail
     
     def initialize(*args)
       super(CAPITALIZED_FIELD, strip_field(FIELD_NAME, args.last.to_s.downcase))
+      parse(value)
+      self
     end
     
     def parse(val = value)
       unless val.blank?
         @element = Mail::ContentTransferEncodingElement.new(val)
-        @tree = @element.tree
       end
     end
     
     def tree
+      STDERR.puts("tree is deprecated.  Please use encoding to get parse result\n#{caller}")
       @element ||= Mail::ContentTransferEncodingElement.new(value)
       @tree ||= @element.tree
     end
@@ -34,11 +36,11 @@ module Mail
     
     # TODO: Fix this up
     def encoded
-      "#{CAPITALIZED_FIELD}: #{value}\r\n"
+      "#{CAPITALIZED_FIELD}: #{encoding}\r\n"
     end
     
     def decoded
-      value
+      encoding
     end
     
   end

data/lib/mail/fields/content_type_field.rb

@@ -44,7 +44,7 @@ module Mail
       # Sanitize the value, handle special cases
       @element ||= Mail::ContentTypeElement.new(sanatize(value))
     rescue
-      # All else fails, just get the mime type
+      # All else fails, just get the MIME media type
       @element ||= Mail::ContentTypeElement.new(get_mime_type(value))
     end
     
@@ -108,11 +108,21 @@ module Mail
     
     # TODO: Fix this up
     def encoded
-      "#{CAPITALIZED_FIELD}: #{content_type};\r\n\t#{parameters.encoded};\r\n"
+      if parameters.length > 0
+        p = ";\r\n\t#{parameters.encoded}\r\n"
+      else
+        p = ""
+      end
+      "#{CAPITALIZED_FIELD}: #{content_type}" + p
     end
     
     def decoded
-      value
+      if parameters.length > 0
+        p = "; #{parameters.decoded}"
+      else
+        p = ""
+      end
+      "#{content_type}" + p
     end
 
     private
@@ -135,7 +145,7 @@ module Mail
         "#{$1}/#{$2}; #{$3}"
       when val.chomp =~ /^\s*([\w\d\-_]+)\/([\w\d\-_]+)\s*;(ISO[\w\d\-_]+)$/i
         # Microsoft helper:
-        # Handles 'mime/type;ISO-8559-1'
+        # Handles 'type/subtype;ISO-8559-1'
         "#{$1}/#{$2}; charset=#{quote_atom($3)}"
       when val.chomp =~ /^text;?$/i
         # Handles 'text;' and 'text'

data/lib/mail/fields/mime_version_field.rb

@@ -43,11 +43,11 @@ module Mail
     end
     
     def encoded
-      "#{CAPITALIZED_FIELD}: #{value}\r\n"
+      "#{CAPITALIZED_FIELD}: #{version}\r\n"
     end
     
     def decoded
-      value
+      version
     end
     
   end

data/lib/mail/fields/received_field.rb

@@ -43,19 +43,23 @@ module Mail
     end
     
     def date_time
-      ::DateTime.parse("#{element.date_time}")
+      @datetime ||= ::DateTime.parse("#{element.date_time}")
     end
 
     def info
       element.info
     end
-    
+   
+    def formatted_date
+        date_time.strftime("%a, %d %b %Y %H:%M:%S ") + date_time.zone.delete(':')
+    end
+ 
     def encoded
-      "#{CAPITALIZED_FIELD}: #{value}"
+      "#{CAPITALIZED_FIELD}: #{info}; #{formatted_date}\r\n"
     end
     
     def decoded
-      value
+      "#{info}; #{formatted_date}" 
     end
     
   end

data/lib/mail/fields/structured_field.rb

@@ -31,6 +31,10 @@ module Mail
     def default
       decoded
     end
+    
+    def errors
+      []
+    end
 
   end
 end

data/lib/mail/fields/unstructured_field.rb

@@ -18,11 +18,16 @@ module Mail
     include Mail::Utilities
     
     def initialize(*args)
+      @errors = []
       self.name = args.first
       self.value = args.last
       self
     end
     
+    def errors
+      @errors
+    end
+    
     def encoded
       do_encode(self.name)
     end

data/lib/mail/header.rb

@@ -34,6 +34,7 @@ module Mail
     # these cases, please make a patch and send it in, or at the least, send
     # me the example so we can fix it.
     def initialize(header_text = nil)
+      @errors = []
       self.raw_source = header_text.to_crlf
       split_header if header_text
     end
@@ -74,6 +75,7 @@ module Mail
       unfolded_fields.each do |field|
 
         field = Field.new(field)
+        field.errors.each { |error| self.errors << error }
         selected = select_field_for(field.name)
 
         if selected.any? && limited_field?(field.name)
@@ -85,6 +87,10 @@ module Mail
 
     end
     
+    def errors
+      @errors
+    end
+    
     #  3.6. Field definitions
     #  
     #   The following table indicates limits on the number of times each
@@ -107,7 +113,7 @@ module Mail
     #  h['To']          #=> 'mikel@me.com'
     #  h['X-Mail-SPAM'] #=> ['15', '20']
     def [](name)
-      name = dasherize(name)
+      name = dasherize(name).downcase
       selected = select_field_for(name)
       case
       when selected.length > 1
@@ -134,7 +140,8 @@ module Mail
     #  h['X-Mail-SPAM'] # => nil
     def []=(name, value)
       name = dasherize(name)
-      selected = select_field_for(name)
+      fn = name.downcase
+      selected = select_field_for(fn)
       
       case
       # User wants to delete the field
@@ -142,8 +149,8 @@ module Mail
         fields.delete_if { |f| selected.include?(f) }
         
       # User wants to change the field
-      when !selected.blank? && limited_field?(name)
-        selected.first.update(name, value)
+      when !selected.blank? && limited_field?(fn)
+        selected.first.update(fn, value)
         
       # User wants to create the field
       else
@@ -193,7 +200,7 @@ module Mail
       !fields.select { |f| f.responsible_for?('Date') }.empty?
     end
 
-    # Returns true if the header has a message_id defined (empty or not)
+    # Returns true if the header has a MIME version defined (empty or not)
     def has_mime_version?
       !fields.select { |f| f.responsible_for?('Mime-Version') }.empty?
     end
@@ -236,4 +243,4 @@ module Mail
     end
     
   end
-end
+end