mail 2.5.5 → 2.8.1

data/lib/mail/elements/address.rb

@@ -1,42 +1,40 @@
 # encoding: utf-8
+# frozen_string_literal: true
+require 'mail/parsers/address_lists_parser'
+require 'mail/constants'
+require 'mail/utilities'
+
 module Mail
+  # Mail::Address handles all email addresses in Mail.  It takes an email address string
+  # and parses it, breaking it down into its component parts and allowing you to get the
+  # address, comments, display name, name, local part, domain part and fully formatted
+  # address.
+  #
+  # Mail::Address requires a correctly formatted email address per RFC2822 or RFC822.  It
+  # handles all obsolete versions including obsolete domain routing on the local part.
+  #
+  #  a = Address.new('Mikel Lindsaar (My email address) <mikel@test.lindsaar.net>')
+  #  a.format       #=> 'Mikel Lindsaar <mikel@test.lindsaar.net> (My email address)'
+  #  a.address      #=> 'mikel@test.lindsaar.net'
+  #  a.display_name #=> 'Mikel Lindsaar'
+  #  a.local        #=> 'mikel'
+  #  a.domain       #=> 'test.lindsaar.net'
+  #  a.comments     #=> ['My email address']
+  #  a.to_s         #=> 'Mikel Lindsaar <mikel@test.lindsaar.net> (My email address)'
   class Address
-    
-    include Mail::Utilities
-    
-    # Mail::Address handles all email addresses in Mail.  It takes an email address string
-    # and parses it, breaking it down into its component parts and allowing you to get the
-    # address, comments, display name, name, local part, domain part and fully formatted
-    # address.
-    # 
-    # Mail::Address requires a correctly formatted email address per RFC2822 or RFC822.  It
-    # handles all obsolete versions including obsolete domain routing on the local part.
-    # 
-    #  a = Address.new('Mikel Lindsaar (My email address) <mikel@test.lindsaar.net>')
-    #  a.format       #=> 'Mikel Lindsaar <mikel@test.lindsaar.net> (My email address)'
-    #  a.address      #=> 'mikel@test.lindsaar.net'
-    #  a.display_name #=> 'Mikel Lindsaar'
-    #  a.local        #=> 'mikel'
-    #  a.domain       #=> 'test.lindsaar.net'
-    #  a.comments     #=> ['My email address']
-    #  a.to_s         #=> 'Mikel Lindsaar <mikel@test.lindsaar.net> (My email address)'
     def initialize(value = nil)
-      @output_type = :decode
-      @tree = nil
-      @raw_text = value
-      case
-      when value.nil?
+      if value.nil?
         @parsed = false
-        return
+        @data = nil
       else
         parse(value)
       end
     end
-    
-    # Returns the raw imput of the passed in string, this is before it is passed
+
+    # Returns the raw input of the passed in string, this is before it is passed
     # by the parser.
     def raw
-      @raw_text
+      @data.raw
     end
 
     # Returns a correctly formatted address for the email going out.  If given
@@ -46,112 +44,120 @@ 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
-      case
-      when tree.nil?
-        ''
-      when display_name
-        [quote_phrase(display_name), "<#{address}>", format_comments].compact.join(" ")
-      when address
-        [address, format_comments].compact.join(" ")
+      if @data.nil?
+        Constants::EMPTY
+      elsif name = display_name(output_type)
+        [Utilities.quote_phrase(name), "<#{address(output_type)}>", format_comments].compact.join(Constants::SPACE)
+      elsif a = address(output_type)
+        [a, format_comments].compact.join(Constants::SPACE)
       else
-        tree.text_value
+        raw
       end
     end
 
-    # Returns the address that is in the address itself.  That is, the 
+    # Returns the address that is in the address itself.  That is, the
     # local@domain string, without any angle brackets or the like.
-    # 
+    #
     #  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.
