mail 1.6.0 → 2.0.3

data/CHANGELOG.rdoc

@@ -1,3 +1,40 @@
+== Sat Jan 23 05:32:53 UTC 2010 Mikel Lindsaar <raasdnil@gmail.com>
+
+* Version bump to 2.0.3
+* Made body.sort_parts! recursive, to do the entire body
+* Added ability to use << on the results returned by the various address fields, ie, mail.to << 'new@address' now works
+* Message now adds multipart/mixed as the content type if nothing is set and there are parts to the message
+* Added #display_names and #addrs to all address fields.  #addrs returns the actual Mail::Address object for each address in the field.
+* Body should call to_s on given input... incase someone gave it an IO.readlines result (Array)
+* 
+
+== Thu Jan 21 05:27:17 UTC 2010 Mikel Lindsaar <raasdnil@gmail.com>
+
+* Version bump to 2.0.2
+* Major change to attachments, add_file now only accepts
+  {:filename => 'full/path/to/file.png'} or 
+  {:filename => 'file.png', :content => 'string of file content'}
+  you can also now do mail.attachments['filename.png'] = File.read('path/to/file.png')
+  which is nice too!
+
+== Fri Jan 15 09:20:51 UTC 2010 Mikel Lindsaar <raasdnil@gmail.com>
+
+* Rewrote all network classes to not use singletons.  Means different Mail::Message objects can have different delivery methods.
+* Added examples for how to send via GMail, MobileMe, Sendmail, File etc.
+* Version bump to 2.0.0 as Network API changed drastically, now not a singleton class.
+* Fixed that return-path should only return one address
+
+== Thu Jan 14 10:41:22 UTC 2010 Mikel Lindsaar <raasdnil@gmail.com>
+
+* Version update to 1.6.0 - API change on mail.address_fields to always return arrays
+* Updated all message.address_field methods to always return arrays, so mail.from #=> ['one@address.com'] now, is least surprise
+* Updated handling of empty group lists so it didn't crash
+
+== Thu Jan 12 10:41:47 UTC 2010 Mikel Lindsaar <raasdnil@gmail.com>
+
+* Version 1.5.3, handling invalid input on fields.  Highly recommended update
+* Updated fields to always try parsing the given data (unless blank). This allows mail to catch invalid input and return UnstructuredFields. Makes mail a lot more resistant to invalid input.
+
 == Fri  8 Jan 2010 00:00:08 UTC Mikel Lindsaar <raasdnil@gmail.com>
 
 * Version bump to 1.5.2

data/README.rdoc

@@ -230,7 +230,7 @@ what you are doing.
          to 'you@test.lindsaar.net'
     subject 'Here is the image you wanted'
        body File.read('body.txt')
-   add_file '/somefile.png'
+   add_file '/full/path/to/somefile.png'
  end
 
 or
@@ -244,11 +244,12 @@ or
          to 'you@test.lindsaar.net'
     subject 'Here is the image you wanted'
        body File.read('body.txt')
-   add_file {:filename => 'somefile.png', :data => File.read('/somefile.png')}
+   add_file {:filename => 'somefile.png', :content => File.read('/somefile.png')}
  end
  
  mail.deliver!
 
+
 === Getting emails from a pop server:
 
 The most recent email:
@@ -451,7 +452,7 @@ You can just read the file off an absolute path, Mail will try
 to guess the mime_type and will encode the file in Base64 for you.
   
   @mail = Mail.new
-  @mail.add_file(:filename => "/path/to/file.jpg")
+  @mail.add_file("/path/to/file.jpg")
   @mail.parts.first.attachment? #=> true
   @mail.parts.first.content_transfer_encoding.to_s #=> 'base64'
   @mail.attachments.first.mime_type #=> 'image/jpg'
@@ -462,8 +463,7 @@ Or You can pass in file_data and give it a filename, again, mail
 will try and guess the mime_type for you.
   
   @mail = Mail.new
-  file_data = File.read('path/to/myfile.pdf')
-  @mail.add_file(:filename => 'myfile.pdf', :data => file_data)
+  @mail.attachments['myfile.pdf'] = File.read('path/to/myfile.pdf')
   @mail.parts.first.attachment? #=> true
   @mail.attachments.first.mime_type #=> 'application/pdf'
   @mail.attachments.first.decoded == File.read('path/to/myfile.pdf') #=> true
