mail 2.2.9.1 → 2.2.10

data/CHANGELOG.rdoc

@@ -1,3 +1,12 @@
+== Wed 17 Nov 2010 00:43:31 UTC Mikel Lindsaar <mikel@rubyx.com>
+
+* Added test retriever and updated documentation (Donald Ball)
+* Fix test suite to work in any timezone (Donald Ball)
+* Added dependency for tlsmail for Ruby 1.8.6 (Donald Ball)
+* Added new feature, replies for mail message
+* Fix references header to use CFWS instead of comma as the separator per RFC2822
+* Version Bum to 2.2.10 and pushed.
+
 == Mon Nov 15 13:04:41 UTC 2010 Mikel Lindsaar <mikel@rubyx.com>
 
 * Add find_and_delete convenience method for consistency with POP3, document delete_after_find option (Donald Ball)

data/lib/VERSION

@@ -1,4 +1,4 @@
-patch:9
+patch:10
 major:2
-build:1
+build:
 minor:2

data/lib/mail/configuration.rb

@@ -55,6 +55,8 @@ module Mail
         Mail::POP3
       when :imap
         Mail::IMAP
+      when :test
+        Mail::TestRetriever
       else
         method
       end

data/lib/mail/fields/common/common_message_id.rb

@@ -33,11 +33,11 @@ module Mail
     private
     
     def do_encode(field_name)