-    # 
+    #
     #  a = Address.new
     #  a.address = 'Mikel Lindsaar (My email address) <mikel@test.lindsaar.net>'
     #  a.address #=> 'mikel@test.lindsaar.net'
     def address=(value)
       parse(value)
     end
-    
+
     # Returns the display name of the email address passed in.
-    # 
+    #
     #  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.
-    # 
+    #
     #  a = Address.new
     #  a.address = 'mikel@test.lindsaar.net'
     #  a.display_name = 'Mikel Lindsaar'
     #  a.format #=> 'Mikel Lindsaar <mikel@test.lindsaar.net>'
     def display_name=( str )
-      @display_name = str
+      @display_name = str.nil? ? nil : str.dup # in case frozen
     end
 
     # Returns the local part (the left hand side of the @ sign in the email address) of
     # the address
-    # 
+    #
     #  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
-      "#{obs_domain_list}#{get_local.strip}" 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
     # the address
-    # 
+    #
     #  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
-      strip_all_comments(get_domain) 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
-      if get_comments.empty?
+      comments = get_comments
+      if comments.nil? || comments.none?
         nil
       else
-        get_comments.map { |c| c.squeeze(" ") }
+        comments.map { |c| c.squeeze(Constants::SPACE) }
       end
     end
-    
+
     # Sometimes an address will not have a display name, but might have the name
     # as a comment field after the address.  This returns that name if it exists.
-    # 
+    #
     #  a = Address.new('mikel@test.lindsaar.net (Mikel Lindsaar)')
     #  a.name #=> 'Mikel Lindsaar'
     def name
       parse unless @parsed
       get_name
     end
-    
+
     # Returns the format of the address, or returns nothing
-    # 
+    #
     #  a = Address.new('Mikel Lindsaar (My email address) <mikel@test.lindsaar.net>')
     #  a.format #=> 'Mikel Lindsaar <mikel@test.lindsaar.net> (My email address)'
     def to_s
       parse unless @parsed
       format
     end
-    
+
     # Shows the Address object basic details, including the Address
     #  a = Address.new('Mikel (My email) <mikel@test.lindsaar.net>')
     #  a.inspect #=> "#<Mail::Address:14184910 Address: |Mikel <mikel@test.lindsaar.net> (My email)| >"
@@ -159,156 +165,94 @@ module Mail
       parse unless @parsed
       "#<#{self.class}:#{self.object_id} Address: |#{to_s}| >"
     end
-    
+
     def encoded
-      @output_type = :encode
-      format
+      format :encode
     end
-    
+
     def decoded
-      @output_type = :decode
-      format
+      format :decode
+    end
+
+    def group
+      @data && @data.group
     end
 
     private
-    
+
     def parse(value = nil)
       @parsed = true
-      case
-      when value.nil?
-        nil
-      when value.class == String
-        self.tree = Mail::AddressList.new(value).address_nodes.first
-      else
-        self.tree = value
-      end
-    end
-    
-    
-    def get_domain
-      if tree.respond_to?(:angle_addr) && tree.angle_addr.respond_to?(:addr_spec) && tree.angle_addr.addr_spec.respond_to?(:domain)
-        @domain_text ||= tree.angle_addr.addr_spec.domain.text_value.strip
-      elsif tree.respond_to?(:domain)
-        @domain_text ||= tree.domain.text_value.strip
-      elsif tree.respond_to?(:addr_spec) && tree.addr_spec.respond_to?(:domain)
-        tree.addr_spec.domain.text_value.strip
-      else
-        nil
+      @data = nil
+
+      case value
+      when Mail::Parsers::AddressListsParser::AddressStruct
+        @data = value
+      when String
+        unless Utilities.blank?(value)
+          address_list = Mail::Parsers::AddressListsParser.parse(value)
+          @data = address_list.addresses.first
+        end
       end
     end
 
     def strip_all_comments(string)
-      unless comments.blank?
+      unless Utilities.blank?(comments)
         comments.each do |comment|
