mail 2.7.0.rc1 → 2.7.0.rc2

data/lib/mail/encodings/identity.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+# frozen_string_literal: true
+require 'mail/encodings/transfer_encoding'
+
+module Mail
+  module Encodings
+    # Identity encodings do no encoding/decoding and have a fixed cost:
+    # 1 byte in -> 1 byte out.
+    class Identity < TransferEncoding #:nodoc:
+      def self.decode(str)
+        str
+      end
+
+      def self.encode(str)
+        str
+      end
+
+      # 1 output byte per input byte.
+      def self.cost(str)
+        1.0
+      end
+    end
+  end
+end

data/lib/mail/encodings/quoted_printable.rb

@@ -6,27 +6,27 @@ module Mail
   module Encodings
     class QuotedPrintable < SevenBit
       NAME='quoted-printable'
-   
+
       PRIORITY = 2
 
-      def self.can_encode?(str)
-        EightBit.can_encode? str
+      def self.can_encode?(enc)
+        EightBit.can_encode? enc
       end
 
       # Decode the string from Quoted-Printable. Cope with hard line breaks
       # that were incorrectly encoded as hex instead of literal CRLF.
       def self.decode(str)
-        ::Mail::Utilities.to_lf str.gsub(/(?:=0D=0A|=0D|=0A)\r\n/, "\r\n").unpack("M*").first
+        str.gsub(/(?:=0D=0A|=0D|=0A)\r\n/, "\r\n").unpack("M*").first
       end
 
       def self.encode(str)
-        ::Mail::Utilities.to_crlf([::Mail::Utilities.to_lf(str)].pack("M"))
+        [str].pack("M")
       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 
+        # 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

data/lib/mail/encodings/transfer_encoding.rb

@@ -7,17 +7,17 @@ module Mail
 
       PRIORITY = -1
 
+      # And encoding's superclass can always transport it since the
+      # class hierarchy is arranged e.g. Base64 < 7bit < 8bit < Binary.
       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
+        enc && enc <= self
       end
 
+      # Override in subclasses to indicate that they can encode text
+      # that couldn't be directly transported, e.g. Base64 has 7bit output,
+      # but it can encode binary.
       def self.can_encode?(enc)
-        can_transport? enc 
+        can_transport? enc
       end
 
       def self.cost(str)
@@ -32,36 +32,45 @@ module Mail
         self::NAME
       end
 
-      def self.get_best_compatible(source_encoding, str)
-        if self.can_transport?(source_encoding) && self.compatible_input?(str)
+      def self.negotiate(message_encoding, source_encoding, str, allowed_encodings = nil)
+        message_encoding = Encodings.get_encoding(message_encoding || '8bit')
+        source_encoding  = Encodings.get_encoding(source_encoding)
+
+        if message_encoding && source_encoding && message_encoding.can_transport?(source_encoding) && source_encoding.compatible_input?(str)
           source_encoding
         else
-          choices = Encodings.get_all.select do |enc|
-            self.can_transport?(enc) && enc.can_encode?(source_encoding)
-          end
+          renegotiate(message_encoding, source_encoding, str, allowed_encodings)
+        end
+      end
 
-          best = nil
-          best_cost = nil
+      def self.renegotiate(message_encoding, source_encoding, str, allowed_encodings = nil)
+        encodings = Encodings.get_all.select do |enc|
+          (allowed_encodings.nil? || allowed_encodings.include?(enc)) &&
+            message_encoding.can_transport?(enc) &&
+            enc.can_encode?(source_encoding)
+        end
 
-          choices.each do |enc|
-            # If the current choice cannot be transported safely,
-            # give priority to other choices but allow it to be used as a fallback.
-            this_cost = enc.cost(str) if enc.compatible_input?(str)
+        lowest_cost(str, encodings)
+      end
 
-            if !best_cost || (this_cost && this_cost < best_cost)
-              best_cost = this_cost
-              best = enc
-            elsif this_cost == best_cost
-              best = enc if enc::PRIORITY < best::PRIORITY
-            end
-          end
+      def self.lowest_cost(str, encodings)
+        best = nil
+        best_cost = nil
 
-          best
+        encodings.each do |enc|
+          # If the current choice cannot be transported safely, give priority
+          # to other choices but allow it to be used as a fallback.
+          this_cost = enc.cost(str) if enc.compatible_input?(str)
+
+          if !best_cost || (this_cost && this_cost < best_cost)
+            best_cost = this_cost
+            best = enc
+          elsif this_cost == best_cost
+            best = enc if enc::PRIORITY < best::PRIORITY
+          end
         end
-      end
 
-      def to_s
-        self.class.to_s
+        best
       end
     end
   end

data/lib/mail/encodings/unix_to_unix.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 module Mail
   module Encodings
-    module UnixToUnix
+    class UnixToUnix < TransferEncoding
       NAME = "x-uuencode"
 
       def self.decode(str)
@@ -13,6 +13,7 @@ module Mail
       end
 
       Encodings.register(NAME, self)