@@ -473,9 +473,8 @@ than mail (this should be rarely needed)
 
   @mail = Mail.new
   file_data = File.read('path/to/myfile.pdf')
-  @mail.add_file(:filename => 'myfile.pdf', 
-                 :data => file_data,
-                 :mime_type => 'application/x-pdf')
+  @mail.attachments['myfile.pdf'] = { :mime_type => 'application/x-pdf',
+                                      :content => File.read('path/to/myfile.pdf') }
   @mail.parts.first.mime_type #=> 'application/x-pdf'
 
 Of course... Mail will round trip an attachment as well
@@ -491,7 +490,7 @@ Of course... Mail will round trip an attachment as well
       content_type 'text/html; charset=UTF-8'
       body '<h1>Funky Title</h1><p>Here is the attachment you wanted</p>'
     end
-    add_file :filename => '/path/to/myfile.pdf'
+    add_file '/path/to/myfile.pdf'
   end
 
   @round_tripped_mail = Mail.new(@mail.encoded)
@@ -507,7 +506,7 @@ sending emails, the TestMailer can do this for you.
   require 'mail'
   => true
   Mail.defaults do
-    delivery_method(:test)
+    delivery_method :test
   end
   => #<Mail::Configuration:0x19345a8 @delivery_method=Mail::TestMailer>
   Mail.deliveries

data/Rakefile

@@ -12,7 +12,7 @@ require 'bundler'
 
 spec = Gem::Specification.new do |s|
   s.name        = "mail"
-  s.version     = "1.6.0"
+  s.version     = "2.0.3"
   s.author      = "Mike Lindsaar"
   s.email       = "raasdnil@gmail.com"
   s.homepage    = "http://github.com/mikel/mail"

data/lib/mail.rb

@@ -46,24 +46,24 @@ module Mail # :doc:
   require 'mail/patterns'
   require 'mail/utilities'
   require 'mail/configuration'
-  require 'mail/network/deliverable'
   require 'mail/network/delivery_methods/smtp'
   require 'mail/network/delivery_methods/file_delivery'
   require 'mail/network/delivery_methods/sendmail'
   require 'mail/network/delivery_methods/test_mailer'
-  require 'mail/network/retrievable'
   require 'mail/network/retriever_methods/pop3'
   require 'mail/network/retriever_methods/imap'
 
   require 'mail/message'
   require 'mail/part'
   require 'mail/header'
+  require 'mail/parts_list'
+  require 'mail/attachments_list'
   require 'mail/body'
   require 'mail/field'
   require 'mail/field_list'
-  require 'mail/attachment'
 
   # Load in all common header fields modules
+  require 'mail/fields/common/address_container'
   require 'mail/fields/common/common_address'
   require 'mail/fields/common/common_date'
   require 'mail/fields/common/common_field'

data/lib/mail/attachments_list.rb

@@ -0,0 +1,76 @@
+module Mail
+  class AttachmentsList < Array
+    
+    def initialize(parts_list)
+      @parts_list = parts_list
+      parts_list.map { |p|
+        if p.parts.empty?
+          p if p.attachment?
+        else
+          p.attachments
+        end
+      }.flatten.compact.each { |a| self << a }
+      self
+    end
+    
+    # Returns the attachment by filename or at index.
+    # 
+    # mail.attachments['test.png'] = File.read('test.png')
+    # mail.attachments['test.jpg'] = File.read('test.jpg')
+    # 
+    # mail.attachments['test.png'].filename #=> 'test.png'
+    # mail.attachments[1].filename          #=> 'test.jpg'
+    def [](index_value)
+      if index_value.is_a?(Fixnum)
+        self.fetch(index_value)
+      else
+        self.select { |a| a.filename == index_value }.first
+      end
+    end
+
+    def []=(name, value)
+      default_values = { :content_type => "#{set_mime_type(name)}; filename=\"#{name}\"",
+                         :content_transfer_encoding => 'Base64',
+                         :content_disposition => "attachment; filename=\"#{name}\"" }
+
+      if value.is_a?(Hash)
+
+        default_values[:body] = value.delete(:content) if value[:content]
+
+        default_values[:body] = value.delete(:data) if value[:data]
+
+        # Only force encode base64 if the user has not specified an encoding
+        if value[:transfer_encoding]
+          default_values[:content_transfer_encoding] = value.delete(:transfer_encoding)
+        elsif value[:encoding]
+          default_values[:content_transfer_encoding] = value.delete(:encoding)
+        else
+          default_values[:body] = Mail::Encodings::Base64.encode(default_values[:body])
+        end
+
+        if value[:mime_type]
+          default_values[:content_type] = value.delete(:mime_type)
+        end
+
+        hash = default_values.merge(value)
+      else
+        default_values[:body] = Mail::Encodings::Base64.encode(value)
+        hash = default_values
+      end
+
+      @parts_list << Part.new(hash)
+    end
+    
+    def set_mime_type(filename)
+      # Have to do this because MIME::Types is not Ruby 1.9 safe yet
+      if RUBY_VERSION >= '1.9'
+        new_file = String.new(filename).force_encoding(Encoding::BINARY)
+        ext = new_file.split('.'.force_encoding(Encoding::BINARY)).last
+        filename = "file.#{ext}".force_encoding('US-ASCII')
+      end
+      @mime_type = MIME::Types.type_for(filename).first
+    end
+    
+  end
+end
+

