mail 2.6.1 → 2.7.1

data/lib/mail/elements/content_location_element.rb

@@ -1,21 +1,17 @@
 # encoding: utf-8
+# frozen_string_literal: true
+require 'mail/parsers/content_location_parser'
+
 module Mail
   class ContentLocationElement # :nodoc:
-    
-    include Mail::Utilities
-    
-    def initialize( string )
-      content_location = Mail::Parsers::ContentLocationParser.new.parse(string)
-      @location = content_location.location
+    attr_reader :location
+
+    def initialize(string)
+      @location = Mail::Parsers::ContentLocationParser.parse(string).location
     end
-    
-    def location
-      @location
-    end
-    
+
     def to_s(*args)
       location.to_s
     end
-    
   end
 end

data/lib/mail/elements/content_transfer_encoding_element.rb

@@ -1,17 +1,13 @@
 # encoding: utf-8
+# frozen_string_literal: true
+require 'mail/parsers/content_transfer_encoding_parser'
+
 module Mail
   class ContentTransferEncodingElement
-    
-    include Mail::Utilities
-    
+    attr_reader :encoding
+
     def initialize(string)
-      content_transfer_encoding = Mail::Parsers::ContentTransferEncodingParser.new.parse(string)
-      @encoding = content_transfer_encoding.encoding
+      @encoding = Mail::Parsers::ContentTransferEncodingParser.parse(string).encoding
     end
-    
-    def encoding
-      @encoding
-    end
-    
   end
 end

data/lib/mail/elements/content_type_element.rb

@@ -1,31 +1,21 @@
 # encoding: utf-8
+# frozen_string_literal: true
+require 'mail/parsers/content_type_parser'
+
 module Mail
   class ContentTypeElement # :nodoc:
-    
-    include Mail::Utilities
-    
-    def initialize( string )
-      content_type = Mail::Parsers::ContentTypeParser.new.parse(cleaned(string))
+    attr_reader :main_type, :sub_type, :parameters
+
+    def initialize(string)
+      content_type = Mail::Parsers::ContentTypeParser.parse(cleaned(string))
       @main_type = content_type.main_type
       @sub_type = content_type.sub_type
       @parameters = content_type.parameters
     end
-    
-    def main_type
-      @main_type
-    end
-    
-    def sub_type
-      @sub_type
-    end
-    
-    def parameters
-      @parameters
-    end
-    
+
+    private
     def cleaned(string)
       string =~ /(.+);\s*$/ ? $1 : string
     end
-    
   end
 end

data/lib/mail/elements/date_time_element.rb

@@ -1,22 +1,15 @@
 # encoding: utf-8
+# frozen_string_literal: true
+require 'mail/parsers/date_time_parser'
+
 module Mail
   class DateTimeElement # :nodoc:
-    
-    include Mail::Utilities
-    
-    def initialize( string )
-      date_time = Mail::Parsers::DateTimeParser.new.parse(string)
+    attr_reader :date_string, :time_string
+
+    def initialize(string)
+      date_time = Mail::Parsers::DateTimeParser.parse(string)
       @date_string = date_time.date_string
       @time_string = date_time.time_string
     end
-    
-    def date_string
-      @date_string
-    end
-    
-    def time_string
-      @time_string
-    end
-    
   end
 end

data/lib/mail/elements/envelope_from_element.rb

@@ -1,39 +1,33 @@
 # encoding: utf-8
+# frozen_string_literal: true
+require 'mail/parsers/envelope_from_parser'
+require 'date'
+
 module Mail
   class EnvelopeFromElement
-    
-    include Mail::Utilities
-    
-    def initialize( string )
-      @envelope_from = Mail::Parsers::EnvelopeFromParser.new.parse(string)
-      @address = @envelope_from.address
-      @date_time = ::DateTime.parse(@envelope_from.ctime_date)
-    end
-    
-    def date_time
-      @date_time
-    end
-    
-    def address
-      @address
+    attr_reader :date_time, :address
+
+    def initialize(string)
+      envelope_from = Mail::Parsers::EnvelopeFromParser.parse(string)
+      @address = envelope_from.address
+      @date_time = ::DateTime.parse(envelope_from.ctime_date)
     end
-    
+
     # RFC 4155:
     #   a timestamp indicating the UTC date and time when the message
     #   was originally received, conformant with the syntax of the
     #   traditional UNIX 'ctime' output sans timezone (note that the
     #   use of UTC precludes the need for a timezone indicator);
     def formatted_date_time
