mail 2.3.3 → 2.4.0

data/lib/mail/message.rb

@@ -10,7 +10,7 @@ module Mail
   #
   # A Message object by default has the following objects inside it:
   #
-  # * A Header object which contians all information and settings of the header of the email
+  # * A Header object which contains all information and settings of the header of the email
   # * Body object which contains all parts of the email that are not part of the header, this
   #   includes any attachments, body text, MIME parts etc.
   #
@@ -100,7 +100,6 @@ module Mail
     def initialize(*args, &block)
       @body = nil
       @body_raw = nil
-      @body_raw_index = nil
       @separate_parts = false
       @text_part = nil
       @html_part = nil
@@ -1134,7 +1133,7 @@ module Mail
     #  mail.parts.length #=> 2
     #  mail.parts.last.content_type.content_type #=> 'This is a body'
     def body=(value)
-      body_lazy(value, 0)
+      body_lazy(value)
     end
 
     # Returns the body of the message object. Or, if passed
@@ -1711,19 +1710,54 @@ module Mail
       buffer
     end
 
-    def to_yaml
-      ready_to_send!
+    def without_attachments!
+      return self unless has_attachments?
+
+      parts.delete_if { |p| p.attachment? }
+      body_raw = if parts.empty?
+                   ''
+                 else
+                   body.encoded
+                 end
+
+      @body = Mail::Body.new(body_raw)
+
+      self
+    end
+
+    def to_yaml(opts = {})
       hash = {}
+      hash['headers'] = {}
       header.fields.each do |field|
-        hash[field.name] = field.value
+        hash['headers'][field.name] = field.value
+      end
+      hash['delivery_handler'] = delivery_handler.to_s if delivery_handler
+      hash['transport_encoding'] = transport_encoding.to_s
+      special_variables = [:@header, :@delivery_handler, :@transport_encoding]
+      (instance_variables.map(&:to_sym) - special_variables).each do |var|
+        hash[var.to_s] = instance_variable_get(var)
       end
-      hash['subject'] = subject
-      hash['body'] = body.encoded(content_transfer_encoding)
-      hash.to_yaml
+      hash.to_yaml(opts)
     end
 
     def self.from_yaml(str)
-      from_hash(YAML::load(str))
+      hash = YAML.load(str)
+      m = Mail::Message.new(:headers => hash['headers'])
+      hash.delete('headers')
+      hash.each do |k,v|
+        case
+        when k == 'delivery_handler'
+          begin
+            m.delivery_handler = Object.const_get(v) unless v.blank?
+          rescue NameError
+          end
+        when k == 'transport_encoding'
+          m.transport_encoding(v)
+        when k =~ /^@/
+          m.instance_variable_set(k.to_sym, v)
+        end
+      end
+      m
     end
 
     def self.from_hash(hash)
@@ -1740,6 +1774,8 @@ module Mail
 
     def decoded
       case
+      when self.text?
+        decode_body_as_text
       when self.attachment?
         decode_body
       when !self.multipart?
@@ -1814,6 +1850,10 @@ module Mail
       return @mark_for_delete
     end
 
+    def text?
+      has_content_type? ? !!(main_type =~ /^text$/i) : false
+    end
+
   private
 
     #  2.1. General Description
@@ -1839,31 +1879,28 @@ module Mail
       @raw_source = value.to_crlf
     end
 
-    # see comments to body=. We take data starting from index and process it lazily
-    def body_lazy(value, index)
+    # see comments to body=. We take data and process it lazily
+    def body_lazy(value)
       process_body_raw if @body_raw && value
       case
-      when value == nil || value.length<=index
+      when value == nil || value.length<=0
         @body = Mail::Body.new('')
         @body_raw = nil
-        @body_raw_index = nil
         add_encoding_to_body
       when @body && @body.multipart?
-        @body << Mail::Part.new(value[index, value.length-index])
+        @body << Mail::Part.new(value)
         add_encoding_to_body
       else
         @body_raw = value
-        @body_raw_index = index
 #        process_body_raw
       end
     end
 
 
     def process_body_raw
-       @body = Mail::Body.new(@body_raw[@body_raw_index, @body_raw.length-@body_raw_index])
+       @body = Mail::Body.new(@body_raw)
        @body_raw = nil
-       @body_raw_index = nil
-      separate_parts if @separate_parts
+       separate_parts if @separate_parts
 
        add_encoding_to_body
     end
@@ -1993,5 +2030,21 @@ module Mail
       end
     end
 
+    def decode_body_as_text
+      body_text = decode_body
+      if charset
+        if RUBY_VERSION < '1.9'
+          require 'iconv'
+          return Iconv.conv("UTF-8//TRANSLIT//IGNORE", charset, body_text)
+        else
+          if encoding = Encoding.find(charset) rescue nil
+            body_text.force_encoding(encoding)
+            return body_text.encode(Encoding::UTF_8)
+          end
+        end
+      end
+      body_text
+    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.

data/lib/mail/multibyte/utils.rb

