mail 2.5.2 → 2.6.4

data/lib/mail/check_delivery_params.rb

@@ -1,30 +1,21 @@
+# frozen_string_literal: true
 module Mail
-
   module CheckDeliveryParams
+    def check_delivery_params(mail)
+      if Utilities.blank?(mail.smtp_envelope_from)
+        raise ArgumentError.new('An SMTP From address is required to send a message. Set the message smtp_envelope_from, return_path, sender, or from address.')
+      end
 
-    def self.included(klass)
-      klass.class_eval do
-
-        def check_params(mail)
-          envelope_from = mail.return_path || mail.sender || mail.from_addrs.first
-          if envelope_from.blank?
-            raise ArgumentError.new('A sender (Return-Path, Sender or From) required to send a message')
-          end
-
-          destinations ||= mail.destinations if mail.respond_to?(:destinations) && mail.destinations
-          if destinations.blank?
-            raise ArgumentError.new('At least one recipient (To, Cc or Bcc) is required to send a message')
-          end
-
-          message ||= mail.encoded if mail.respond_to?(:encoded)
-          if message.blank?
-            raise ArgumentError.new('A encoded content is required to send a message')
-          end
-
-          [envelope_from, destinations, message]
-        end
+      if Utilities.blank?(mail.smtp_envelope_to)
+        raise ArgumentError.new('An SMTP To address is required to send a message. Set the message smtp_envelope_to, to, cc, or bcc address.')
+      end
 
+      message = mail.encoded if mail.respond_to?(:encoded)
+      if Utilities.blank?(message)
+        raise ArgumentError.new('An encoded message is required to send an email')
       end
+
+      [mail.smtp_envelope_from, mail.smtp_envelope_to, message]
     end
   end
 end

data/lib/mail/configuration.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 #
 # Thanks to Nicolas Fouché for this wrapper
 #

data/lib/mail/{patterns.rb → constants.rb}

@@ -1,28 +1,32 @@
 # encoding: us-ascii
+# frozen_string_literal: true
 module Mail
-  module Patterns
+  module Constants
     white_space = %Q|\x9\x20|
     text        = %Q|\x1-\x8\xB\xC\xE-\x7f|
     field_name  = %Q|\x21-\x39\x3b-\x7e|
     qp_safe     = %Q|\x20-\x3c\x3e-\x7e|
-    
+
     aspecial     = %Q|()<>[]:;@\\,."| # RFC5322
     tspecial     = %Q|()<>@,;:\\"/[]?=| # RFC2045
     sp           = %Q| |
     control      = %Q|\x00-\x1f\x7f-\xff|
-    
+
     if control.respond_to?(:force_encoding)
-      control = control.force_encoding(Encoding::BINARY)
+      control = control.dup.force_encoding(Encoding::BINARY)
     end