+      Encodings.register("uuencode", self)
     end
   end
 end

data/lib/mail/envelope.rb

@@ -12,7 +12,7 @@ module Mail
   class Envelope < StructuredField
     
     def initialize(*args)
-      super(FIELD_NAME, strip_field(FIELD_NAME, args.last))
+      super(FIELD_NAME, args.last.to_s)
     end
     
     def element

data/lib/mail/field.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 require 'mail/fields'
+require 'mail/constants'
 
 # encoding: utf-8
 module Mail
@@ -83,9 +84,31 @@ module Mail
 
       def initialize(element, value, reason)
         @element = element
-        @value = value
-        @reason = reason
-        super("#{element} can not parse |#{value}|\nReason was: #{reason}")
+        @value = to_utf8(value)
+        @reason = to_utf8(reason)
+        super("#{@element} can not parse |#{@value}|: #{@reason}")
+      end
+
+      private
+        def to_utf8(text)
+          if text.respond_to?(:force_encoding)
+            text.dup.force_encoding(Encoding::UTF_8)
+          else
+            text
+          end
+        end
+    end
+
+    class NilParseError < ParseError #:nodoc:
+      def initialize(element)
+        super element, nil, 'nil is invalid'
+      end
+    end
+
+    class IncompleteParseError < ParseError #:nodoc:
+      def initialize(element, original_text, unparsed_index)
+        parsed_text = to_utf8(original_text[0...unparsed_index])
+        super element, original_text, "Only able to parse up to #{parsed_text.inspect}"
       end
     end
 
@@ -93,41 +116,62 @@ module Mail
     class SyntaxError < FieldError #:nodoc:
     end
 
-    # Accepts a string:
-    #
-    #  Field.new("field-name: field data")
-    #
-    # Or name, value pair:
-    #
-    #  Field.new("field-name", "value")
+    class << self
+      # Parse a field from a raw header line:
+      #
+      #  Mail::Field.parse("field-name: field data")
+      #  # => #<Mail::Field …>
+      def parse(field, charset = nil)
+        name, value = split(field)
+        if name && value
+          new name, value, charset
+        end
+      end
+
+      def split(raw_field) #:nodoc:
+        if raw_field.index(Constants::COLON)
+          name, value = raw_field.split(Constants::COLON, 2)
+          name.rstrip!
+          if name =~ /\A#{Constants::FIELD_NAME}\z/
+            [ name.rstrip, value.strip ]
+          else
+            Kernel.warn "WARNING: Ignoring unparsable header #{raw_field.inspect}: invalid header name syntax: #{name.inspect}"
+            nil
+          end
+        else
+          raw_field.strip
+        end
+      rescue => error
+        warn "WARNING: Ignoring unparsable header #{raw_field.inspect}: #{error.class}: #{error.message}"
+        nil
+      end
+    end
+
+    # Create a field by name and optional value:
     #
-    # Or a name by itself:
+    #  Mail::Field.new("field-name", "value")
+    #  # => #<Mail::Field …>
     #
-    #  Field.new("field-name")
+    # Values that aren't strings or arrays are coerced to Strings with `#to_s`.
     #
-    # Note, does not want a terminating carriage return.  Returns
-    # self appropriately parsed.  If value is not a string, then
-    # it will be passed through as is, for example, content-type
-    # field can accept an array with the type and a hash of
-    # parameters:
+    #  Mail::Field.new("field-name", 1234)
+    #  # => #<Mail::Field …>
     #
-    #  Field.new('content-type', ['text', 'plain', {:charset => 'UTF-8'}])
+    #  Mail::Field.new('content-type', ['text', 'plain', {:charset => 'UTF-8'}])
+    #  # => #<Mail::Field …>
     def initialize(name, value = nil, charset = 'utf-8')
       case
-      when name.index(COLON)            # Field.new("field-name: field data")
+      when name.index(COLON)
+        Kernel.warn 'Passing an unparsed header field to Mail::Field.new is deprecated and will be removed in Mail 2.8.0. Use Mail::Field.parse instead.'
+        @name, @unparsed_value = self.class.split(name)
         @charset = Utilities.blank?(value) ? charset : value
-        @name = name[FIELD_PREFIX]
-        @raw_value = name
-        @value = nil
-      when Utilities.blank?(value)   # Field.new("field-name")
+      when Utilities.blank?(value)
         @name = name
-        @value = nil
-        @raw_value = nil
+        @unparsed_value = nil
         @charset = charset
-      else                              # Field.new("field-name", "value")
+      else
         @name = name
-        @value = value
-        @raw_value = nil
+        @unparsed_value = value
         @charset = charset
       end
       @name = FIELD_NAME_MAP[@name.to_s.downcase] || @name
@@ -138,8 +182,7 @@ module Mail
     end
 
     def field
-      _, @value = split(@raw_value) if @raw_value && !@value
-      @field ||= create_field(@name, @value, @charset)
+      @field ||= create_field(@name, @unparsed_value, @charset)
     end
 
     def name