data/lib/mail/body.rb

@@ -31,11 +31,18 @@ module Mail
       @preamble = nil
       @epilogue = nil
       @part_sort_order = [ "text/plain", "text/enriched", "text/html" ]
-      @parts = []
+      @parts = Mail::PartsList.new
       if string.blank?
         @raw_source = ''
       else
-        @raw_source = string
+        # Do join first incase we have been given an Array in Ruby 1.9
+        if string.respond_to?(:join)
+          @raw_source = string.join('')
+        elsif string.respond_to?(:to_s)
+          @raw_source = string.to_s
+        else
+          raise "You can only assign a string or an object that responds_to? :join or :to_s to a body."
+        end
       end
       @encoding = nil
       set_charset
@@ -103,15 +110,12 @@ module Mail
     #
     # sort_parts! is also called from :encode, so there is no need for you to call this explicitly
     def sort_parts!
-      order = @part_sort_order
-      @parts = @parts.sort do |a, b|
-        # OK, 10000 is arbitrary... if anyone actually wants to explicitly sort 10000 parts of a
-        # single email message... please show me a use case and I'll put more work into this method,
-        # in the meantime, it works :)
-        a_order = order.index(a[:content_type].string.downcase) || 10000
-        b_order = order.index(b[:content_type].string.downcase) || 10000
-        a_order <=> b_order
+      @parts.each do |p|
+        p.body.set_sort_order(@part_sort_order)
+        @parts.sort!(@part_sort_order)
+        p.body.sort_parts!
       end
+#      @parts.sort!(@part_sort_order)
     end
     
     # Returns the raw source that the body was initialized with, without
@@ -144,10 +148,6 @@ module Mail
       decoded
     end
     
-    def to_str
-      to_s
-    end
-    
     def charset
       @charset
     end
@@ -207,7 +207,7 @@ module Mail
       if @parts
         @parts << val
       else
-        @parts = [val]
+        @parts = Mail::PartsList.new[val]
       end
     end
     
@@ -218,7 +218,7 @@ module Mail
       self.preamble = parts[0].to_s.strip
       # Make the epilogue equal to the epilogue (if any)
       self.epilogue = parts[-1].to_s.sub('--', '').strip
-      @parts = parts[1...-1].to_a.map { |part| Mail::Part.new(part) }
+      parts[1...-1].to_a.each { |part| @parts << Mail::Part.new(part) }
       self
     end
     

data/lib/mail/configuration.rb

@@ -7,134 +7,58 @@ require 'singleton'
 module Mail
   
   # The Configuration class is a Singleton used to hold the default
-  # configuration for all class wide configurations of Mail.
+  # configuration for all Mail objects.
   # 
-  # This includes things like running in Test mode, the POP3, IMAP,
-  # SMTP, Sendmail and File delivery method information et al.
-  # 
-  # See Mail.defaults for more information.
+  # Each new mail object gets a copy of these values at initialization
+  # which can be overwritten on a per mail object basis.
   class Configuration
     include Singleton
     
