mail 2.5.5 → 2.6.0

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

@@ -1,6 +1,7 @@
 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.
   # 
@@ -12,20 +13,22 @@ 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'
     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)
+      check_delivery_params(mail)
 
       if ::File.respond_to?(:makedirs)
         ::File.makedirs settings[:location]
@@ -37,5 +40,6 @@ 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

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

@@ -37,22 +37,20 @@ module Mail
   #
   #   mail.deliver!
   class Sendmail
-    DEFAULTS = {
-      :location   => '/usr/sbin/sendmail',
-      :arguments  => '-i'
-    }
-
-    attr_accessor :settings
+    include Mail::CheckDeliveryParams
 
     def initialize(values)
-      self.settings = self.class::DEFAULTS.merge(values)
+      self.settings = { :location       => '/usr/sbin/sendmail',
+                        :arguments      => '-i' }.merge(values)
     end
 
+    attr_accessor :settings
+
     def deliver!(mail)
-      smtp_from, smtp_to, message = Mail::CheckDeliveryParams.check(mail)
+      smtp_from, smtp_to, message = check_delivery_params(mail)
 
       from = "-f #{self.class.shellquote(smtp_from)}"
-      to = smtp_to.map { |to| self.class.shellquote(to) }.join(' ')
+      to = smtp_to.map { |_to| self.class.shellquote(_to) }.join(' ')
 
       arguments = "#{settings[:arguments]} #{from} --"
       self.class.call(settings[:location], arguments, to, message)

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

@@ -74,7 +74,7 @@ module Mail
   # 
   #   mail.deliver!
   class SMTP
-    attr_accessor :settings
+    include Mail::CheckDeliveryParams
 
     def initialize(values)
       self.settings = { :address              => "localhost",
@@ -90,10 +90,12 @@ module Mail
                       }.merge!(values)
     end
 
+    attr_accessor :settings
+
     # Send the message via SMTP.
     # The from and to attributes are optional. If not set, they are retrieve from the Message.
     def deliver!(mail)
-      smtp_from, smtp_to, message = Mail::CheckDeliveryParams.check(mail)
+      smtp_from, smtp_to, message = check_delivery_params(mail)
 
       smtp = Net::SMTP.new(settings[:address], settings[:port])
       if settings[:tls] || settings[:ssl]
@@ -117,6 +119,7 @@ module Mail
         self
       end
     end
+    
 
     private
 

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

@@ -37,7 +37,7 @@ module Mail
   # 
   #   mail.deliver!
   class SMTPConnection
-    attr_accessor :smtp, :settings
+    include Mail::CheckDeliveryParams
 
     def initialize(values)
       raise ArgumentError.new('A Net::SMTP object is required for this delivery method') if values[:connection].nil?
@@ -45,13 +45,17 @@ module Mail
       self.settings = values
     end
 
+    attr_accessor :smtp
+    attr_accessor :settings
+
     # Send the message via SMTP.
     # The from and to attributes are optional. If not set, they are retrieve from the Message.
     def deliver!(mail)
-      smtp_from, smtp_to, message = Mail::CheckDeliveryParams.check(mail)
+      smtp_from, smtp_to, message = check_delivery_params(mail)
       response = smtp.sendmail(message, smtp_from, smtp_to)
 
       settings[:return_response] ? response : self
     end
+
   end
 end

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

@@ -7,8 +7,10 @@ module Mail
   # It also provides a template of the minimum methods you require to implement
   # if you want to make a custom mailer for Mail
   class TestMailer
+    include Mail::CheckDeliveryParams
+
     # Provides a store of all the emails sent with the TestMailer so you can check them.
-    def self.deliveries
+    def TestMailer.deliveries
       @@deliveries ||= []
     end
 
@@ -23,19 +25,20 @@ module Mail
     # * length
     # * size
     # * and other common Array methods
-    def self.deliveries=(val)
+    def TestMailer.deliveries=(val)
       @@deliveries = val
     end
 