@@ -217,14 +260,26 @@ module Mail
 
     private
 
-    def split(raw_field)
-      match_data = Mail::Multibyte.mb_chars(raw_field).match(FIELD_SPLIT)
-      [
-        Mail::Multibyte.mb_chars(match_data[1].to_s).strip,
-        Mail::Multibyte.mb_chars(match_data[2].to_s).strip.to_s
-      ]
-    rescue
-      $stderr.puts "WARNING: Could not parse (and so ignoring) '#{raw_field}'"
+    def create_field(name, value, charset)
+      new_field(name, value, charset)
+    rescue Mail::Field::ParseError => e
+      field = Mail::UnstructuredField.new(name, value)
+      field.errors << [name, value, e]
+      field
+    end
+
+    def new_field(name, value, charset)
+      value = unfold(value) if value.is_a?(String)
+
+      if klass = field_class_for(name)
+        klass.new(value, charset)
+      else
+        OptionalField.new(name, value, charset)
+      end
+    end
+
+    def field_class_for(name)
+      FIELDS_MAP[name.to_s.downcase]
     end
 
     # 2.2.3. Long Header Fields
@@ -238,28 +293,5 @@ module Mail
     def unfold(string)
       string.gsub(/#{CRLF}(#{WSP})/m, '\1')
     end
-
-    def create_field(name, value, charset)
-      value = unfold(value) if value.is_a?(String)
-
-      begin
-        new_field(name, value, charset)
-      rescue Mail::Field::ParseError => e
-        field = Mail::UnstructuredField.new(name, value)
-        field.errors << [name, value, e]
-        field
-      end
-    end
-
-    def new_field(name, value, charset)
-      lower_case_name = name.to_s.downcase
-      if field_klass = FIELDS_MAP[lower_case_name]
-        field_klass.new(value, charset)
-      else
-        OptionalField.new(name, value, charset)
-      end
-    end
-
   end
-
 end

data/lib/mail/fields/bcc_field.rb

@@ -37,9 +37,9 @@ module Mail
     FIELD_NAME = 'bcc'
     CAPITALIZED_FIELD = 'Bcc'
     
-    def initialize(value = '', charset = 'utf-8')
+    def initialize(value = nil, charset = 'utf-8')
       @charset = charset
-      super(CAPITALIZED_FIELD, strip_field(FIELD_NAME, value), charset)
+      super(CAPITALIZED_FIELD, value, charset)
       self
     end
     

data/lib/mail/fields/cc_field.rb

@@ -39,7 +39,7 @@ module Mail
     
     def initialize(value = nil, charset = 'utf-8')
       self.charset = charset
-      super(CAPITALIZED_FIELD, strip_field(FIELD_NAME, value), charset)
+      super(CAPITALIZED_FIELD, value, charset)
       self
     end
     

data/lib/mail/fields/comments_field.rb

@@ -33,7 +33,7 @@ module Mail
     
     def initialize(value = nil, charset = 'utf-8')
       @charset = charset
-      super(CAPITALIZED_FIELD, strip_field(FIELD_NAME, value))
+      super(CAPITALIZED_FIELD, value)
       self.parse
       self
     end

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

@@ -4,7 +4,6 @@ require 'mail/fields/common/address_container'
 
 module Mail
   module CommonAddress # :nodoc:
-      
     def parse(val = value)
       unless Utilities.blank?(val)
         @address_list = AddressList.new(encode_if_needed(val))
@@ -12,15 +11,22 @@ module Mail
         nil
       end
     end
-    
+
     def charset
       @charset
     end
-    
-    def encode_if_needed(val)
-      Encodings.address_encode(val, charset)
+
+    def encode_if_needed(val) #:nodoc:
+      # Need to join arrays of addresses into a single value
+      if val.kind_of?(Array)
+        val.compact.map { |a| encode_if_needed a }.join(', ')
+
+      # Pass through UTF-8; encode non-UTF-8.
+      else
+        utf8_if_needed(val) || Encodings.encode_non_usascii(val, charset)
+      end
     end
-    
+
     # Allows you to iterate through each address object in the address_list
     def each
       address_list.addresses.each do |address|
@@ -98,7 +104,26 @@ module Mail
     end
   
     private
-  
+
+    if 'string'.respond_to?(:encoding)
+      # Pass through UTF-8 addresses
+      def utf8_if_needed(val)
+        if charset =~ /\AUTF-?8\z/i
+          val
+        elsif val.encoding == Encoding::UTF_8
+          val
+        elsif (utf8 = val.dup.force_encoding(Encoding::UTF_8)).valid_encoding?
+          utf8
+        end
+      end
+    else
+      def utf8_if_needed(val)
+        if charset =~ /\AUTF-?8\z/i
+          val
+        end
+      end
+    end
+
     def do_encode(field_name)
       return '' if Utilities.blank?(value)
       address_array = address_list.addresses.reject { |a| encoded_group_addresses.include?(a.encoded) }.compact.map { |a| a.encoded }