@@ -2,7 +2,7 @@
 
 module Mail #:nodoc:
   module Multibyte #:nodoc:
-    if Kernel.const_defined?(:Encoding)
+    if RUBY_VERSION >= "1.9"
       # Returns a regular expression that matches valid characters in the current encoding
       def self.valid_character
         VALID_CHARACTER[Encoding.default_external.to_s]

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

@@ -1,45 +1,12 @@
 module Mail
 
-  # A delivery method implementation which sends via exim.
-  #
-  # To use this, first find out where the exim binary is on your computer,
-  # if you are on a mac or unix box, it is usually in /usr/sbin/exim, this will
-  # be your exim location.
-  #
-  #   Mail.defaults do
-  #     delivery_method :exim
-  #   end
-  #
-  # Or if your exim binary is not at '/usr/sbin/exim'
-  #
-  #   Mail.defaults do
-  #     delivery_method :exim, :location => '/absolute/path/to/your/exim'
-  #   end
-  #
-  # Then just deliver the email as normal:
-  #
-  #   Mail.deliver do
-  #     to 'mikel@test.lindsaar.net'
-  #     from 'ada@test.lindsaar.net'
-  #     subject 'testing exim'
-  #     body 'testing exim'
-  #   end
-  #
-  # Or by calling deliver on a Mail message
-  #
-  #   mail = Mail.new do
-  #     to 'mikel@test.lindsaar.net'
-  #     from 'ada@test.lindsaar.net'
-  #     subject 'testing exim'
-  #     body 'testing exim'
-  #   end
-  #
-  #   mail.deliver!
   class Exim < Sendmail
 
-    def initialize(values)
-      self.settings = { :location       => '/usr/sbin/exim',
-                        :arguments      => '-i -t' }.merge(values)
+    def deliver!(mail)
+      envelope_from = mail.return_path || mail.sender || mail.from_addrs.first
+      return_path = "-f \"#{envelope_from.to_s.shellescape}\"" if envelope_from
+      arguments = [settings[:arguments], return_path].compact.join(" ")
+      self.class.call(settings[:location], arguments, mail)
     end
 
     def self.call(path, arguments, mail)

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

@@ -6,7 +6,7 @@ module Mail
   # So if you have an email going to fred@test, bob@test, joe@anothertest, and you
   # set your location path to /path/to/mails then FileDelivery will create the directory
   # if it does not exist, and put one copy of the email in three files, called
-  # by their message id
+  # "fred@test", "bob@test" and "joe@anothertest"
   # 
   # Make sure the path you specify with :location is writable by the Ruby process
   # running Mail.
@@ -32,7 +32,7 @@ module Mail
       end
 
       mail.destinations.uniq.each do |to|
-        ::File.open(::File.join(settings[:location], File.basename(to.to_s)), 'a') { |f| "#{f.write(mail.encoded)}\r\n\r\n" }
+        ::File.open(::File.join(settings[:location], to), 'a') { |f| "#{f.write(mail.encoded)}\r\n\r\n" }
       end
     end
     

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

@@ -45,14 +45,14 @@ module Mail
 
     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
+      return_path = "-f \"#{envelope_from.to_s.gsub('"', '\"')}\"" if envelope_from
 
       arguments = [settings[:arguments], return_path].compact.join(" ")
 
-      self.class.call(settings[:location], arguments, mail.destinations.collect(&:escape_for_shell).join(" "), mail)
+      Sendmail.call(settings[:location], arguments, mail.destinations.collect(&:shellescape).join(" "), mail)
     end
 
-    def self.call(path, arguments, destinations, mail)
+    def Sendmail.call(path, arguments, destinations, mail)
       IO.popen("#{path} #{arguments} #{destinations}", "w+") do |io|
         io.puts mail.encoded.to_lf
         io.flush

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

@@ -81,7 +81,9 @@ module Mail
                         :password             => nil,
                         :authentication       => nil,
                         :enable_starttls_auto => true,
-                        :openssl_verify_mode  => nil
+                        :openssl_verify_mode  => nil,
+                        :ssl                  => nil,
+                        :tls                  => nil
                       }.merge!(values)
     end
     
@@ -108,7 +110,21 @@ module Mail
       end
       
       smtp = Net::SMTP.new(settings[:address], settings[:port])
-      if settings[:enable_starttls_auto]
+      if settings[:tls] || settings[:ssl]
+        if smtp.respond_to?(:enable_tls)
+          unless settings[:openssl_verify_mode]
+            smtp.enable_tls
+          else
+            openssl_verify_mode = settings[:openssl_verify_mode]
+            if openssl_verify_mode.kind_of?(String)
+              openssl_verify_mode = "OpenSSL::SSL::VERIFY_#{openssl_verify_mode.upcase}".constantize
+            end
+            context = Net::SMTP.default_ssl_context
+            context.verify_mode = openssl_verify_mode
+            smtp.enable_tls(context)
+          end        
+        end
+      elsif settings[:enable_starttls_auto]
         if smtp.respond_to?(:enable_starttls_auto) 
           unless settings[:openssl_verify_mode]
             smtp.enable_starttls_auto