-      %Q{#{field_name}: #{message_ids.map { |m| "<#{m}>" }.join(', ')}\r\n}
+      %Q{#{field_name}: #{do_decode}\r\n}
     end
     
     def do_decode
-      "#{message_ids.map { |m| "<#{m}>" }.join(', ')}"
+      "#{message_ids.map { |m| "<#{m}>" }.join(' ')}"
     end
     
   end

data/lib/mail/fields/date_field.rb

@@ -34,7 +34,7 @@ module Mail
     def initialize(value = nil, charset = 'utf-8')
       self.charset = charset
       if value.blank?
-        value = Time.now.strftime('%a, %d %b %Y %H:%M:%S %z')
+        value = ::DateTime.now.strftime('%a, %d %b %Y %H:%M:%S %z')
       else
         value = strip_field(FIELD_NAME, value)
         value.to_s.gsub!(/\(.*?\)/, '')

data/lib/mail/fields/resent_date_field.rb

@@ -14,7 +14,7 @@ module Mail
     def initialize(value = nil, charset = 'utf-8')
       self.charset = charset
       if value.blank?
-        value = Time.now.strftime('%a, %d %b %Y %H:%M:%S %z')
+        value = ::DateTime.now.strftime('%a, %d %b %Y %H:%M:%S %z')
       else
         value = strip_field(FIELD_NAME, value)
         value = ::DateTime.parse(value.to_s).strftime('%a, %d %b %Y %H:%M:%S %z')

data/lib/mail/mail.rb

@@ -141,32 +141,32 @@ module Mail
     mail
   end
 
-  # Find emails in a POP3 server.
-  # See Mail::POP3 for a complete documentation.
+  # Find emails from the default retriever
+  # See Mail::Retriever for a complete documentation.
   def self.find(*args, &block)
     retriever_method.find(*args, &block)
   end
 
-  # Finds and then deletes retrieved emails from a POP3 server.
-  # See Mail::POP3 for a complete documentation.
+  # Finds and then deletes retrieved emails from the default retriever
+  # See Mail::Retriever for a complete documentation.
   def self.find_and_delete(*args, &block)
     retriever_method.find_and_delete(*args, &block)
   end
 
-  # Receive the first email(s) from a Pop3 server.
-  # See Mail::POP3 for a complete documentation.
+  # Receive the first email(s) from the default retriever
+  # See Mail::Retriever for a complete documentation.
   def self.first(*args, &block)
     retriever_method.first(*args, &block)
   end
 
-  # Receive the first email(s) from a Pop3 server.
-  # See Mail::POP3 for a complete documentation.
+  # Receive the first email(s) from the default retriever
+  # See Mail::Retriever for a complete documentation.
   def self.last(*args, &block)
     retriever_method.last(*args, &block)
   end
 
-  # Receive all emails from a POP3 server.
-  # See Mail::POP3 for a complete documentation.
+  # Receive all emails from the default retriever
+  # See Mail::Retriever for a complete documentation.
   def self.all(*args, &block)
     retriever_method.all(*args, &block)
   end
@@ -176,8 +176,8 @@ module Mail
     self.new(File.open(filename, 'rb') { |f| f.read })
   end
 
-  # Delete all emails from a POP3 server.
-  # See Mail::POP3 for a complete documentation.
+  # Delete all emails from the default retriever
+  # See Mail::Retriever for a complete documentation.
   def self.delete_all(*args, &block)
     retriever_method.delete_all(*args, &block)
   end

data/lib/mail/message.rb

@@ -253,6 +253,42 @@ module Mail
       end
     end
 
+    def reply(*args, &block)
+      self.class.new.tap do |reply|
+        if message_id
+          bracketed_message_id = "<#{message_id}>"
+          reply.in_reply_to = bracketed_message_id
+          if !references.nil?
+            reply.references = (references.to_a.map { |r| "<#{r}>" } << bracketed_message_id).join(' ')
+          elsif !in_reply_to.nil? && !in_reply_to.kind_of?(Array)
+            reply.references = "<#{in_reply_to}> #{bracketed_message_id}"
+          end
+          reply.references ||= bracketed_message_id
+        end
+        if subject
+          reply.subject = "RE: #{subject}"
+        end
+        if reply_to || from
+          reply.to = self[reply_to ? :reply_to : :from].to_s
+        end
+        if to
+          reply.from = self[:to].formatted.first.to_s
+        end
+
+        unless args.empty?
+          if args.flatten.first.respond_to?(:each_pair)
+            reply.send(:init_with_hash, args.flatten.first)
+          else
+            reply.send(:init_with_string, args.flatten[0].to_s.strip)
+          end
+        end
+
+        if block_given?
+          reply.instance_eval(&block)
+        end
+      end
+    end
+
     # Provides the operator needed for sort et al.
     #
     # Compares this mail object with another mail object, this is done by date, so an

data/lib/mail/network.rb

@@ -1,3 +1,5 @@
+require 'mail/network/retriever_methods/base'
+
 module Mail
   autoload :SMTP, 'mail/network/delivery_methods/smtp'
   autoload :FileDelivery, 'mail/network/delivery_methods/file_delivery'
@@ -6,4 +8,5 @@ module Mail
 
   autoload :POP3, 'mail/network/retriever_methods/pop3'
   autoload :IMAP, 'mail/network/retriever_methods/imap'
+  autoload :TestRetriever, 'mail/network/retriever_methods/test_retriever'
 end

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

@@ -0,0 +1,63 @@
+# encoding: utf-8
+
+module Mail
+
+  class Retriever
+
+    # Get the oldest received email(s)
+    #
+    # Possible options:
+    #   count: number of emails to retrieve. The default value is 1.
+    #   order: order of emails returned. Possible values are :asc or :desc. Default value is :asc.
+    #
+    def first(options = {}, &block)
+      options ||= {}
+      options[:what] = :first
+      options[:count] ||= 1
+      find(options, &block)
+    end
+    
+    # Get the most recent received email(s)
+    #
+    # Possible options:
+    #   count: number of emails to retrieve. The default value is 1.
+    #   order: order of emails returned. Possible values are :asc or :desc. Default value is :asc.
+    #
+    def last(options = {}, &block)
+      options ||= {}
+      options[:what] = :last
+      options[:count] ||= 1
+      find(options, &block)
+    end
+    
+    # Get all emails.
+    #
+    # Possible options:
+    #   order: order of emails returned. Possible values are :asc or :desc. Default value is :asc.
+    #
+    def all(options = {}, &block)
+      options ||= {}
+      options[:count] = :all
+      find(options, &block)
+    end
+
+    # Find emails in the mailbox, and then deletes them. Without any options, the 
+    # five last received emails are returned.
+    #
+    # Possible options:
+    #   what:  last or first emails. The default is :first.
+    #   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.
+    #   delete_after_find: flag for whether to delete each retreived email after find. Default
+    #           is true. Call #find if you would like this to default to false.
+    #
+    def find_and_delete(options = {}, &block)
+      options ||= {}
+      options[:delete_after_find] ||= true
+      find(options, &block)      
+    end 
+
+  end
+
+end

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

@@ -32,7 +32,7 @@ module Mail
   #   Mail.find(:what => :first, :count => 10, :order => :asc)
   #   #=> Returns the first 10 emails in ascending order
   #
-  class IMAP
+  class IMAP < Retriever
     require 'net/imap'
     
     def initialize(values)
@@ -46,54 +46,6 @@ module Mail
 
     attr_accessor :settings
 
-    # Get the oldest received email(s)
-    #
-    # Possible options:
-    #   mailbox: mailbox to retrieve the oldest received email(s) from. The default is 'INBOX'.
-    #   count:   number of emails to retrieve. The default value is 1.
-    #   order:   order of emails returned. Possible values are :asc or :desc. Default value is :asc.
-    #   keys:    keywords for the imap SEARCH command. Can be either a string holding the entire 
-    #            search string or a single-dimension array of search keywords and arguments.
-    #
-    def first(options={}, &block)
-      options ||= {}
-      options[:what] = :first
-      options[:count] ||= 1
-      find(options, &block)
-    end
-
-    # Get the most recent received email(s)
-    #
-    # Possible options:
-    #   mailbox: mailbox to retrieve the most recent received email(s) from. The default is 'INBOX'.
-    #   count:   number of emails to retrieve. The default value is 1.
-    #   order:   order of emails returned. Possible values are :asc or :desc. Default value is :asc.
-    #   keys:    keywords for the imap SEARCH command. Can be either a string holding the entire 
-    #            search string or a single-dimension array of search keywords and arguments.
-    #
-    def last(options={}, &block)
-      options ||= {}
-      options[:what] = :last
-      options[:count] ||= 1
-      find(options, &block)
-    end
-
-    # Get all emails.
-    #
-    # Possible options:
-    #   mailbox: mailbox to retrieve all email(s) from. The default is 'INBOX'.
-    #   count:   number of emails to retrieve. The default value is 1.
-    #   order:   order of emails returned. Possible values are :asc or :desc. Default value is :asc.
-    #   keys:    keywords for the imap SEARCH command. Can be either a string holding the entire 
-    #            search string or a single-dimension array of search keywords and arguments.
-    #
-    def all(options={}, &block)
-      options ||= {}
-      options[:count] = :all
-      options[:keys]  = 'ALL'
-      find(options, &block)
-    end
-    
     # Find emails in a IMAP mailbox. Without any options, the 10 last received emails are returned.
     #
     # Possible options:
@@ -139,23 +91,6 @@ module Mail
       end
     end
 
-    # Find emails in a IMAP mailbox, and then deletes them. Without any options, the 
-    # five last received emails are returned.
-    #
-    # Possible options:
-    #   what:  last or first emails. The default is :first.
-    #   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.
-    #   delete_after_find: flag for whether to delete each retreived email after find. Default
-    #           is true. Use #find_and_delete if you would like this to default to false.
-    #
-    def find_and_delete(options = {}, &block)
-      options ||= {}
-      options[:delete_after_find] ||= true
-      find(options, &block)      
-    end 
-
     # Delete all emails from a IMAP mailbox
     def delete_all(mailbox='INBOX')
       mailbox ||= 'INBOX'

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

@@ -31,7 +31,7 @@ module Mail
   #   Mail.find(:what => :first, :count => 10, :order => :asc)
   #   #=> Returns the first 10 emails in ascending order
   # 
-  class POP3
+  class POP3 < Retriever
     require 'net/pop'
 
     def initialize(values)
@@ -45,43 +45,6 @@ module Mail
     
     attr_accessor :settings
     
-    # Get the oldest received email(s)
-    #
-    # Possible options:
-    #   count: number of emails to retrieve. The default value is 1.
-    #   order: order of emails returned. Possible values are :asc or :desc. Default value is :asc.
-    #
-    def first(options = {}, &block)
-      options ||= {}
-      options[:what] = :first
-      options[:count] ||= 1
-      find(options, &block)
-    end
-    
-    # Get the most recent received email(s)
-    #
-    # Possible options:
-    #   count: number of emails to retrieve. The default value is 1.
-    #   order: order of emails returned. Possible values are :asc or :desc. Default value is :asc.
-    #
-    def last(options = {}, &block)
-      options ||= {}
-      options[:what] = :last
-      options[:count] ||= 1
-      find(options, &block)
-    end
-    
-    # Get all emails.
-    #
-    # Possible options:
-    #   order: order of emails returned. Possible values are :asc or :desc. Default value is :asc.
-    #
-    def all(options = {}, &block)
-      options ||= {}
-      options[:count] = :all
-      find(options, &block)
-    end
-    
     # Find emails in a POP3 mailbox. Without any options, the 5 last received emails are returned.
     #
     # Possible options:
@@ -125,23 +88,6 @@ module Mail
       end
     end
     
-    # Find emails in a POP3 mailbox, and then deletes them. Without any options, the 
-    # five last received emails are returned.
-    #
-    # Possible options:
-    #   what:  last or first emails. The default is :first.
-    #   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.
-    #   delete_after_find: flag for whether to delete each retreived email after find. Default
-    #           is true. Call #find if you would like this to default to false.
-    #
-    def find_and_delete(options = {}, &block)
-      options ||= {}
-      options[:delete_after_find] ||= true
-      find(options, &block)      
-    end 
-    
     # Delete all emails from a POP3 server   
     def delete_all
       start do |pop3|

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

@@ -0,0 +1,40 @@
+# encoding: utf-8
+
+module Mail
+
+  class TestRetriever < Retriever
+    cattr_accessor :emails
+
+    def initialize(values)
+      @@emails = []
+    end
+
+    def find(options = {}, &block)
+      options[:count] ||= :all
+      options[:order] ||= :asc
+      options[:what] ||= :first
+      emails = @@emails.dup
+      emails.reverse! if options[:what] == :last
+      emails = case count = options[:count]
+        when :all then emails
+        when 1 then emails.first
+        when Fixnum then emails[0, count]
+        else
+          raise 'Invalid count option value: ' + count.inspect
+      end
+      if options[:what] == :last && options[:order] == :asc || options[:what] == :first && options[:order] == :desc
+        emails.reverse!
+      end
+      emails.each { |email| email.mark_for_delete = true } if options[:delete_after_find]
+      if block_given?
+        emails.each { |email| yield email }
+      else
+        emails
+      end.tap do |results|
+        emails.each { |email| @@emails.delete(email) if email.is_marked_for_delete? } if options[:delete_after_find]
+      end
+    end
+
+  end
+
+end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mail
 version: !ruby/object:Gem::Version 
-  hash: 89
+  hash: 19
   prerelease: false
   segments: 
   - 2
   - 2
-  - 9
-  - 1
-  version: 2.2.9.1
+  - 10
+  version: 2.2.10
 platform: ruby
 authors: 
 - Mikel Lindsaar
@@ -16,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-16 00:00:00 +11:00
+date: 2010-11-17 00:00:00 +11:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -72,7 +71,7 @@ dependencies:
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
         hash: 13
         segments: 
@@ -170,8 +169,10 @@ files:
 - lib/mail/network/delivery_methods/sendmail.rb
 - lib/mail/network/delivery_methods/smtp.rb
 - lib/mail/network/delivery_methods/test_mailer.rb
+- lib/mail/network/retriever_methods/base.rb
 - lib/mail/network/retriever_methods/imap.rb
 - lib/mail/network/retriever_methods/pop3.rb
+- lib/mail/network/retriever_methods/test_retriever.rb
 - lib/mail/network.rb
 - lib/mail/parsers/address_lists.rb
 - lib/mail/parsers/address_lists.treetop