mail 2.6.6 → 2.7.1

data/lib/mail/elements/address.rb

@@ -1,8 +1,9 @@
 # encoding: utf-8
 # frozen_string_literal: true
+require 'mail/parsers/address_lists_parser'
+
 module Mail
   class Address
-
     include Mail::Utilities
 
     # Mail::Address handles all email addresses in Mail.  It takes an email address string
@@ -22,7 +23,6 @@ module Mail
     #  a.comments     #=> ['My email address']
     #  a.to_s         #=> 'Mikel Lindsaar <mikel@test.lindsaar.net> (My email address)'
     def initialize(value = nil)
-      @output_type = :decode
       if value.nil?
         @parsed = false
         @data = nil
@@ -44,14 +44,14 @@ module Mail
     #
     #  a = Address.new('Mikel Lindsaar (My email address) <mikel@test.lindsaar.net>')
     #  a.format #=> 'Mikel Lindsaar <mikel@test.lindsaar.net> (My email address)'
-    def format
+    def format(output_type = :decode)
       parse unless @parsed
       if @data.nil?
         EMPTY
-      elsif display_name
-        [quote_phrase(display_name), "<#{address}>", format_comments].compact.join(SPACE)
-      elsif address
-        [address, format_comments].compact.join(SPACE)
+      elsif name = display_name(output_type)
+        [quote_phrase(name), "<#{address(output_type)}>", format_comments].compact.join(SPACE)
+      elsif a = address(output_type)
+        [a, format_comments].compact.join(SPACE)
       else
         raw
       end
@@ -62,9 +62,13 @@ module Mail
     #
     #  a = Address.new('Mikel Lindsaar (My email address) <mikel@test.lindsaar.net>')
     #  a.address #=> 'mikel@test.lindsaar.net'
-    def address
+    def address(output_type = :decode)
       parse unless @parsed
-      domain ? "#{local}@#{domain}" : local
+      if d = domain(output_type)
+        "#{local(output_type)}@#{d}"
+      else
+        local(output_type)
+      end
     end
 
     # Provides a way to assign an address to an already made Mail::Address object.
@@ -80,10 +84,10 @@ module Mail
     #
     #  a = Address.new('Mikel Lindsaar (My email address) <mikel@test.lindsaar.net>')
     #  a.display_name #=> 'Mikel Lindsaar'
-    def display_name
+    def display_name(output_type = :decode)
       parse unless @parsed
       @display_name ||= get_display_name
-      Encodings.decode_encode(@display_name.to_s, @output_type) if @display_name
+      Encodings.decode_encode(@display_name.to_s, output_type) if @display_name
     end
 
     # Provides a way to assign a display name to an already made Mail::Address object.
@@ -101,9 +105,9 @@ module Mail
     #
     #  a = Address.new('Mikel Lindsaar (My email address) <mikel@test.lindsaar.net>')
     #  a.local #=> 'mikel'
-    def local
+    def local(output_type = :decode)
       parse unless @parsed
-      Encodings.decode_encode("#{@data.obs_domain_list}#{get_local.strip}", @output_type) if get_local
+      Encodings.decode_encode("#{@data.obs_domain_list}#{get_local.strip}", output_type) if get_local
     end
 
     # Returns the domain part (the right hand side of the @ sign in the email address) of
@@ -111,16 +115,20 @@ module Mail
     #
     #  a = Address.new('Mikel Lindsaar (My email address) <mikel@test.lindsaar.net>')
     #  a.domain #=> 'test.lindsaar.net'
-    def domain
+    def domain(output_type = :decode)
       parse unless @parsed
-      Encodings.decode_encode(strip_all_comments(get_domain), @output_type) if get_domain
+      Encodings.decode_encode(strip_all_comments(get_domain), output_type) if get_domain
     end
 
-    # Returns an array of comments that are in the email, or an empty array if there
+    # Returns an array of comments that are in the email, or nil if there
     # are no comments
     #
     #  a = Address.new('Mikel Lindsaar (My email address) <mikel@test.lindsaar.net>')
     #  a.comments #=> ['My email address']
+    #
+    #  b = Address.new('Mikel Lindsaar <mikel@test.lindsaar.net>')
+    #  b.comments #=> nil
+
     def comments
       parse unless @parsed
       comments = get_comments
@@ -159,13 +167,11 @@ module Mail
     end
 
     def encoded
-      @output_type = :encode
-      format
+      format :encode
     end
 
     def decoded
-      @output_type = :decode
-      format
+      format :decode
     end
 
     def group
@@ -179,11 +185,11 @@ module Mail
       @data = nil
 
       case value
-      when Mail::Parsers::AddressStruct
+      when Mail::Parsers::AddressListsParser::AddressStruct
         @data = value
       when String
         unless Utilities.blank?(value)