@@ -125,8 +141,8 @@ module Mail
       end
       
       response = nil
-      smtp.start(settings[:domain], settings[:user_name], settings[:password], settings[:authentication]) do |smtp|
-        response = smtp.sendmail(message, envelope_from, destinations)
+      smtp.start(settings[:domain], settings[:user_name], settings[:password], settings[:authentication]) do |smtp_obj|
+        response = smtp_obj.sendmail(message, envelope_from, destinations)
       end
 
       return settings[:return_response] ? response : self

data/lib/mail/network/retriever_methods/imap.rb

@@ -54,6 +54,8 @@ module Mail
     #   order:   order of emails returned. Possible values are :asc or :desc. Default value is :asc.
     #   count:   number of emails to retrieve. The default value is 10. A value of 1 returns an
     #            instance of Message, not an array of Message instances.
+    #   ready_only: will ensure that no writes are made to the inbox during the session. 
+    #               This is helpful when you don't want your messages to be set to read automatically. Default is false.
     #   delete_after_find: flag for whether to delete each retreived email after find. Default
     #           is false. Use #find_and_delete if you would like this to default to true.
     #
@@ -61,7 +63,7 @@ module Mail
       options = validate_options(options)
 
       start do |imap|
-        imap.select(options[:mailbox])
+        options[:read_only] ? imap.select(options[:mailbox]) : imap.examine(options[:mailbox])
 
         message_ids = imap.uid_search(options[:keys])
         message_ids.reverse! if options[:what].to_sym == :last
@@ -101,7 +103,6 @@ module Mail
       mailbox = Net::IMAP.encode_utf7(mailbox)
 
       start do |imap|
-        imap.select(mailbox)
         imap.uid_search(['ALL']).each do |message_id|
           imap.uid_store(message_id, "+FLAGS", [Net::IMAP::DELETED])
         end
@@ -130,6 +131,7 @@ module Mail
         options[:keys]    ||= 'ALL'
         options[:delete_after_find] ||= false
         options[:mailbox] = Net::IMAP.encode_utf7(options[:mailbox])
+        options[:read_only] ||= false
 
         options
       end

data/lib/mail/parsers/rfc2822.treetop

@@ -110,7 +110,7 @@ module Mail
     end
     
     rule local_dot_atom_text
-      ("."* domain_text)+
+      ("."? domain_text)+
     end
     
     rule domain_text

data/lib/mail/parsers/rfc2822_obsolete.rb

@@ -257,8 +257,19 @@ module Mail
           if r3
             r1 = r3
           else
-            @index = i1
-            r1 = nil
+            if has_terminal?("@", false, index)
+              r4 = instantiate_node(SyntaxNode,input, index...(index + 1))
+              @index += 1
+            else
+              terminal_parse_failure("@")
+              r4 = nil
+            end
+            if r4
+              r1 = r4
+            else
+              @index = i1
+              r1 = nil
+            end
           end
         end
         if r1
@@ -3754,4 +3765,4 @@ module Mail
     include RFC2822Obsolete
   end
 
-end
+end

data/lib/mail/parsers/rfc2822_obsolete.treetop

@@ -20,7 +20,7 @@ module Mail
     end
 
     rule obs_phrase
-      (word / ".")+
+      (word / "." / "@")+
     end
 
     rule obs_phrase_list
@@ -238,4 +238,4 @@ module Mail
       field_name WSP* ":" unstructured CRLF
     end
   end
-end
+end

data/lib/mail/parts_list.rb

@@ -26,6 +26,10 @@ module Mail
       raise NoMethodError, "#collect! is not defined, please call #collect and create a new PartsList"
     end
 
+    def sort
+      self.class.new(super)
+    end
+
     def sort!(order)
       sorted = self.sort do |a, b|
         # OK, 10000 is arbitrary... if anyone actually wants to explicitly sort 10000 parts of a

data/lib/mail/utilities.rb

@@ -116,11 +116,15 @@ module Mail
     end
     
     def uri_escape( str )
-      URI.escape(str)
+      uri_parser.escape(str)
     end
     
     def uri_unescape( str )
-      URI.unescape(str)
+      uri_parser.unescape(str)
+    end
+    
+    def uri_parser
+      @uri_parser ||= URI.const_defined?(:Parser) ? URI::Parser.new : URI
     end
     
     # Matches two objects with their to_s values case insensitively

data/lib/mail/version_specific/ruby_1_8.rb

@@ -80,7 +80,7 @@ module Mail
       match = str.match(/\=\?(.+)?\?[Qq]\?(.+)?\?\=/m)
       if match
         encoding = match[1]
-        str = Encodings::QuotedPrintable.decode(match[2])
+        str = Encodings::QuotedPrintable.decode(match[2].gsub(/_/, '=20'))
       end
       str
     end