mail 2.4.4 → 2.5.5

data/lib/mail/fields.rb

@@ -1,35 +1,35 @@
 module Mail
-  autoload :UnstructuredField, 'mail/fields/unstructured_field'
-  autoload :StructuredField, 'mail/fields/structured_field'
-  autoload :OptionalField, 'mail/fields/optional_field'
+  register_autoload :UnstructuredField, 'mail/fields/unstructured_field'
+  register_autoload :StructuredField, 'mail/fields/structured_field'
+  register_autoload :OptionalField, 'mail/fields/optional_field'
 
-  autoload :BccField, 'mail/fields/bcc_field'
-  autoload :CcField, 'mail/fields/cc_field'
-  autoload :CommentsField, 'mail/fields/comments_field'
-  autoload :ContentDescriptionField, 'mail/fields/content_description_field'
-  autoload :ContentDispositionField, 'mail/fields/content_disposition_field'
-  autoload :ContentIdField, 'mail/fields/content_id_field'
-  autoload :ContentLocationField, 'mail/fields/content_location_field'
-  autoload :ContentTransferEncodingField, 'mail/fields/content_transfer_encoding_field'
-  autoload :ContentTypeField, 'mail/fields/content_type_field'
-  autoload :DateField, 'mail/fields/date_field'
-  autoload :FromField, 'mail/fields/from_field'
-  autoload :InReplyToField, 'mail/fields/in_reply_to_field'
-  autoload :KeywordsField, 'mail/fields/keywords_field'
-  autoload :MessageIdField, 'mail/fields/message_id_field'
-  autoload :MimeVersionField, 'mail/fields/mime_version_field'
-  autoload :ReceivedField, 'mail/fields/received_field'
-  autoload :ReferencesField, 'mail/fields/references_field'
-  autoload :ReplyToField, 'mail/fields/reply_to_field'
-  autoload :ResentBccField, 'mail/fields/resent_bcc_field'
-  autoload :ResentCcField, 'mail/fields/resent_cc_field'
-  autoload :ResentDateField, 'mail/fields/resent_date_field'
-  autoload :ResentFromField, 'mail/fields/resent_from_field'
-  autoload :ResentMessageIdField, 'mail/fields/resent_message_id_field'
-  autoload :ResentSenderField, 'mail/fields/resent_sender_field'
-  autoload :ResentToField, 'mail/fields/resent_to_field'
-  autoload :ReturnPathField, 'mail/fields/return_path_field'
-  autoload :SenderField, 'mail/fields/sender_field'
-  autoload :SubjectField, 'mail/fields/subject_field'
-  autoload :ToField, 'mail/fields/to_field'
+  register_autoload :BccField, 'mail/fields/bcc_field'
+  register_autoload :CcField, 'mail/fields/cc_field'
+  register_autoload :CommentsField, 'mail/fields/comments_field'
+  register_autoload :ContentDescriptionField, 'mail/fields/content_description_field'
+  register_autoload :ContentDispositionField, 'mail/fields/content_disposition_field'
+  register_autoload :ContentIdField, 'mail/fields/content_id_field'
+  register_autoload :ContentLocationField, 'mail/fields/content_location_field'
+  register_autoload :ContentTransferEncodingField, 'mail/fields/content_transfer_encoding_field'
+  register_autoload :ContentTypeField, 'mail/fields/content_type_field'
+  register_autoload :DateField, 'mail/fields/date_field'
+  register_autoload :FromField, 'mail/fields/from_field'
+  register_autoload :InReplyToField, 'mail/fields/in_reply_to_field'
+  register_autoload :KeywordsField, 'mail/fields/keywords_field'
+  register_autoload :MessageIdField, 'mail/fields/message_id_field'
+  register_autoload :MimeVersionField, 'mail/fields/mime_version_field'
+  register_autoload :ReceivedField, 'mail/fields/received_field'
+  register_autoload :ReferencesField, 'mail/fields/references_field'
+  register_autoload :ReplyToField, 'mail/fields/reply_to_field'
+  register_autoload :ResentBccField, 'mail/fields/resent_bcc_field'
+  register_autoload :ResentCcField, 'mail/fields/resent_cc_field'
+  register_autoload :ResentDateField, 'mail/fields/resent_date_field'
+  register_autoload :ResentFromField, 'mail/fields/resent_from_field'
+  register_autoload :ResentMessageIdField, 'mail/fields/resent_message_id_field'
+  register_autoload :ResentSenderField, 'mail/fields/resent_sender_field'
+  register_autoload :ResentToField, 'mail/fields/resent_to_field'
+  register_autoload :ReturnPathField, 'mail/fields/return_path_field'
+  register_autoload :SenderField, 'mail/fields/sender_field'
+  register_autoload :SubjectField, 'mail/fields/subject_field'
+  register_autoload :ToField, 'mail/fields/to_field'
 end