-    
+
     CRLF          = /\r\n/
     WSP           = /[#{white_space}]/
     FWS           = /#{CRLF}#{WSP}*/
     TEXT          = /[#{text}]/ # + obs-text
     FIELD_NAME    = /[#{field_name}]+/
-    FIELD_BODY    = /.+/
+    FIELD_PREFIX  = /\A(#{FIELD_NAME})/
+    FIELD_BODY    = /.+/m
     FIELD_LINE    = /^[#{field_name}]+:\s*.+$/
+    FIELD_SPLIT   = /^(#{FIELD_NAME})\s*:\s*(#{FIELD_BODY})?$/
     HEADER_LINE   = /^([#{field_name}]+:\s*.+)$/
+    HEADER_SPLIT  = /#{CRLF}(?!#{WSP})/
 
     QP_UNSAFE     = /[^#{qp_safe}]/
     QP_SAFE       = /[#{qp_safe}]/
@@ -30,5 +34,24 @@ module Mail
     ATOM_UNSAFE   = /[#{Regexp.quote aspecial}#{control}#{sp}]/n
     PHRASE_UNSAFE = /[#{Regexp.quote aspecial}#{control}]/n
     TOKEN_UNSAFE  = /[#{Regexp.quote tspecial}#{control}#{sp}]/n
+    ENCODED_VALUE = /\=\?([^?]+)\?([QB])\?[^?]*?\?\=/mi
+    FULL_ENCODED_VALUE = /(\=\?[^?]+\?[QB]\?[^?]*?\?\=)/mi
+
+    EMPTY          = ''
+    SPACE          = ' '
+    UNDERSCORE     = '_'
+    HYPHEN         = '-'
+    COLON          = ':'
+    ASTERISK       = '*'
+    CR             = "\r"
+    LF             = "\n"
+    CR_ENCODED     = "=0D"
+    LF_ENCODED     = "=0A"
+    CAPITAL_M      = 'M'
+    EQUAL_LF       = "=\n"
+    NULL_SENDER    = '<>'
+
+    Q_VALUES       = ['Q','q']
+    B_VALUES       = ['B','b']
   end
 end

data/lib/mail/core_extensions/smtp.rb

@@ -1,25 +1,25 @@
 # encoding: utf-8
+# frozen_string_literal: true
 module Net
   class SMTP
     # This is a backport of r30294 from ruby trunk because of a bug in net/smtp.
     # http://svn.ruby-lang.org/cgi-bin/viewvc.cgi?view=rev&revision=30294
     #
     # Fixed in what will be Ruby 1.9.3 - tlsconnect also does not exist in some early versions of ruby
-    remove_method :tlsconnect if defined?(Net::SMTP.new.tlsconnect)
+    begin
+      alias_method :original_tlsconnect, :tlsconnect
 
-    def tlsconnect(s)
-      verified = false
-      s = OpenSSL::SSL::SSLSocket.new s, @ssl_context
-      logging "TLS connection started"
-      s.sync_close = true
-      s.connect
-      if @ssl_context.verify_mode != OpenSSL::SSL::VERIFY_NONE
-        s.post_connection_check(@address)
+      def tlsconnect(s)
+        verified = false
+        begin
+          original_tlsconnect(s).tap { verified = true }
+        ensure
+          unless verified
+            s.close rescue nil
+          end
+        end
       end
-      verified = true
-      s
-    ensure
-      s.close unless verified
+    rescue NameError
     end
   end
 end

data/lib/mail/core_extensions/string/access.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 # This is not loaded if ActiveSupport is already loaded
 

data/lib/mail/core_extensions/string/multibyte.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 # This is not loaded if ActiveSupport is already loaded
 

data/lib/mail/core_extensions/string.rb

@@ -1,26 +1,14 @@
 # encoding: utf-8
+# frozen_string_literal: true
 class String #:nodoc:
-  def to_crlf
-    to_str.gsub(/\n|\r\n|\r/) { "\r\n" }
-  end
-
-  def to_lf
-    to_str.gsub(/\n|\r\n|\r/) { "\n" }
-  end
-
-  unless String.instance_methods(false).map {|m| m.to_sym}.include?(:blank?)
-    def blank?
-      self !~ /\S/
-    end
-  end
 
   unless method_defined?(:ascii_only?)
-    # Provides all strings with the Ruby 1.9 method of .ascii_only? and
-    # returns true or false
-    US_ASCII_REGEXP = %Q{\x00-\x7f}
+    # Backport from Ruby 1.9 checks for non-us-ascii characters.
     def ascii_only?
-      !(self =~ /[^#{US_ASCII_REGEXP}]/)
+      self !~ MATCH_NON_US_ASCII
     end
+
+    MATCH_NON_US_ASCII = /[^\x00-\x7f]/
   end
 
   def not_ascii_only?

data/lib/mail/elements/address.rb

@@ -1,17 +1,18 @@
 # encoding: utf-8
+# frozen_string_literal: true
 module Mail
   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 it's component parts and allowing you to get the
+    # 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'
@@ -21,26 +22,23 @@ 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 = nil
-      @tree = nil
-      @raw_text = value
-      case
-      when value.nil?
+      @output_type = :decode
+      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
-    # an incorrectly formatted address as input, Mail::Address will do it's best
+    # an incorrectly formatted address as input, Mail::Address will do its best
     # to format it correctly.  This includes quoting display names as needed and
     # putting the address in angle brackets etc.
     #
@@ -48,37 +46,38 @@ module Mail
     #  a.format #=> 'Mikel Lindsaar <mikel@test.lindsaar.net> (My email address)'
     def format
       parse unless @parsed
-      case
-      when tree.nil?
-        ''
-      when display_name
-        [quote_phrase(display_name), "<#{address}>", format_comments].compact.join(" ")
+      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)
       else
-        [address, format_comments].compact.join(" ")
+        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
       parse unless @parsed
       domain ? "#{local}@#{domain}" : local
     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
@@ -86,70 +85,66 @@ module Mail
       @display_name ||= get_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.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
       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
       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
     # are no comments
-    # 
+    #
     #  a = Address.new('Mikel Lindsaar (My email address) <mikel@test.lindsaar.net>')
     #  a.comments #=> ['My email address']
     def comments
       parse unless @parsed
-      if get_comments.empty?
-        nil
-      else
-        get_comments.map { |c| c.squeeze(" ") }
-      end
+      get_comments.map { |c| c.squeeze(SPACE) } unless get_comments.empty?
     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)| >"
@@ -157,150 +152,96 @@ module Mail
       parse unless @parsed
       "#<#{self.class}:#{self.object_id} Address: |#{to_s}| >"
     end
-    
+
     def encoded
       @output_type = :encode
       format
     end
-    
+
     def decoded
       @output_type = :decode
       format
     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::AddressStruct
+        @data = value
+      when String
+        unless Utilities.blank?(value)
+          address_list = Mail::Parsers::AddressListsParser.new.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})", 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})", 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.display_name
+        str = strip_all_comments(@data.display_name.to_s)
+      elsif @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(SPACE).squeeze(SPACE)})"
       end
 
-      if str.blank?
-        nil
-      else
-        unparen(str)
-      end
-    end
-    
-    # Provides access to the Treetop parse tree for this address
-    def tree
-      @tree
+      unparen(str) unless Utilities.blank?(str)
     end
-    
-    def tree=(value)
-      @tree = value
-    end
-    
+
     def format_comments
       if comments
-        comment_text = comments.map {|c| escape_paren(c) }.join(' ').squeeze(" ")
+        comment_text = comments.map {|c| escape_paren(c) }.join(SPACE).squeeze(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
-      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
+end

data/lib/mail/elements/address_list.rb

@@ -1,7 +1,8 @@
 # encoding: utf-8
+# frozen_string_literal: true
 module Mail
   class AddressList # :nodoc:
-    
+
     # Mail::AddressList is the class that parses To, From and other address fields from
     # emails passed into Mail.
     # 
@@ -18,57 +19,24 @@ module Mail
     #  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
+      @addresses_grouped_by_group = nil
+      @address_list = Parsers::AddressListsParser.new.parse(string)
     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)
+      @addresses ||= @address_list.addresses.map do |address_data|
+        Mail::Address.new(address_data)
       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) }
+
+    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:
-      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
+      @address_list.group_names
     end
   end
 end