-    attr_accessor :settings
-
     def initialize(values)
       @settings = values.dup
     end
+    
+    attr_accessor :settings
 
     def deliver!(mail)
-      Mail::CheckDeliveryParams.check(mail)
+      check_delivery_params(mail)
       Mail::TestMailer.deliveries << mail
     end
+    
   end
 end

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

@@ -73,31 +73,35 @@ module Mail
       start do |imap|
         options[:read_only] ? imap.examine(options[:mailbox]) : imap.select(options[:mailbox])
 
-        message_ids = imap.uid_search(options[:keys])
-        message_ids.reverse! if options[:what].to_sym == :last
-        message_ids = message_ids.first(options[:count]) if options[:count].is_a?(Integer)
-        message_ids.reverse! if (options[:what].to_sym == :last && options[:order].to_sym == :asc) ||
+        uids = imap.uid_search(options[:keys])
+        uids.reverse! if options[:what].to_sym == :last
+        uids = uids.first(options[:count]) if options[:count].is_a?(Integer)
+        uids.reverse! if (options[:what].to_sym == :last && options[:order].to_sym == :asc) ||
                                 (options[:what].to_sym != :last && options[:order].to_sym == :desc)
 
         if block_given?
-          message_ids.each do |message_id|
-            fetchdata = imap.uid_fetch(message_id, ['RFC822'])[0]
+          uids.each do |uid|
+            uid = options[:uid].to_i unless options[:uid].nil?
+            fetchdata = imap.uid_fetch(uid, ['RFC822'])[0]
             new_message = Mail.new(fetchdata.attr['RFC822'])
             new_message.mark_for_delete = true if options[:delete_after_find]
             if block.arity == 3
-              yield new_message, imap, message_id
+              yield new_message, imap, uid
             else
               yield new_message
             end
-            imap.uid_store(message_id, "+FLAGS", [Net::IMAP::DELETED]) if options[:delete_after_find] && new_message.is_marked_for_delete?
+            imap.uid_store(uid, "+FLAGS", [Net::IMAP::DELETED]) if options[:delete_after_find] && new_message.is_marked_for_delete?
+            break unless options[:uid].nil?
           end
           imap.expunge if options[:delete_after_find]
         else
           emails = []
-          message_ids.each do |message_id|
-            fetchdata = imap.uid_fetch(message_id, ['RFC822'])[0]
+          uids.each do |uid|
+            uid = options[:uid].to_i unless options[:uid].nil?
+            fetchdata = imap.uid_fetch(uid, ['RFC822'])[0]
             emails << Mail.new(fetchdata.attr['RFC822'])
-            imap.uid_store(message_id, "+FLAGS", [Net::IMAP::DELETED]) if options[:delete_after_find]
+            imap.uid_store(uid, "+FLAGS", [Net::IMAP::DELETED]) if options[:delete_after_find]
+            break unless options[:uid].nil?
           end
           imap.expunge if options[:delete_after_find]
           emails.size == 1 && options[:count] == 1 ? emails.first : emails
@@ -111,8 +115,8 @@ module Mail
       mailbox = Net::IMAP.encode_utf7(mailbox)
 
       start do |imap|
-        imap.uid_search(['ALL']).each do |message_id|
-          imap.uid_store(message_id, "+FLAGS", [Net::IMAP::DELETED])
+        imap.uid_search(['ALL']).each do |uid|
+          imap.uid_store(uid, "+FLAGS", [Net::IMAP::DELETED])
         end
         imap.expunge
       end
@@ -137,6 +141,7 @@ module Mail
         options[:order]   ||= :asc
         options[:what]    ||= :first
         options[:keys]    ||= 'ALL'
+        options[:uid]     ||= nil
         options[:delete_after_find] ||= false
         options[:mailbox] = Net::IMAP.encode_utf7(options[:mailbox])
         options[:read_only] ||= false

data/lib/mail/parsers.rb