data/lib/mail/header.rb

@@ -21,6 +21,20 @@ module Mail
     include Utilities
     include Enumerable
     
+    @@maximum_amount = 1000
+
+    # Large amount of headers in Email might create extra high CPU load
+    # Use this parameter to limit number of headers that will be parsed by 
+    # mail library.
+    # Default: 1000
+    def self.maximum_amount
+      @@maximum_amount
+    end
+
+    def self.maximum_amount=(value)
+      @@maximum_amount = value
+    end
+
     # Creates a new header object.
     # 
     # Accepts raw text or nothing.  If given raw text will attempt to parse
@@ -36,7 +50,7 @@ module Mail
     def initialize(header_text = nil, charset = nil)
       @errors = []
       @charset = charset
-      self.raw_source = header_text.to_crlf
+      self.raw_source = header_text.to_crlf.lstrip
       split_header if header_text
     end
     
@@ -73,14 +87,12 @@ module Mail
     #  h.fields = ['From: mikel@me.com', 'To: bob@you.com']
     def fields=(unfolded_fields)
       @fields = Mail::FieldList.new
-      warn "Warning: more than 1000 header fields only using the first 1000" if unfolded_fields.length > 1000
-      unfolded_fields[0..1000].each do |field|
+      warn "Warning: more than #{self.class.maximum_amount} header fields only using the first #{self.class.maximum_amount}" if unfolded_fields.length > self.class.maximum_amount
+      unfolded_fields[0..(self.class.maximum_amount-1)].each do |field|
 
         field = Field.new(field, nil, charset)
         field.errors.each { |error| self.errors << error }
-        selected = select_field_for(field.name)
-
-        if selected.any? && limited_field?(field.name)
+        if limited_field?(field.name) && (selected = select_field_for(field.name)) && selected.any? 
           selected.first.update(field.name, field.value)
         else
           @fields << field
@@ -142,6 +154,9 @@ 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)
       
@@ -159,15 +174,15 @@ module Mail
         # Need to insert in correct order for trace fields
         self.fields << Field.new(name.to_s, value, charset)
       end
+      if dasherize(fn) == "content-type"
+        # Update charset if specified in Content-Type
+        params = self[:content_type].parameters rescue nil
+        @charset = params && params[:charset]
+      end
     end
     
     def charset
-      params = self[:content_type].parameters rescue nil
-      if params
-        params[:charset]
-      else
-        @charset
-      end
+      @charset
     end
     
     def charset=(val)
@@ -186,6 +201,7 @@ module Mail
 
     def encoded
       buffer = ''
+      buffer.force_encoding('us-ascii') if buffer.respond_to?(:force_encoding)
       fields.each do |field|
         buffer << field.encoded
       end
@@ -254,12 +270,19 @@ module Mail
     end
     
     def select_field_for(name)
-      fields.select { |f| f.responsible_for?(name.to_s) }
+      fields.select { |f| f.responsible_for?(name) }
     end
     
     def limited_field?(name)
       LIMITED_FIELDS.include?(name.to_s.downcase)
     end
-    
+
+    # Enumerable support; yield each field in order to the block if there is one,
+    # or return an Enumerator for them if there isn't.
+    def each( &block )
+      return self.fields.each( &block ) if block
+      self.fields.each
+    end
+
   end
 end

data/lib/mail/message.rb

@@ -108,6 +108,9 @@ module Mail
       @charset = 'UTF-8'
       @defaulted_charset = true
 
+      @smtp_envelope_from = nil
+      @smtp_envelope_to = nil
+
       @perform_deliveries = true
       @raise_delivery_errors = true
 
