mail 2.5.2 → 2.6.4

data/lib/mail/fields/return_path_field.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 # 
 # 4.4.3.  REPLY-TO / RESENT-REPLY-TO
 # 
@@ -41,7 +42,6 @@ module Mail
       value = nil if value == '<>'
       self.charset = charset
       super(CAPITALIZED_FIELD, strip_field(FIELD_NAME, value), charset)
-      self.parse
       self
     end
     

data/lib/mail/fields/sender_field.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 # 
 # = Sender Field
 # 
@@ -6,7 +7,7 @@
 # field in the email.
 # 
 # Sending sender to a mail message will instantiate a Mail::Field object that
-# has a SenderField as it's field type.  This includes all Mail::CommonAddress
+# has a SenderField as its field type.  This includes all Mail::CommonAddress
 # module instance metods.
 # 
 # Only one Sender field can appear in a header, though it can have multiple
@@ -15,16 +16,16 @@
 # == Examples:
 # 
 #  mail = Mail.new
-#  mail.sender = 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
-#  mail.sender    #=> ['Mikel Lindsaar <mikel@test.lindsaar.net>', 'ada@test.lindsaar.net']
+#  mail.sender = 'Mikel Lindsaar <mikel@test.lindsaar.net>'
+#  mail.sender    #=> 'mikel@test.lindsaar.net'
 #  mail[:sender]  #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::SenderField:0x180e1c4
 #  mail['sender'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::SenderField:0x180e1c4
 #  mail['Sender'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::SenderField:0x180e1c4
 # 
-#  mail[:sender].encoded   #=> 'Sender: Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net\r\n'
-#  mail[:sender].decoded   #=> 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
-#  mail[:sender].addresses #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
-#  mail[:sender].formatted #=> ['Mikel Lindsaar <mikel@test.lindsaar.net>', 'ada@test.lindsaar.net']
+#  mail[:sender].encoded   #=> "Sender: Mikel Lindsaar <mikel@test.lindsaar.net>\r\n"
+#  mail[:sender].decoded   #=> 'Mikel Lindsaar <mikel@test.lindsaar.net>'
+#  mail[:sender].addresses #=> ['mikel@test.lindsaar.net']
+#  mail[:sender].formatted #=> ['Mikel Lindsaar <mikel@test.lindsaar.net>']
 # 
 require 'mail/fields/common/common_address'
 
@@ -39,7 +40,6 @@ module Mail
     def initialize(value = nil, charset = 'utf-8')
       self.charset = charset
       super(CAPITALIZED_FIELD, strip_field(FIELD_NAME, value), charset)
-      self.parse
       self
     end
 
@@ -48,7 +48,7 @@ module Mail
     end
 
     def address
-      tree.addresses.first
+      address_list.addresses.first
     end
     
     def encoded

data/lib/mail/fields/structured_field.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 require 'mail/fields/common/common_field'
 
 module Mail

data/lib/mail/fields/subject_field.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 # 
 # subject         =       "Subject:" unstructured CRLF
 module Mail

data/lib/mail/fields/to_field.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 # 
 # = To Field
 # 
@@ -6,7 +7,7 @@
 # field in the email.
 # 
 # Sending to to a mail message will instantiate a Mail::Field object that
-# has a ToField as it's field type.  This includes all Mail::CommonAddress
+# has a ToField as its field type.  This includes all Mail::CommonAddress
 # module instance metods.
 # 
 # Only one To field can appear in a header, though it can have multiple
@@ -16,7 +17,7 @@
 # 
 #  mail = Mail.new
 #  mail.to = 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
-#  mail.to    #=> ['Mikel Lindsaar <mikel@test.lindsaar.net>', 'ada@test.lindsaar.net']
+#  mail.to    #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
 #  mail[:to]  #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ToField:0x180e1c4
 #  mail['to'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ToField:0x180e1c4
 #  mail['To'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ToField:0x180e1c4
@@ -39,7 +40,6 @@ module Mail
     def initialize(value = nil, charset = 'utf-8')
       self.charset = charset
       super(CAPITALIZED_FIELD, strip_field(FIELD_NAME, value), charset)
-      self.parse
       self
     end
     