@@ -0,0 +1,26 @@
+module Mail
+  module Parsers
+
+    # Low-level ragel based parsers
+    require 'mail/parsers/ragel'
+
+    AddressListStruct = Struct.new(:addresses, :group_names, :error)
+    AddressStruct = Struct.new(:raw, :domain, :comments, :local,
+                             :obs_domain_list, :display_name, :group, :error)
+    ContentDispositionStruct = Struct.new(:disposition_type, :parameters, :error)
+    ContentLocationStruct = Struct.new(:location, :error)
+    ContentTransferEncodingStruct = Struct.new(:encoding, :error)
+    ContentTypeStruct = Struct.new(:main_type, :sub_type, :parameters, :error)
+    DateTimeStruct = Struct.new(:date_string, :time_string, :error)
+    EnvelopeFromStruct = Struct.new(:address, :ctime_date, :error)
+    MessageIdsStruct = Struct.new(:message_ids, :error)
+    MimeVersionStruct = Struct.new(:major, :minor, :error)
+    PhraseListsStruct = Struct.new(:phrases, :error)
+    ReceivedStruct = Struct.new(:date, :time, :info, :error)
+
+    require 'mail/parsers/ragel/parser_info'
+    Ragel::FIELD_PARSERS.each do |field_parser|
+      require "mail/parsers/#{field_parser}_parser"
+    end
+  end
+end

data/lib/mail/parsers/address_lists_parser.rb

@@ -0,0 +1,132 @@
+module Mail::Parsers
+  class AddressListsParser
+    include Mail::Utilities
+
+    def parse(s)
+      address_list = AddressListStruct.new([],[])
+
+      if s.blank?
+        return address_list
+      end
+
+      actions, error = Ragel.parse(:address_lists, s)
+      if error
+        raise Mail::Field::ParseError.new(Mail::AddressList, s, error)
+      end
+
+
+      phrase_s = phrase_e = qstr_s = qstr = comment_s = nil
+      group_name_s = domain_s = group_name = nil
+      local_dot_atom_s = local_dot_atom_e = nil
+      local_dot_atom_pre_comment_e = nil
+      obs_domain_list_s = nil
+
+      address_s = 0
+      address = AddressStruct.new(nil, nil, [], nil, nil, nil, nil)
+      actions.each_slice(2) do |action_id, p|
+        action = Mail::Parsers::Ragel::ACTIONS[action_id]
+        case action
+
+        # Phrase
+        when :phrase_s then phrase_s = p
+        when :phrase_e then phrase_e = p-1
+
+        # Quoted String.
+        when :qstr_s then qstr_s = p
+        when :qstr_e then qstr = s[qstr_s..(p-1)]
+
+        # Comment
+        when :comment_s
+          comment_s = p unless comment_s
+        when :comment_e
+          if address
+            address.comments << s[comment_s..(p-2)]
+          end
+          comment_s = nil
+
+        # Group Name
+        when :group_name_s then group_name_s = p
+        when :group_name_e
+          if qstr
+            group = qstr
+            qstr = nil
+          else
+            group = s[group_name_s..(p-1)]
+            group_name_s = nil
+          end
+          address_list.group_names << group
+          group_name = group
+
+          # Start next address
+          address = AddressStruct.new(nil, nil, [], nil, nil, nil, nil)
+          address_s = p
+          address.group = group_name
+
+        # Address
+        when :address_s
+          address_s = p
+        when :address_e
+          # Ignore address end events if they don't have
+          # a matching address start event.
+          next if address_s.nil?
+          if address.local.nil? && local_dot_atom_pre_comment_e && local_dot_atom_s && local_dot_atom_e
+            if address.domain
+              address.local = s[local_dot_atom_s..local_dot_atom_e] if address
+            else
+              address.local = s[local_dot_atom_s..local_dot_atom_pre_comment_e] if address
+            end
+          end
+          address.raw = s[address_s..(p-1)]
+          address_list.addresses << address if address
+
+          # Start next address
+          address = AddressStruct.new(nil, nil, [], nil, nil, nil, nil)
+          address.group = group_name
+          address_s = nil
+
+        # Don't set the display name until the
+        # address has actually started. This allows
+        # us to choose quoted_s version if it
+        # exists and always use the 'full' phrase
+        # version.
+        when :angle_addr_s
+          if qstr
+            address.display_name = qstr
+            qstr = nil
+          elsif phrase_e
+            address.display_name = s[phrase_s..phrase_e].strip
+            phrase_e = phrase_s = nil
+          end
+
+        # Domain
+        when :domain_s
+          domain_s = p
+        when :domain_e
+          address.domain = s[domain_s..(p-1)].rstrip if address
+
+        # Local
+        when :local_dot_atom_s then local_dot_atom_s = p
+        when :local_dot_atom_e then local_dot_atom_e = p-1
+        when :local_dot_atom_pre_comment_e
+          local_dot_atom_pre_comment_e = p-1
+        when :local_quoted_string_e
+          address.local = '"' + qstr + '"' if address
+
+        # obs_domain_list
+        when :obs_domain_list_s then obs_domain_list_s = p
+        when :obs_domain_list_e
+          address.obs_domain_list = s[obs_domain_list_s..(p-1)]
+
+        else
+          raise Mail::Field::ParseError.new(Mail::AddressList, s, "Failed to process unknown action: #{action}")
+        end
+      end
+
+      if address_list.addresses.empty? && address_list.group_names.empty?
+        raise Mail::Field::ParseError.new(Mail::AddressList, s, "Didn't find any addresses or groups")
+      end
+
+      address_list
+    end
+  end
+end