@@ -122,7 +125,7 @@ module Mail
       if args.flatten.first.respond_to?(:each_pair)
         init_with_hash(args.flatten.first)
       else
-        init_with_string(args.flatten[0].to_s.strip)
+        init_with_string(args.flatten[0].to_s)
       end
 
       if block_given?
@@ -169,7 +172,7 @@ module Mail
     #   obj.mail.deliver
     #
     # Would cause Mail to call obj.deliver_mail passing itself as a parameter,
-    # which then can just yield and let Mail do it's own private do_delivery
+    # which then can just yield and let Mail do its own private do_delivery
     # method.
     attr_accessor :delivery_handler
 
@@ -938,8 +941,8 @@ module Mail
     #
     # Example:
     #
-    #  mail.sender = 'Mikel <mikel@test.lindsaar.net>'
-    #  mail.sender #=> 'mikel@test.lindsaar.net'
+    #  mail.resent_sender = 'Mikel <mikel@test.lindsaar.net>'
+    #  mail.resent_sender #=> 'mikel@test.lindsaar.net'
     def resent_sender=( val )
       header[:resent_sender] = val
     end
@@ -1023,6 +1026,82 @@ module Mail
       header[:sender] = val
     end
 
+    # Returns the SMTP Envelope From value of the mail object, as a single
+    # string of an address spec.
+    #
+    # Defaults to Return-Path, Sender, or the first From address.
+    #
+    # Example:
+    #
+    #  mail.smtp_envelope_from = 'Mikel <mikel@test.lindsaar.net>'
+    #  mail.smtp_envelope_from #=> 'mikel@test.lindsaar.net'
+    #
+    # Also allows you to set the value by passing a value as a parameter
+    #
+    # Example:
+    #
+    #  mail.smtp_envelope_from 'Mikel <mikel@test.lindsaar.net>'
+    #  mail.smtp_envelope_from #=> 'mikel@test.lindsaar.net'
+    def smtp_envelope_from( val = nil )
+      if val
+        self.smtp_envelope_from = val
+      else
+        @smtp_envelope_from || return_path || sender || from_addrs.first
+      end
+    end
+
+    # Sets the From address on the SMTP Envelope.
+    #
+    # Example:
+    #
+    #  mail.smtp_envelope_from = 'Mikel <mikel@test.lindsaar.net>'
+    #  mail.smtp_envelope_from #=> 'mikel@test.lindsaar.net'
+    def smtp_envelope_from=( val )
+      @smtp_envelope_from = val
+    end
+
+    # Returns the SMTP Envelope To value of the mail object.
+    #
+    # Defaults to #destinations: To, Cc, and Bcc addresses.
+    #
+    # Example:
+    #
+    #  mail.smtp_envelope_to = 'Mikel <mikel@test.lindsaar.net>'
+    #  mail.smtp_envelope_to #=> 'mikel@test.lindsaar.net'
+    #
+    # Also allows you to set the value by passing a value as a parameter
+    #
+    # Example:
+    #
+    #  mail.smtp_envelope_to ['Mikel <mikel@test.lindsaar.net>', 'Lindsaar <lindsaar@test.lindsaar.net>']
+    #  mail.smtp_envelope_to #=> ['mikel@test.lindsaar.net', 'lindsaar@test.lindsaar.net']
+    def smtp_envelope_to( val = nil )
+      if val
+        self.smtp_envelope_to = val
+      else
+        @smtp_envelope_to || destinations
+      end
+    end
+
+    # Sets the To addresses on the SMTP Envelope.
+    #
+    # Example:
+    #
+    #  mail.smtp_envelope_to = 'Mikel <mikel@test.lindsaar.net>'
+    #  mail.smtp_envelope_to #=> 'mikel@test.lindsaar.net'
+    #
+    #  mail.smtp_envelope_to = ['Mikel <mikel@test.lindsaar.net>', 'Lindsaar <lindsaar@test.lindsaar.net>']
+    #  mail.smtp_envelope_to #=> ['mikel@test.lindsaar.net', 'lindsaar@test.lindsaar.net']
+    def smtp_envelope_to=( val )
+      @smtp_envelope_to =
+        case val
+        when Array, NilClass
+          val
+        else
+          [val]
+        end
+    end
+
     # Returns the decoded value of the subject field, as a single string.
     #
     # Example:
@@ -1411,7 +1490,7 @@ module Mail
 
     # Returns the MIME media type of part we are on, this is taken from the content-type header
     def mime_type
-      content_type ? header[:content_type].string : nil rescue nil
+      has_content_type? ? header[:content_type].string : nil rescue nil
     end
 
     def message_content_type
@@ -1422,7 +1501,7 @@ module Mail
     # Returns the character set defined in the content type field
     def charset
       if @header
-        content_type ? content_type_parameters['charset'] : @charset
+        has_content_type? ? content_type_parameters['charset'] : @charset
       else
         @charset
       end
@@ -1516,7 +1595,7 @@ module Mail
 
     # Returns an AttachmentsList object, which holds all of the attachments in
     # the receiver object (either the entier email or a part within) and all
-    # of it's descendants.
+    # of its descendants.
     #
     # It also allows you to add attachments to the mail object directly, like so:
     #
@@ -1559,9 +1638,7 @@ module Mail
     # Accessor for html_part
     def html_part(&block)
       if block_given?
-        @html_part = Mail::Part.new(&block)
-        add_multipart_alternate_header unless html_part.blank?
-        add_part(@html_part)
+        self.html_part = Mail::Part.new(:content_type => 'text/html', &block)
       else
         @html_part || find_first_mime_type('text/html')
       end
@@ -1570,9 +1647,7 @@ module Mail
     # Accessor for text_part
     def text_part(&block)
       if block_given?
-        @text_part = Mail::Part.new(&block)
-        add_multipart_alternate_header unless html_part.blank?
-        add_part(@text_part)
+        self.text_part = Mail::Part.new(:content_type => 'text/plain', &block)
       else
         @text_part || find_first_mime_type('text/plain')
       end
@@ -1581,36 +1656,54 @@ module Mail
     # Helper to add a html part to a multipart/alternative email.  If this and
     # text_part are both defined in a message, then it will be a multipart/alternative
     # message and set itself that way.
-    def html_part=(msg = nil)
+    def html_part=(msg)
+      # Assign the html part and set multipart/alternative if there's a text part.
       if msg
         @html_part = msg
-      else
-        @html_part = Mail::Part.new('Content-Type: text/html;')
+        @html_part.content_type = 'text/html' unless @html_part.has_content_type?
+        add_multipart_alternate_header if text_part
+        add_part @html_part
+
+      # If nil, delete the html part and back out of multipart/alternative.
+      elsif @html_part
+        parts.delete_if { |p| p.object_id == @html_part.object_id }
+        @html_part = nil
+        if text_part
+          self.content_type = nil
+          body.boundary = nil
+        end
       end
-      add_multipart_alternate_header unless text_part.blank?
-      add_part(@html_part)
     end
 
     # Helper to add a text part to a multipart/alternative email.  If this and
     # html_part are both defined in a message, then it will be a multipart/alternative
     # message and set itself that way.
-    def text_part=(msg = nil)
+    def text_part=(msg)
+      # Assign the text part and set multipart/alternative if there's an html part.
       if msg
         @text_part = msg
-      else
-        @text_part = Mail::Part.new('Content-Type: text/plain;')
+        @text_part.content_type = 'text/plain' unless @text_part.has_content_type?
+        add_multipart_alternate_header if html_part
+        add_part @text_part
+
+      # If nil, delete the text part and back out of multipart/alternative.
+      elsif @text_part
+        parts.delete_if { |p| p.object_id == @text_part.object_id }
+        @text_part = nil
+        if html_part
+          self.content_type = nil
+          body.boundary = nil
+        end
       end
-      add_multipart_alternate_header unless html_part.blank?
-      add_part(@text_part)
     end
 
     # Adds a part to the parts list or creates the part list
     def add_part(part)
       if !body.multipart? && !self.body.decoded.blank?
-         @text_part = Mail::Part.new('Content-Type: text/plain;')
-         @text_part.body = body.decoded
-         self.body << @text_part
-         add_multipart_alternate_header
+        @text_part = Mail::Part.new('Content-Type: text/plain;')
+        @text_part.body = body.decoded
+        self.body << @text_part
+        add_multipart_alternate_header
       end
       add_boundary
       self.body << part