-      if @date_time.respond_to?(:ctime)
-        @date_time.ctime
+      if date_time.respond_to?(:ctime)
+        date_time.ctime
       else
-        @date_time.strftime '%a %b %e %T %Y'
+        date_time.strftime '%a %b %e %T %Y'
       end
     end
 
     def to_s
-      "#{@address} #{formatted_date_time}"
+      "#{address} #{formatted_date_time}"
     end
-    
   end
 end

data/lib/mail/elements/message_ids_element.rb

@@ -1,24 +1,22 @@
 # encoding: utf-8
+# frozen_string_literal: true
+require 'mail/parsers/message_ids_parser'
+
 module Mail
   class MessageIdsElement
-    
-    include Mail::Utilities
-    
+    attr_reader :message_ids
+
     def initialize(string)
-      @message_ids = Mail::Parsers::MessageIdsParser.new.parse(string).message_ids.map { |msg_id| clean_msg_id(msg_id) }
-    end
-    
-    def message_ids
-      @message_ids
+      @message_ids = Mail::Parsers::MessageIdsParser.parse(string).message_ids.map { |msg_id| clean_msg_id(msg_id) }
     end
-    
+
     def message_id
-      @message_ids.first
-    end
-    
-    def clean_msg_id( val )
-      val =~ /.*<(.*)>.*/ ; $1
+      message_ids.first
     end
 
+    private
+    def clean_msg_id(val)
+      val =~ /.*<(.*)>.*/ ? $1 : val
+    end
   end
 end

data/lib/mail/elements/mime_version_element.rb

@@ -1,22 +1,15 @@
 # encoding: utf-8
+# frozen_string_literal: true
+require 'mail/parsers/mime_version_parser'
+
 module Mail
   class MimeVersionElement
-    
-    include Mail::Utilities
-    
-    def initialize( string )
-      mime_version = Mail::Parsers::MimeVersionParser.new.parse(string)
+    attr_reader :major, :minor
+
+    def initialize(string)
+      mime_version = Mail::Parsers::MimeVersionParser.parse(string)
       @major = mime_version.major
       @minor = mime_version.minor
     end
-    
-    def major
-      @major
-    end
-    
-    def minor
-      @minor
-    end
-    
   end
 end

data/lib/mail/elements/phrase_list.rb

@@ -1,16 +1,14 @@
 # encoding: utf-8
+# frozen_string_literal: true
+require 'mail/parsers/phrase_lists_parser'
+require 'mail/utilities'
+
 module Mail
   class PhraseList
-    
-    include Mail::Utilities
-    
+    attr_reader :phrases
+
     def initialize(string)
-      @phrase_lists = Mail::Parsers::PhraseListsParser.new.parse(string)
+      @phrases = Mail::Parsers::PhraseListsParser.parse(string).phrases.map { |p| Mail::Utilities.unquote(p) }
     end
-    
-    def phrases
-      @phrase_lists.phrases.map { |p| unquote(p) }
-    end
-
   end
 end

data/lib/mail/elements/received_element.rb

@@ -1,26 +1,21 @@
 # encoding: utf-8
+# frozen_string_literal: true
+require 'mail/parsers/received_parser'
+require 'date'
+
 module Mail
   class ReceivedElement
-    
     include Mail::Utilities
-    
-    def initialize( string )
-      received = Mail::Parsers::ReceivedParser.new.parse(string)
+    attr_reader :date_time, :info
+
+    def initialize(string)
+      received = Mail::Parsers::ReceivedParser.parse(string)
       @date_time = ::DateTime.parse("#{received.date} #{received.time}")
       @info = received.info
     end
-    
-    def date_time
-      @date_time
-    end
-    
-    def info
-      @info
-    end
-    
+
     def to_s(*args)
-      "#{@info}; #{@date_time.to_s(*args)}"
+      "#{info}; #{date_time.to_s(*args)}"
     end
-    
   end
 end

data/lib/mail/elements.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Mail
   register_autoload :Address, 'mail/elements/address'
   register_autoload :AddressList, 'mail/elements/address_list'

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

@@ -1,31 +1,22 @@
 # encoding: utf-8
+# frozen_string_literal: true
 require 'mail/encodings/8bit'
 
 module Mail
   module Encodings
+    # 7bit and 8bit are equivalent. 7bit encoding is for text only.
     class SevenBit < EightBit
       NAME = '7bit'
-    
       PRIORITY = 1
+      Encodings.register(NAME, self)
 
-      # 7bit and 8bit operate the same
-      
-      # Decode the string
       def self.decode(str)