data/lib/mail/parsers/content_disposition_parser.rb

@@ -0,0 +1,67 @@
+module Mail::Parsers
+  class ContentDispositionParser
+    include Mail::Utilities
+
+    def parse(s)
+      content_disposition = ContentDispositionStruct.new("", nil)
+      if s.blank?
+        return content_disposition
+      end
+
+      actions, error = Ragel.parse(:content_disposition, s)
+      if error
+        raise Mail::Field::ParseError.new(Mail::ContentDispositionElement, s, error)
+      end
+
+      content_disposition.parameters = []
+
+      disp_type_s = param_attr_s = param_attr = qstr_s = qstr = param_val_s = nil
+      actions.each_slice(2) do |action_id, p|
+        action = Mail::Parsers::Ragel::ACTIONS[action_id]
+        case action
+
+        # Disposition Type
+        when :disp_type_s then disp_type_s = p
+        when :disp_type_e
+          content_disposition.disposition_type = s[disp_type_s..(p-1)].downcase
+
+        # Parameter Attribute
+        when :param_attr_s then param_attr_s = p
+        when :param_attr_e then param_attr = s[param_attr_s..(p-1)]
+
+        # Quoted String.
+        when :qstr_s then qstr_s = p
+        when :qstr_e then qstr = s[qstr_s..(p-1)]
+
+        # Parameter Value
+        when :param_val_s then param_val_s = p
+        when :param_val_e
+          if param_attr.nil?
+            raise Mail::Field::ParseError.new(Mail::ContentDispositionElement, s, "no attribute for value")
+          end
+
+          # Use quoted string value if one exists, otherwise use parameter value
+          if qstr
+            value = qstr
+          else
+            value = s[param_val_s..(p-1)]
+          end
+
+          content_disposition.parameters <<  { param_attr => value }
+          param_attr = nil
+          qstr = nil
+
+        else
+          raise Mail::Field::ParseError.new(Mail::ContentDispositionElement, s, "Failed to process unknown action: #{action}")
+        end
+      end
+
+      content_disposition
+    end
+
+    private
+    def cleaned(string)
+      string =~ /(.+);\s*$/ ? $1 : string
+    end
+  end
+end