-          address_list = Mail::Parsers::AddressListsParser.new.parse(value)
+          address_list = Mail::Parsers::AddressListsParser.parse(value)
           @data = address_list.addresses.first
         end
       end

data/lib/mail/elements/address_list.rb

@@ -1,42 +1,34 @@
 # encoding: utf-8
 # frozen_string_literal: true
+require 'mail/parsers/address_lists_parser'
+
 module Mail
   class AddressList # :nodoc:
+    attr_reader :addresses, :group_names
 
     # Mail::AddressList is the class that parses To, From and other address fields from
     # emails passed into Mail.
-    # 
+    #
     # AddressList provides a way to query the groups and mailbox lists of the passed in
     # string.
-    # 
+    #
     # It can supply all addresses in an array, or return each address as an address object.
-    # 
+    #
     # Mail::AddressList requires a correctly formatted group or mailbox list per RFC2822 or
     # RFC822.  It also handles all obsolete versions in those RFCs.
-    # 
+    #
     #  list = 'ada@test.lindsaar.net, My Group: mikel@test.lindsaar.net, Bob <bob@test.lindsaar.net>;'
     #  a = AddressList.new(list)
     #  a.addresses    #=> [#<Mail::Address:14943130 Address: |ada@test.lindsaar.net...
     #  a.group_names  #=> ["My Group"]
     def initialize(string)
-      @addresses_grouped_by_group = nil
-      @address_list = Mail::Parsers::AddressListsParser.new.parse(string)
-    end
-    
-    # Returns a list of address objects from the parsed line
-    def addresses
-      @addresses ||= @address_list.addresses.map do |address_data|
-        Mail::Address.new(address_data)
-      end
+      address_list = Parsers::AddressListsParser.parse(string)
+      @addresses = address_list.addresses.map { |a| Address.new(a) }
+      @group_names = address_list.group_names
     end
 
     def addresses_grouped_by_group
       addresses.select(&:group).group_by(&:group)
     end
-    
-    # Returns the names as an array of strings of all groups
-    def group_names # :nodoc:
-      @address_list.group_names
-    end
   end
 end

data/lib/mail/elements/content_disposition_element.rb

@@ -1,27 +1,20 @@
 # encoding: utf-8
 # frozen_string_literal: true
+require 'mail/parsers/content_disposition_parser'
+
 module Mail
   class ContentDispositionElement # :nodoc:
-    
-    include Mail::Utilities
-    
-    def initialize( string )
-      content_disposition = Mail::Parsers::ContentDispositionParser.new.parse(cleaned(string))
+    attr_reader :disposition_type, :parameters
+
+    def initialize(string)
+      content_disposition = Mail::Parsers::ContentDispositionParser.parse(cleaned(string))
       @disposition_type = content_disposition.disposition_type
       @parameters = content_disposition.parameters
     end
-    
-    def disposition_type
-      @disposition_type
-    end
-    
-    def parameters
-      @parameters
-    end
-    
+
+    private
     def cleaned(string)
       string =~ /(.+);\s*$/ ? $1 : string
     end
-    
   end
 end

data/lib/mail/elements/content_location_element.rb

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

data/lib/mail/elements/content_transfer_encoding_element.rb

@@ -1,18 +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,32 +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,23 +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,40 +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,26 +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)
-      raise Mail::Field::ParseError.new(Mail::MessageIdsElement, string, 'nil is invalid') if string.nil?
-      @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
+      message_ids.first
     end
 
-    def clean_msg_id( val )
-      val =~ /.*<(.*)>.*/ ; $1
+    private
+    def clean_msg_id(val)
+      val =~ /.*<(.*)>.*/ ? $1 : val
     end
-
   end
 end

data/lib/mail/elements/mime_version_element.rb

@@ -1,23 +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,17 +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,27 +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/encodings/7bit.rb

@@ -4,29 +4,19 @@ 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

@@ -6,32 +6,13 @@ 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)
-        ::Mail::Utilities.to_lf str
-      end
-    
-      # Encode the string
-      def self.encode(str)
-        ::Mail::Utilities.to_crlf 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)
 
       # 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.length > 998 }
+        !str.lines.find { |line| line.bytesize > 998 }
       end
-
-      Encodings.register(NAME, self) 
     end
   end
 end

data/lib/mail/encodings/base64.rb

@@ -4,36 +4,35 @@ 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)
-        ::Mail::Utilities.to_crlf(RubyVer.encode_base64( str ))
+        ::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
 
-      # Base64 inserts newlines automatically and cannot violate the SMTP spec.
+      # Ruby Base64 inserts newlines automatically, so it doesn't exceed
+      # SMTP line length limits.
       def self.compatible_input?(str)
         true
       end
-
-      Encodings.register(NAME, self)      
     end
   end
 end

data/lib/mail/encodings/binary.rb

@@ -1,32 +1,13 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/encodings/transfer_encoding'
+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