-        super
+        ::Mail::Utilities.binary_unsafe_to_lf str
       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 
+        ::Mail::Utilities.binary_unsafe_to_crlf str
       end
-
-      Encodings.register(NAME, self) 
     end
   end
 end

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

@@ -1,31 +1,18 @@
 # encoding: utf-8
+# frozen_string_literal: true
 require 'mail/encodings/binary'
 
 module Mail
   module Encodings
     class EightBit < Binary
       NAME = '8bit'
-
       PRIORITY = 4
+      Encodings.register(NAME, self)
 
-      # 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
+      # Per RFC 2821 4.5.3.1, SMTP lines may not be longer than 1000 octets including the <CRLF>.
+      def self.compatible_input?(str)
+        !str.lines.find { |line| line.bytesize > 998 }
       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,33 +1,38 @@
 # encoding: utf-8
+# frozen_string_literal: true
 require 'mail/encodings/7bit'
 
 module Mail
   module Encodings
+    # Base64 encoding handles binary content at the cost of 4 output bytes
+    # per input byte.
     class Base64 < SevenBit
       NAME = 'base64'
-     
       PRIORITY = 3
- 
+      Encodings.register(NAME, self)
+
       def self.can_encode?(enc)
         true
       end
 
-      # Decode the string from Base64
       def self.decode(str)
-        RubyVer.decode_base64( str )
+        RubyVer.decode_base64(str)
       end
-    
-      # Encode the string to Base64
+
       def self.encode(str)
-        RubyVer.encode_base64( str ).to_crlf
+        ::Mail::Utilities.binary_unsafe_to_crlf(RubyVer.encode_base64(str))
       end
 
-      # Base64 has a fixed cost, 4 bytes out per 3 bytes in
+      # 3 bytes in -> 4 bytes out
       def self.cost(str)
-        4.0/3
+        4.0 / 3
       end
 
-      Encodings.register(NAME, self)      
+      # Ruby Base64 inserts newlines automatically, so it doesn't exceed
+      # SMTP line length limits.
+      def self.compatible_input?(str)
+        true
+      end
     end
   end
 end

data/lib/mail/encodings/binary.rb

@@ -1,31 +1,13 @@
 # encoding: utf-8
-require 'mail/encodings/transfer_encoding'
+# frozen_string_literal: true
+require 'mail/encodings/identity'
 
 module Mail
   module Encodings
-    class Binary < TransferEncoding
+    class Binary < Identity
       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) 
+      Encodings.register(NAME, self)
     end
   end
 end

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

@@ -1,36 +1,42 @@
 # encoding: utf-8
+# frozen_string_literal: true
 require 'mail/encodings/7bit'
 
 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)
-        str.gsub(/(?:=0D=0A|=0D|=0A)\r\n/, "\r\n").unpack("M*").first.to_lf
+        str.gsub(/(?:=0D=0A|=0D|=0A)\r\n/, "\r\n").unpack("M*").first
       end
 
       def self.encode(str)
-        [str.to_lf].pack("M").to_crlf
+        [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
       end
-        
+
+      # QP inserts newlines automatically and cannot violate the SMTP spec.
+      def self.compatible_input?(str)
+        true
+      end
+
       private
 
       Encodings.register(NAME, self)

data/lib/mail/encodings/transfer_encoding.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 module Mail
   module Encodings
     class TransferEncoding
@@ -6,52 +7,70 @@ 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)
         raise "Unimplemented"
       end
 
+      def self.compatible_input?(str)
+        true
+      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 
+      def self.negotiate(message_encoding, source_encoding, str, allowed_encodings = nil)
+        message_encoding = Encodings.get_encoding(message_encoding) || Encodings.get_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.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
+          renegotiate(message_encoding, source_encoding, str, allowed_encodings)
         end
       end
 
-      def to_s
-        self.class.to_s
+      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
+
+        lowest_cost(str, encodings)
+      end
+
+      def self.lowest_cost(str, encodings)
+        best = nil
+        best_cost = nil
+
+        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
+
+        best
       end
     end
   end

data/lib/mail/encodings/unix_to_unix.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+module Mail
+  module Encodings
+    class UnixToUnix < TransferEncoding
+      NAME = "x-uuencode"
+
+      def self.decode(str)
+        str.sub(/\Abegin \d+ [^\n]*\n/, '').unpack('u').first
+      end
+
+      def self.encode(str)
+        [str].pack("u")
+      end
+
+      Encodings.register(NAME, self)
+      Encodings.register("uuencode", self)
+      Encodings.register("x-uue", self)
+    end
+  end
+end