-          string = string.gsub("(#{comment})", '')
+          string = string.gsub("(#{comment})", Constants::EMPTY)
         end
       end
       string.strip
     end
 
     def strip_domain_comments(value)
-      unless comments.blank?
+      unless Utilities.blank?(comments)
         comments.each do |comment|
-          if get_domain && get_domain.include?("(#{comment})")
-            value = value.gsub("(#{comment})", '')
+          if @data.domain && @data.domain.include?("(#{comment})")
+            value = value.gsub("(#{comment})", Constants::EMPTY)
           end
         end
       end
       value.to_s.strip
     end
-    
-    def get_comments
-      if tree.respond_to?(:comments)
-        @comments = tree.comments.map { |c| unparen(c.text_value.to_str) } 
-      else
-        @comments = []
-      end
-    end
-    
+
     def get_display_name
-      if tree.respond_to?(:display_name)
-        name = unquote(tree.display_name.text_value.strip)
-        str = strip_all_comments(name.to_s)
-      elsif comments
-        if domain
-          str = strip_domain_comments(format_comments)
-        else
-          str = nil
-        end
-      else
-        nil
-      end
-      
-      if str.blank?
-        nil
-      else
-        str
+      if @data && @data.display_name
+        str = strip_all_comments(@data.display_name.to_s)
+      elsif @data && @data.comments && @data.domain
+        str = strip_domain_comments(format_comments)
       end
+      str unless Utilities.blank?(str)
     end
-    
+
     def get_name
       if display_name
         str = display_name
-      else
-        if comments
-          comment_text = comments.join(' ').squeeze(" ")
-          str = "(#{comment_text})"
-        end
+      elsif comments
+        str = "(#{comments.join(Constants::SPACE).squeeze(Constants::SPACE)})"
       end
 
-      if str.blank?
-        nil
-      else
-        unparen(str)
-      end
-    end
-    
-    # Provides access to the Treetop parse tree for this address
-    def tree
-      @tree
-    end
-    
-    def tree=(value)
-      @tree = value
+      Utilities.unparen(str) unless Utilities.blank?(str)
     end
-    
+
     def format_comments
       if comments
-        comment_text = comments.map {|c| escape_paren(c) }.join(' ').squeeze(" ")
+        comment_text = comments.map {|c| Utilities.escape_paren(c) }.join(Constants::SPACE).squeeze(Constants::SPACE)
         @format_comments ||= "(#{comment_text})"
       else
         nil
       end
     end
-   
-    def obs_domain_list
-      if tree.respond_to?(:angle_addr)
-        obs = tree.angle_addr.elements.select { |e| e.respond_to?(:obs_domain_list) }
-        !obs.empty? ? obs.first.text_value : nil
-      else
-        nil
-      end
-    end
-    
+
     def get_local
-      case
-      when tree.respond_to?(:local_dot_atom_text)
-        tree.local_dot_atom_text.text_value
-      when tree.respond_to?(:angle_addr) && tree.angle_addr.respond_to?(:addr_spec) && tree.angle_addr.addr_spec.respond_to?(:local_part)
-        tree.angle_addr.addr_spec.local_part.text_value
-      when tree.respond_to?(:addr_spec) && tree.addr_spec.respond_to?(:local_part)
-        tree.addr_spec.local_part.text_value
-      when tree.respond_to?(:angle_addr) && tree.angle_addr.respond_to?(:addr_spec) && tree.angle_addr.addr_spec.respond_to?(:local_dot_atom_text)
-        # Ignore local dot atom text when in angle brackets
-        nil
-      when tree.respond_to?(:addr_spec) && tree.addr_spec.respond_to?(:local_dot_atom_text)
-        # Ignore local dot atom text when in angle brackets
-        nil
-      else
-        tree && tree.respond_to?(:local_part) ? tree.local_part.text_value : nil
-      end
+      @data && @data.local
+    end
+
+    def get_domain
+      @data && @data.domain
+    end
+
+    def get_comments
+      @data && @data.comments
     end