data/lib/mail/fields/unstructured_field.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 require 'mail/fields/common/common_field'
 
 module Mail
@@ -70,7 +71,7 @@ module Mail
     end
 
     def do_decode
-      value.blank? ? nil : Encodings.decode_encode(value, :decode)
+      Utilities.blank?(value) ? nil : Encodings.decode_encode(value, :decode)
     end
 
     # 2.2.3. Long Header Fields
@@ -127,7 +128,7 @@ module Mail
           if first
             first = !first
           else
-            word = " " << word
+            word = " #{word}"
           end
           if word.not_ascii_only?
             word
@@ -143,10 +144,11 @@ module Mail
       while !words.empty?
         limit = 78 - prepend
         limit = limit - 7 - encoding.length if should_encode
-        line = ""
+        line = String.new
+        first_word = true
         while !words.empty?
           break unless word = words.first.dup
-          word.encode!(charset) if defined?(Encoding) && charset
+          word.encode!(charset) if charset && word.respond_to?(:encode!)
           word = encode(word) if should_encode
           word = encode_crlf(word)
           # Skip to next line if we're going to go past the limit
@@ -158,7 +160,12 @@ module Mail
           # Remove the word from the queue ...
           words.shift
           # Add word separator
-          line << " " unless (line.empty? || should_encode)
+          if first_word
+            first_word = false
+          else
+            line << " " if !should_encode
+          end
+
           # ... add it in encoded form to the current line
           line << word
         end
@@ -172,7 +179,7 @@ module Mail
     end
 
     def encode(value)
-      value = [value].pack("M").gsub("=\n", '')
+      value = [value].pack(CAPITAL_M).gsub(EQUAL_LF, EMPTY)
       value.gsub!(/"/,  '=22')
       value.gsub!(/\(/, '=28')
       value.gsub!(/\)/, '=29')
@@ -183,8 +190,8 @@ module Mail
     end
 
     def encode_crlf(value)
-      value.gsub!("\r", '=0D')
-      value.gsub!("\n", '=0A')
+      value.gsub!(CR, CR_ENCODED)
+      value.gsub!(LF, LF_ENCODED)
       value
     end
 

data/lib/mail/fields.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Mail
   register_autoload :UnstructuredField, 'mail/fields/unstructured_field'
   register_autoload :StructuredField, 'mail/fields/structured_field'

data/lib/mail/header.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 module Mail
   
   # Provides access to a header object.
@@ -17,7 +18,7 @@ module Mail
   #   2.2.3.  All field bodies MUST conform to the syntax described in
   #   sections 3 and 4 of this standard.
   class Header
-    include Patterns
+    include Constants
     include Utilities
     include Enumerable
     
@@ -48,11 +49,15 @@ module Mail
     # these cases, please make a patch and send it in, or at the least, send
     # me the example so we can fix it.
     def initialize(header_text = nil, charset = nil)
-      @errors = []
       @charset = charset
-      self.raw_source = header_text.to_crlf
+      self.raw_source = ::Mail::Utilities.to_crlf(header_text).lstrip
       split_header if header_text
     end
+
+    def initialize_copy(original)
+      super
+      @fields = @fields.dup
+    end
     
     # The preserved raw source of the header as you passed it in, untouched
     # for your Regexing glory.
@@ -91,7 +96,6 @@ module Mail
       unfolded_fields[0..(self.class.maximum_amount-1)].each do |field|
 
         field = Field.new(field, nil, charset)
-        field.errors.each { |error| self.errors << error }
         if limited_field?(field.name) && (selected = select_field_for(field.name)) && selected.any? 
           selected.first.update(field.name, field.value)
         else
@@ -102,7 +106,7 @@ module Mail
     end
     
     def errors
-      @errors
+      @fields.map(&:errors).flatten(1)
     end
     
     #  3.6. Field definitions
@@ -127,12 +131,13 @@ module Mail
     #  h['To']          #=> 'mikel@me.com'
     #  h['X-Mail-SPAM'] #=> ['15', '20']
     def [](name)
-      name = dasherize(name).downcase
+      name = dasherize(name)
+      name.downcase!
       selected = select_field_for(name)
       case
       when selected.length > 1
         selected.map { |f| f }
-      when !selected.blank?
+      when !Utilities.blank?(selected)
         selected.first
       else
         nil
@@ -154,16 +159,19 @@ module Mail
     #  h['X-Mail-SPAM'] # => nil
     def []=(name, value)
       name = dasherize(name)
+      if name.include?(':')
+        raise ArgumentError, "Header names may not contain a colon: #{name.inspect}"
+      end
       fn = name.downcase
       selected = select_field_for(fn)
       
       case
       # User wants to delete the field
-      when !selected.blank? && value == nil
+      when !Utilities.blank?(selected) && value == nil
         fields.delete_if { |f| selected.include?(f) }
         
       # User wants to change the field
-      when !selected.blank? && limited_field?(fn)
+      when !Utilities.blank?(selected) && limited_field?(fn)
         selected.first.update(fn, value)
         
       # User wants to create the field
@@ -174,7 +182,7 @@ module Mail
       if dasherize(fn) == "content-type"
         # Update charset if specified in Content-Type
         params = self[:content_type].parameters rescue nil
-        @charset = params && params[:charset]
+        @charset = params[:charset] if params && params[:charset]
       end
     end
     
@@ -197,7 +205,8 @@ module Mail
                            content-id content-disposition content-location]
 
     def encoded
