mail 2.4.4 → 2.6.3

data/lib/mail/message.rb

@@ -46,7 +46,7 @@ module Mail
   #   (i.e., a line with nothing preceding the CRLF).
   class Message
 
-    include Patterns
+    include Constants
     include Utilities
 
     # ==Making an email
@@ -105,9 +105,12 @@ module Mail
       @html_part = nil
       @errors = nil
       @header = nil
-      @charset = 'UTF-8'
+      @charset = self.class.default_charset
       @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
 
@@ -204,6 +207,10 @@ module Mail
     # define a delivery_handler
     attr_accessor :raise_delivery_errors
 
+    def self.default_charset; @@default_charset; end
+    def self.default_charset=(charset); @@default_charset = charset; end
+    self.default_charset = 'UTF-8'
+
     def register_for_delivery_notification(observer)
       STDERR.puts("Message#register_for_delivery_notification is deprecated, please call Mail.register_observer instead")
       Mail.register_observer(observer)
@@ -237,7 +244,7 @@ module Mail
     # This method bypasses checking perform_deliveries and raise_delivery_errors,
     # so use with caution.
     #
-    # It still however fires off the intercepters and calls the observers callbacks if they are defined.
+    # It still however fires off the interceptors and calls the observers callbacks if they are defined.
     #
     # Returns self
     def deliver!
@@ -350,17 +357,23 @@ module Mail
       return false unless other.respond_to?(:encoded)
 
       if self.message_id && other.message_id
-        result = (self.encoded == other.encoded)
+        self.encoded == other.encoded
       else
         self_message_id, other_message_id = self.message_id, other.message_id
-        self.message_id, other.message_id = '<temp@test>', '<temp@test>'
-        result = self.encoded == other.encoded
-        self.message_id = "<#{self_message_id}>" if self_message_id
-        other.message_id = "<#{other_message_id}>" if other_message_id
-        result
+        begin
+          self.message_id, other.message_id = '<temp@test>', '<temp@test>'
+          self.encoded == other.encoded
+        ensure
+          self.message_id, other.message_id = self_message_id, other_message_id
+        end
       end
     end
 
+    def initialize_copy(original)
+      super
+      @header = @header.dup
+    end
+
     # Provides access to the raw source of the message as it was when it
     # was instantiated. This is set at initialization and so is untouched
     # by the parsers or decoder / encoders
@@ -938,8 +951,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 +1036,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:
@@ -1309,7 +1398,7 @@ module Mail
       header.has_date?
     end
 
-    # Returns true if the message has a Date field, the field may or may
+    # Returns true if the message has a Mime-Version field, the field may or may
     # not have a value, but the field exists or not.
     def has_mime_version?
       header.has_mime_version?
@@ -1411,7 +1500,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 +1511,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
@@ -1515,8 +1604,8 @@ module Mail
     end
 
     # 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.
+    # the receiver object (either the entire email or a part within) and all
+    # of its descendants.
     #
     # It also allows you to add attachments to the mail object directly, like so:
     #
@@ -1559,9 +1648,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 +1657,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 +1666,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 +1749,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 +1786,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
@@ -1864,6 +1967,8 @@ module Mail
 
   private
 
+    HEADER_SEPARATOR = /#{CRLF}#{CRLF}|#{CRLF}#{WSP}*#{CRLF}(?!#{WSP})/m
+
     #  2.1. General Description
     #   A message consists of header fields (collectively called "the header
     #   of the message") followed, optionally, by a body.  The header is a
@@ -1875,15 +1980,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(HEADER_SEPARATOR, 2)
       self.header = header_part
       self.body   = body_part
     end
 
     def raw_source=(value)
+      value = value.dup.force_encoding(Encoding::BINARY) if RUBY_VERSION >= "1.9.1"
       @raw_source = value.to_crlf
     end
 
@@ -1906,17 +2009,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 +2043,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
@@ -2033,7 +2140,7 @@ module Mail
         if perform_deliveries
           delivery_method.deliver!(self)
         end
-      rescue Exception => e # Net::SMTP errors or sendmail pipe errors
+      rescue => e # Net::SMTP errors or sendmail pipe errors
         raise e if raise_delivery_errors
       end
     end
@@ -2047,7 +2154,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