-    
- 
   end
 end

data/lib/mail/elements/address_list.rb

@@ -1,74 +1,34 @@
 # encoding: utf-8
+# frozen_string_literal: true
+require 'mail/parsers/address_lists_parser'
+
 module Mail
-  class AddressList # :nodoc:
-    
+  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)
-      if string.blank?
-        @address_nodes = []
-        return self
-      end
-      parser = Mail::AddressListsParser.new
-      if tree = parser.parse(string)
-        @address_nodes = tree.addresses
-      else
-        raise Mail::Field::ParseError.new(AddressListsParser, string, parser.failure_reason)
-      end
+      address_list = Parsers::AddressListsParser.parse(string)
+      @addresses = address_list.addresses.map { |a| Address.new(a) }
+      @group_names = address_list.group_names
     end
-    
-    # Returns a list of address objects from the parsed line
-    def addresses
-      @addresses ||= get_addresses.map do |address_tree|
-        Mail::Address.new(address_tree)
-      end
-    end
-    
-    # Returns a list of all recipient syntax trees that are not part of a group
-    def individual_recipients # :nodoc:
-      @individual_recipients ||= @address_nodes - group_recipients
-    end
-    
-    # Returns a list of all recipient syntax trees that are part of a group
-    def group_recipients # :nodoc:
-      @group_recipients ||= @address_nodes.select { |an| an.respond_to?(:group_name) }
-    end
-    
-    # Returns the names as an array of strings of all groups
-    def group_names # :nodoc:
-      group_recipients.map { |g| g.group_name.text_value }
-    end
-    
-    # Returns a list of address syntax trees
-    def address_nodes # :nodoc:
-      @address_nodes
-    end
-    
-    private
-    
-    def get_addresses
-      (individual_recipients + group_recipients.map { |g| get_group_addresses(g) }).flatten
-    end
-    
-    def get_group_addresses(g)
-      if g.group_list.respond_to?(:addresses)
-        g.group_list.addresses
-      else
-        []
-      end
+
+    def addresses_grouped_by_group
+      addresses.select(&:group).group_by(&:group)
     end
   end
 end

data/lib/mail/elements/content_disposition_element.rb

@@ -1,30 +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 )
-      parser = Mail::ContentDispositionParser.new
-      if tree = parser.parse(cleaned(string))
-        @disposition_type = tree.disposition_type.text_value.downcase
-        @parameters = tree.parameters
-      else
-        raise Mail::Field::ParseError.new(ContentDispositionElement, string, parser.failure_reason)
-      end
+  class ContentDispositionElement #:nodoc:
+    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,25 +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 )
-      parser = Mail::ContentLocationParser.new
-      if tree = parser.parse(string)
-        @location = tree.location.text_value
-      else
-        raise Mail::Field::ParseError.new(ContentLocationElement, string, parser.failure_reason)
-      end
+  class ContentLocationElement #:nodoc:
+    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,24 +1,13 @@
 # encoding: utf-8
+# frozen_string_literal: true
+require 'mail/parsers/content_transfer_encoding_parser'
+
 module Mail
-  class ContentTransferEncodingElement
-    
-    include Mail::Utilities
-    
-    def initialize( string )
-      parser = Mail::ContentTransferEncodingParser.new
-      case
-      when string.blank?
-        @encoding = ''
-      when tree = parser.parse(string.to_s.downcase)
-        @encoding = tree.encoding.text_value
-      else
-        raise Mail::Field::ParseError.new(ContentTransferEncodingElement, string, parser.failure_reason)
-      end
+  class ContentTransferEncodingElement #:nodoc:
+    attr_reader :encoding
+
+    def initialize(string)
+      @encoding = Mail::Parsers::ContentTransferEncodingParser.parse(string).encoding
     end
-    
-    def encoding
-      @encoding
-    end
-    
   end
 end