@@ -1646,7 +1739,7 @@ module Mail
     #  m.add_file(:filename => 'filename.png', :content => File.read('/path/to/file.jpg'))
     #
     # Note also that if you add a file to an existing message, Mail will convert that message
-    # to a MIME multipart email, moving whatever plain text body you had into it's own text
+    # to a MIME multipart email, moving whatever plain text body you had into its own text
     # plain part.
     #
     # Example:
@@ -1683,7 +1776,7 @@ module Mail
       self.body << text_part
     end
 
-    # Encodes the message, calls encode on all it's parts, gets an email message
+    # Encodes the message, calls encode on all its parts, gets an email message
     # ready to send
     def ready_to_send!
       identify_and_set_transfer_encoding
@@ -1875,15 +1968,13 @@ module Mail
     # Additionally, I allow for the case where someone might have put whitespace
     # on the "gap line"
     def parse_message
-      header_part, body_part = raw_source.split(/#{CRLF}#{WSP}*#{CRLF}/m, 2)
-#      index = raw_source.index(/#{CRLF}#{WSP}*#{CRLF}/m, 2)
-#      self.header = (index) ? header_part[0,index] : nil
-#      lazy_body ( [raw_source, index+1])
+      header_part, body_part = raw_source.lstrip.split(/#{CRLF}#{CRLF}|#{CRLF}#{WSP}*#{CRLF}(?!#{WSP})/m, 2)
       self.header = header_part
       self.body   = body_part
     end
 
     def raw_source=(value)
+      value.force_encoding("binary") if RUBY_VERSION >= "1.9.1"
       @raw_source = value.to_crlf
     end
 
@@ -1906,17 +1997,18 @@ module Mail
 
 
     def process_body_raw
-       @body = Mail::Body.new(@body_raw)
-       @body_raw = nil
-       separate_parts if @separate_parts
+      @body = Mail::Body.new(@body_raw)
+      @body_raw = nil
+      separate_parts if @separate_parts
 
-       add_encoding_to_body
+      add_encoding_to_body
     end
 
     def set_envelope_header
-      if match_data = raw_source.to_s.match(/\AFrom\s(#{TEXT}+)#{CRLF}(.*)/m)
+      raw_string = raw_source.to_s
+      if match_data = raw_source.to_s.match(/\AFrom\s(#{TEXT}+)#{CRLF}/m)
         set_envelope(match_data[1])
-        self.raw_source = match_data[2]
+        self.raw_source = raw_string.sub(match_data[0], "") 
       end
     end
 
@@ -1939,16 +2031,19 @@ module Mail
     end
 
     def add_required_fields
-      add_multipart_mixed_header    unless !body.multipart?
-      body = nil                    if body.nil?
-      add_message_id                unless (has_message_id? || self.class == Mail::Part)
-      add_date                      unless has_date?
-      add_mime_version              unless has_mime_version?
+      add_required_message_fields
+      add_multipart_mixed_header    if body.multipart?
       add_content_type              unless has_content_type?
       add_charset                   unless has_charset?
       add_content_transfer_encoding unless has_content_transfer_encoding?
     end
 
+    def add_required_message_fields
+      add_date          unless has_date?
+      add_mime_version  unless has_mime_version?
+      add_message_id    unless has_message_id?
+    end
+
     def add_multipart_alternate_header
       header['content-type'] = ContentTypeField.with_boundary('multipart/alternative').value
       header['content_type'].parameters[:charset] = @charset
@@ -2047,7 +2142,7 @@ module Mail
         else
           if encoding = Encoding.find(charset) rescue nil
             body_text.force_encoding(encoding)
-            return body_text.encode(Encoding::UTF_8)
+            return body_text.encode(Encoding::UTF_8, :undef => :replace, :invalid => :replace, :replace => '')
           end
         end
       end

data/lib/mail/multibyte/chars.rb

@@ -339,7 +339,7 @@ module Mail #:nodoc:
       # Example:
       #   'Laurent, où sont les tests ?'.mb_chars.upcase.to_s # => "LAURENT, OÙ SONT LES TESTS ?"
       def upcase
-        chars(Unicode.apply_mapping(@wrapped_string), :uppercase_mapping)
+        chars(Unicode.apply_mapping(@wrapped_string, :uppercase_mapping))
       end
 
       # Convert characters in the string to lowercase.
@@ -347,7 +347,7 @@ module Mail #:nodoc:
       # Example:
       #   'VĚDA A VÝZKUM'.mb_chars.downcase.to_s # => "věda a výzkum"
       def downcase
-        chars(Unicode.apply_mapping(@wrapped_string), :lowercase_mapping)
+        chars(Unicode.apply_mapping(@wrapped_string, :lowercase_mapping))
       end
 
       # Converts the first character to uppercase and the remainder to lowercase.
@@ -364,7 +364,7 @@ module Mail #:nodoc:
       #   "ÉL QUE SE ENTERÓ".mb_chars.titleize    # => "Él Que Se Enteró"
       #   "日本語".mb_chars.titleize                 # => "日本語"
       def titleize
-        chars(downcase.to_s.gsub(/\b('?[\S])/u) { Unicode.apply_mapping $1, :uppercase_mapping })
+        chars(downcase.to_s.gsub(/\b('?\S)/u) { Unicode.apply_mapping $1, :uppercase_mapping })
       end
       alias_method :titlecase, :titleize
 
@@ -412,7 +412,7 @@ module Mail #:nodoc:
         chars(Unicode.tidy_bytes(@wrapped_string, force))
       end
 
-       %w(capitalize downcase lstrip reverse rstrip slice strip tidy_bytes upcase).each do |method|
+      %w(capitalize downcase lstrip reverse rstrip slice strip tidy_bytes upcase).each do |method|
         # Only define a corresponding bang method for methods defined in the proxy; On 1.9 the proxy will
         # exclude lstrip!, rstrip! and strip! because they are already work as expected on multibyte strings.
         if public_method_defined?(method)

data/lib/mail/multibyte/unicode.rb

@@ -390,3 +390,11 @@ module Mail
     end
   end
 end
+
+unless defined?(ActiveSupport)
+  module ActiveSupport
+    unless const_defined?(:Multibyte)
+      Multibyte = Mail::Multibyte
+    end
+  end
+end

data/lib/mail/network/delivery_methods/exim.rb

@@ -36,18 +36,13 @@ module Mail
   #
   #   mail.deliver!
   class Exim < Sendmail
+    DEFAULTS = {
+      :location   => '/usr/sbin/exim',
+      :arguments  => '-i -t'
+    }
 
-    def initialize(values)
-      self.settings = { :location       => '/usr/sbin/exim',
-                        :arguments      => '-i -t' }.merge(values)
+    def self.call(path, arguments, destinations, encoded_message)
+      super path, arguments, nil, encoded_message
     end
-
-    def self.call(path, arguments, mail)
-      IO.popen("#{path} #{arguments}", "w+") do |io|
-        io.puts mail.encoded.to_lf
-        io.flush
-      end
-    end
-
   end
 end

data/lib/mail/network/delivery_methods/file_delivery.rb

@@ -1,5 +1,6 @@
+require 'mail/check_delivery_params'
+
 module Mail
-  
   # FileDelivery class delivers emails into multiple files based on the destination
   # address.  Each file is appended to if it already exists.
   # 
@@ -11,20 +12,21 @@ module Mail
   # Make sure the path you specify with :location is writable by the Ruby process
   # running Mail.
   class FileDelivery
-
     if RUBY_VERSION >= '1.9.1'
       require 'fileutils'
     else
       require 'ftools'
     end
 
+    attr_accessor :settings
+
     def initialize(values)
       self.settings = { :location => './mails' }.merge!(values)
     end
-    
-    attr_accessor :settings
-    
+
     def deliver!(mail)
+      Mail::CheckDeliveryParams.check(mail)
+
       if ::File.respond_to?(:makedirs)
         ::File.makedirs settings[:location]
       else
@@ -35,6 +37,5 @@ module Mail
         ::File.open(::File.join(settings[:location], File.basename(to.to_s)), 'a') { |f| "#{f.write(mail.encoded)}\r\n\r\n" }
       end
     end
-    
   end
 end