@@ -341,7 +341,7 @@ module Mail
         def load
           begin
             @codepoints, @composition_exclusion, @composition_map, @boundary, @cp1252 = File.open(self.class.filename, 'rb') { |f| Marshal.load f.read }
-          rescue Exception => e
+          rescue => e
               raise IOError.new("Couldn't load the Unicode tables for UTF8Handler (#{e.message}), Mail::Multibyte is unusable")
           end
 
@@ -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,14 +36,13 @@ module Mail
   #
   #   mail.deliver!
   class Exim < Sendmail
-
     def initialize(values)
       self.settings = { :location       => '/usr/sbin/exim',
                         :arguments      => '-i -t' }.merge(values)
     end
 
-    def self.call(path, arguments, mail)
-      IO.popen("#{path} #{arguments}", "w+") do |io|
+    def self.call(path, arguments, destinations, mail)
+      popen "#{path} #{arguments}" do |io|
         io.puts mail.encoded.to_lf
         io.flush
       end

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

@@ -1,3 +1,5 @@
+require 'mail/check_delivery_params'
+
 module Mail
   
   # FileDelivery class delivers emails into multiple files based on the destination
@@ -11,6 +13,7 @@ module Mail
   # Make sure the path you specify with :location is writable by the Ruby process
   # running Mail.
   class FileDelivery
+    include Mail::CheckDeliveryParams
 
     if RUBY_VERSION >= '1.9.1'
       require 'fileutils'
@@ -25,6 +28,8 @@ module Mail
     attr_accessor :settings
     
     def deliver!(mail)
+      check_delivery_params(mail)
+
       if ::File.respond_to?(:makedirs)
         ::File.makedirs settings[:location]
       else

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

@@ -1,3 +1,5 @@
+require 'mail/check_delivery_params'
+
 module Mail
   # A delivery method implementation which sends via sendmail.
   #
@@ -35,28 +37,53 @@ module Mail
   #
   #   mail.deliver!
   class Sendmail
+    include Mail::CheckDeliveryParams
 
     def initialize(values)
       self.settings = { :location       => '/usr/sbin/sendmail',
-                        :arguments      => '-i -t' }.merge(values)
+                        :arguments      => '-i' }.merge(values)
     end
 
     attr_accessor :settings
 
     def deliver!(mail)
-      envelope_from = mail.return_path || mail.sender || mail.from_addrs.first
-      return_path = "-f " + '"' + envelope_from.escape_for_shell + '"' if envelope_from
+      smtp_from, smtp_to, message = check_delivery_params(mail)
 
-      arguments = [settings[:arguments], return_path].compact.join(" ")
+      from = "-f #{self.class.shellquote(smtp_from)}"
+      to = smtp_to.map { |_to| self.class.shellquote(_to) }.join(' ')
 
-      self.class.call(settings[:location], arguments, mail.destinations.collect(&:escape_for_shell).join(" "), mail)
+      arguments = "#{settings[:arguments]} #{from} --"
+      self.class.call(settings[:location], arguments, to, message)
     end
 
-    def self.call(path, arguments, destinations, mail)
-      IO.popen("#{path} #{arguments} #{destinations}", "w+") do |io|
-        io.puts mail.encoded.to_lf
+    def self.call(path, arguments, destinations, encoded_message)
+      popen "#{path} #{arguments} #{destinations}" do |io|
+        io.puts encoded_message.to_lf
         io.flush
       end
     end
+
+    if RUBY_VERSION < '1.9.0'
+      def self.popen(command, &block)
+        IO.popen "#{command} 2>&1", 'w+', &block
+      end
+    else
+      def self.popen(command, &block)
+        IO.popen command, 'w+', :err => :out, &block
+      end
+    end
+
+    # The following is an adaptation of ruby 1.9.2's shellwords.rb file,
+    # it is modified to include '+' in the allowed list to allow for
+    # sendmail to accept email addresses as the sender with a + in them.
+    def self.shellquote(address)
+      # Process as a single byte sequence because not all shell
+      # implementations are multibyte aware.
+      #
+      # A LF cannot be escaped with a backslash because a backslash + LF
+      # combo is regarded as line continuation and simply ignored. Strip it.
+      escaped = address.gsub(/([^A-Za-z0-9_\s\+\-.,:\/@])/n, "\\\\\\1").gsub("\n", '')
+      %("#{escaped}")
+    end
   end
 end