-      buffer = ''
+      buffer = String.new
+      buffer.force_encoding('us-ascii') if buffer.respond_to?(:force_encoding)
       fields.each do |field|
         buffer << field.encoded
       end
@@ -242,27 +251,10 @@ module Mail
       @raw_source = val
     end
     
-    # 2.2.3. Long Header Fields
-    # 
-    #  The process of moving from this folded multiple-line representation
-    #  of a header field to its single line representation is called
-    #  "unfolding". Unfolding is accomplished by simply removing any CRLF
-    #  that is immediately followed by WSP.  Each header field should be
-    #  treated in its unfolded form for further syntactic and semantic
-    #  evaluation.
-    def unfold(string)
-      string.gsub(/#{CRLF}#{WSP}+/, ' ').gsub(/#{WSP}+/, ' ')
-    end
-    
-    # Returns the header with all the folds removed
-    def unfolded_header
-      @unfolded_header ||= unfold(raw_source)
-    end
-    
     # Splits an unfolded and line break cleaned header into individual field
     # strings.
     def split_header
-      self.fields = unfolded_header.split(CRLF)
+      self.fields = raw_source.split(HEADER_SPLIT)
     end
     
     def select_field_for(name)

data/lib/mail/indifferent_hash.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 # This is an almost cut and paste from ActiveSupport v3.0.6, copied in here so that Mail
 # itself does not depend on ActiveSupport to avoid versioning conflicts

data/lib/mail/mail.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 module Mail
 
   # Allows you to create a new Mail::Message object.
@@ -206,6 +207,12 @@ module Mail
     end
   end
 
+  # Unregister the given observer, allowing mail to resume operations
+  # without it.
+  def self.unregister_observer(observer)
+    @@delivery_notification_observers.delete(observer)
+  end
+
   # You can register an object to be given every mail object that will be sent,
   # before it is sent.  So if you want to add special headers or modify any
   # email that gets sent through the Mail library, you can do so.
@@ -219,6 +226,12 @@ module Mail
     end
   end
 
+  # Unregister the given interceptor, allowing mail to resume operations
+  # without it.
+  def self.unregister_interceptor(interceptor)
+    @@delivery_interceptors.delete(interceptor)
+  end
+
   def self.inform_observers(mail)
     @@delivery_notification_observers.each do |observer|
       observer.delivered_email(mail)
@@ -233,9 +246,11 @@ module Mail
 
   protected
 
+  RANDOM_TAG='%x%x_%x%x%d%x'
+
   def self.random_tag
     t = Time.now
-    sprintf('%x%x_%x%x%d%x',
+    sprintf(RANDOM_TAG,
             t.to_i, t.tv_usec,
             $$, Thread.current.object_id.abs, self.uniq, rand(255))
   end

data/lib/mail/matchers/attachment_matchers.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+module Mail
+  module Matchers
+    def any_attachment
+      AnyAttachmentMatcher.new
+    end
+
+    def an_attachment_with_filename(filename)
+      AttachmentFilenameMatcher.new(filename)
+    end
+
+    class AnyAttachmentMatcher
+      def ===(other)
+        other.attachment?
+      end
+    end
+
+    class AttachmentFilenameMatcher
+      attr_reader :filename
+      def initialize(filename)
+        @filename = filename
+      end
+
+      def ===(other)
+        other.attachment? && other.filename == filename
+      end
+    end
+  end
+end

data/lib/mail/matchers/has_sent_mail.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Mail
   module Matchers
     def have_sent_email
@@ -29,6 +30,39 @@ module Mail
         self
       end
 
+      def cc(recipient_or_list)
+        @copy_recipients ||= []
+
+        if recipient_or_list.kind_of?(Array)
+          @copy_recipients += recipient_or_list
+        else
+          @copy_recipients << recipient_or_list
+        end
+        self
+      end
+
+      def bcc(recipient_or_list)
+        @blind_copy_recipients ||= []
+        @blind_copy_recipients.concat(Array(recipient_or_list))
+        self
+      end
+
+      def with_attachments(attachments)
+        @attachments ||= []
+        @attachments.concat(Array(attachments))
+        self
+      end
+
+      def with_no_attachments
+        @having_attachments = false
+        self
+      end
+
+      def with_any_attachments
+        @having_attachments = true
+        self
+      end
+
       def with_subject(subject)
         @subject = subject
         self
@@ -61,7 +95,7 @@ module Mail
         result
       end
 
-      def negative_failure_message
+      def failure_message_when_negated
         result = "Expected no email to be sent "
         result += explain_expectations
         result += dump_deliveries
@@ -69,11 +103,13 @@ module Mail
       end
 
       protected
-      
+
       def filter_matched_deliveries(deliveries)
         candidate_deliveries = deliveries
-
-        %w(sender recipients subject subject_matcher body body_matcher).each do |modifier_name|
+        modifiers =
+          %w(sender recipients copy_recipients blind_copy_recipients subject
+          subject_matcher body body_matcher having_attachments attachments)
+        modifiers.each do |modifier_name|
           next unless instance_variable_defined?("@#{modifier_name}")
           candidate_deliveries = candidate_deliveries.select{|matching_delivery| self.send("matches_on_#{modifier_name}?", matching_delivery)}
         end
@@ -89,6 +125,14 @@ module Mail
         @recipients.all? {|recipient| delivery.to.include?(recipient) }
       end
 
+      def matches_on_copy_recipients?(delivery)
+        @copy_recipients.all? {|recipient| delivery.cc.include?(recipient) }
+      end
+
+      def matches_on_blind_copy_recipients?(delivery)
+        @blind_copy_recipients.all? {|recipient| delivery.bcc.include?(recipient) }
+      end
+
       def matches_on_subject?(delivery)
         delivery.subject == @subject
       end
@@ -97,6 +141,17 @@ module Mail
         @subject_matcher.match delivery.subject
       end
 
+      def matches_on_having_attachments?(delivery)
+        @having_attachments && delivery.attachments.any? ||
+          (!@having_attachments && delivery.attachments.none?)
+      end
+
+      def matches_on_attachments?(delivery)
+        @attachments.each_with_index.inject( true ) do |sent_attachments, (attachment, index)|
+          sent_attachments &&= (attachment === delivery.attachments[index])
+        end
+      end
+
       def matches_on_body?(delivery)
         delivery.body == @body
       end
@@ -109,6 +164,8 @@ module Mail
         result = ''
         result += "from #{@sender} " if instance_variable_defined?('@sender')
         result += "to #{@recipients.inspect} " if instance_variable_defined?('@recipients')
+        result += "cc #{@copy_recipients.inspect} " if instance_variable_defined?('@copy_recipients')
+        result += "bcc #{@blind_copy_recipients.inspect} " if instance_variable_defined?('@blind_copy_recipients')
         result += "with subject \"#{@subject}\" " if instance_variable_defined?('@subject')
         result += "with subject matching \"#{@subject_matcher}\" " if instance_variable_defined?('@subject_matcher')
         result += "with body \"#{@body}\" " if instance_variable_defined?('@body')