-    # Creates a new Mail::Configuration object through .defaults
-    def defaults(&block)
-      if block_given?
-        instance_eval(&block)
-      end
-      self
-    end
-    
-    # Allows you to specify the SMTP Server by passing the hostname
-    # or IP Address as a String with an optional port number as a
-    # string or integer.
-    # 
-    # Defaults to 127.0.0.1 and port 25.
-    # 
-    # Example:
-    # 
-    #  Mail.defaults.do
-    #    smtp '127.0.0.1'
-    #  end
-    # 
-    #  Mail.defaults do
-    #    smtp '127.0.0.1', 25
-    #  end
-    def smtp(*args, &block)
-      if args.size > 0
-        host_array = [args[0], (args[1].to_i > 0 ? args[1] : 25)]
-      end
-      set_settings(Mail::SMTP, host_array, &block)
-    end
+    @delivery_method  = nil
+    @retriever_method = nil
 
-    # Allows you to define the delivery method for mail, defaults to SMTP
-    # 
-    # This can either be a symbol (:smtp, :sendmail, :file, :test) or you can pass
-    # in your own delivery class, in which case this will be set.
-    def delivery_method(value = nil)
-      value ? @delivery_method = lookup_delivery_method(value) : @delivery_method ||= Mail::SMTP
+    def delivery_method(method = nil, settings = {})
+      return @delivery_method if @delivery_method && method.nil?
+      @delivery_method = lookup_delivery_method(method).new(settings)
     end
-    
-    # Allows you to specify the POP3 Server by passing the hostname
-    # or IP Address as a String with an optional port number as a
-    # string or integer.
-    # 
-    # Defaults to 127.0.0.1 and port 110.
-    # 
-    # Example:
-    # 
-    #  Mail.defaults.do
-    #    pop3 '127.0.0.1'
-    #  end
-    # 
-    #  Mail.defaults do
-    #    pop3 '127.0.0.1', 995 do
-    #      enable_tls
-    #    end
-    #  end
-    def pop3(*args, &block)
-      if args.size > 0
-        host_array = [args[0], (args[1].to_i > 0 ? args[1] : 110)]
+
+    def lookup_delivery_method(method)
+      case method
+      when nil
+        Mail::SMTP
+      when :smtp
+        Mail::SMTP
+      when :sendmail
+        Mail::Sendmail
+      when :file
+        Mail::FileDelivery
+      when :test
+        Mail::TestMailer
+      else
+        method
       end
-      set_settings(Mail::POP3, host_array, &block)
     end
 
-    def sendmail(sendmail_path = nil)
-      delivery_method :sendmail
-      set_settings(Mail::Sendmail) do
-        path sendmail_path
-      end
+    def retriever_method(method = nil, settings = {})
+      return @retriever_method if @retriever_method && method.nil?
+      @retriever_method = lookup_retriever_method(method).new(settings)
     end
     
-    # Allows you to define the retriever method for mail, defaults to POP3
-    # 
-    # This can either be a symbol (:pop3, :imap) or you can pass
-    # in your own retriever class, in which case this will be set.
-    def retriever_method(value = nil)
-      value ? @retriever_method = lookup_retriever_method(value) : @retriever_method ||= Mail::POP3
+    def lookup_retriever_method(method)
+      case method
+      when nil
+        Mail::POP3
+      when :pop3
+        Mail::POP3
+      else
+        method
+      end
     end
 
     def param_encode_language(value = nil)
       value ? @encode_language = value : @encode_language ||= 'en'
     end
-    
-    private
-    
-    def set_settings(klass, host_array = nil, &block)
-      if host_array
-        klass.instance.settings do
-          host host_array[0]
-          port host_array[1]
-        end
-      end
-      klass.instance.settings(&block)
-    end
-
-     def lookup_delivery_method(method)
-       case method
-       when :smtp || nil
-         Mail::SMTP
-       when :sendmail
-         Mail::Sendmail
-       when :file
-         Mail::FileDelivery
-       when :test
-         Mail::TestMailer
-       else
-         method
-       end
-     end
 
-     def lookup_retriever_method(method)
-       case method
-       when :pop3 || nil
-         Mail::POP3
- #      when :imap
- #        Mail::IMAP
-       else
-         method
-       end
-     end
- 
   end
 
 end