mail 1.2.6 → 1.2.8

data/CHANGELOG.rdoc

@@ -1,3 +1,24 @@
+== Sun Nov 22 12:19:44 UTC 2009 Mikel Lindsaar <raasdnil@gmail.com>
+
+* Added check on add_part to make sure if there is already a body, and if so, make a text_part of the body
+* Fixing up attachment adding and making sure multipart emails always have boundaries
+* Change Message#attachments to now recursively return all attachments in the email in an ordered flattened array
+* Added ability for Mail::Message to accept {:headers => {'custom-header' => 'value', 'another-custom-header' => 'value'}} as a param on init
+* Adding ability to Mail::Message to add a part via :part(params) with optional block
+* Fixed up QP encoding forcing underscores into everything with a space
+* Added ReturnPathField#address
+* Updating gem loads and active support loads
+
+== Sat Nov 21 12:52:46 UTC 2009 Mikel Lindsaar <raasdnil@gmail.com>
+
+* Changed Mail::Encodings to clean it up, added in unquote_and_convert_to as well as refactor in this area
+
+== Thu Nov 19 04:16:10 UTC 2009 Mikel Lindsaar <raasdnil@gmail.com>
+
+* Added sendmail support from (Simon Rozet)
+* Changed to bundler for gem dependancies and moved gem generation into rakefile (Simon Rozet)
+* Bumped to 1.2.6 for sendmail support
+
 == Wed Nov 18 04:26:21 UTC 2009 Mikel Lindsaar <raasdnil@gmail.com>
 
 * Changed Encodings.param_encode(string) so it intelligently encodes and quotes needed

data/Rakefile

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

data/lib/mail.rb

@@ -3,10 +3,16 @@ module Mail # :doc:
 
   require 'date'
   
-  gem "treetop", ">= 1.4"
   require 'treetop'
-  gem 'activesupport', ">= 2.3"
-  require 'activesupport'
+  require 'active_support'
+  require 'active_support'
+  
+  # Have to handle ActiveSupport 2.3 and 3.0
+  # Following two lines make sure that HashWithIndifferentAccess is available
+  # regardless of having activesupport 3 or 2.3 loaded
+  require 'active_support/core_ext/hash/indifferent_access'
+  HashWithIndifferentAccess 
+  
   require 'uri'
   require 'net/smtp'
   require 'mime/types'

data/lib/mail/attachment.rb

@@ -36,7 +36,7 @@ module Mail
     def initialize(options_hash)
       case
       when options_hash[:data]
-        @filename = options_hash[:filename]
+        @filename = File.basename(options_hash[:filename])
         add_file(options_hash[:data], options_hash[:encoding])
       when options_hash[:filename]
         @filename = File.basename(options_hash[:filename])
@@ -64,6 +64,8 @@ module Mail
       end
     end
     
+    alias :read :decoded
+    
     def mime_type
       @mime_type.to_s
     end

data/lib/mail/body.rb

@@ -48,7 +48,7 @@ module Mail
         encoded_parts = parts.map { |p| p.to_s }
         ([preamble] + encoded_parts).join(crlf_boundary) + end_boundary + epilogue.to_s
       else
-        raw_source
+        raw_source.to_crlf
       end
     end
     
@@ -56,7 +56,11 @@ module Mail
     
     # Returns the raw source right now.  Need to implement
     def decoded
-      raw_source
+      if encoding.nil? || !Encodings.defined?(encoding)
+        raw_source.to_lf
+      else
+        Encodings.get_encoding(encoding).decode(raw_source)
+      end
     end
     
     def charset

data/lib/mail/encodings/encodings.rb

@@ -88,18 +88,49 @@ module Mail
     # Decodes a given string as Base64 or Quoted Printable, depending on what
     # type it is.
     # 
-    # 
+    # String has to be of the format =?<encoding>?[QB]?<string>?=
     def Encodings.value_decode(str)
-      case
-      when str =~ /\=\?.+?\?B\?.+?\?\=/
-        Encodings.b_value_decode(str)
-      when str =~ /\=\?.+?\?Q\?.+?\?\=/
-        Encodings.q_value_decode(str)
-      else
-        str
+      str.gsub!(/\?=(\s*)=\?/, '?==?') # Remove whitespaces between 'encoded-word's
+      str.gsub(/(.*?)(=\?.*?\?.\?.*?\?=)|$/) do
+        before = $1.to_s
+        text = $2.to_s
+        
+        case
+        when text =~ /=\?.+\?[Bb]\?/
+          before + b_value_decode(text)
+        when text =~ /=\?.+\?[Qq]\?/
+          before + q_value_decode(text)
+        else
+          before + text
+        end
       end
     end
+    
+    # Takes an encoded string of the format =?<encoding>?[QB]?<string>?=
+    def Encodings.unquote_and_convert_to(str, to_encoding)
+      original_encoding, string = split_encoding_from_string( str )
+
+      output = value_decode( str ).to_s
 
+      if original_encoding.to_s.downcase.gsub("-", "") == to_encoding.to_s.downcase.gsub("-", "")
+        output
+      elsif original_encoding && to_encoding
+        begin
+          Iconv.iconv(to_encoding, original_encoding, output).first
+        rescue Iconv::IllegalSequence, Iconv::InvalidEncoding, Errno::EINVAL
+          # the 'from' parameter specifies a charset other than what the text
+          # actually is...not much we can do in this case but just return the
+          # unconverted text.
+          #
+          # Ditto if either parameter represents an unknown charset, like
+          # X-UNKNOWN.
+          output
+        end
+      else
+        output
+      end
+    end
+    
     # Encode a string with Base64 Encoding and returns it ready to be inserted
     # as a value for a field, that is, in the =?<charset>?B?<string>?= format
     #
@@ -114,19 +145,6 @@ module Mail
       end.join(" ")
     end
     
-    # Decodes a Base64 string from the "=?UTF-8?B?VGhpcyBpcyDjgYIgc3RyaW5n?=" format
-    # 
-    # Example:
-    # 
-    #  Encodings.b_value_encode("=?UTF-8?B?VGhpcyBpcyDjgYIgc3RyaW5n?=") 
-    #  #=> 'This is あ string'
-    def Encodings.b_value_decode(str)
-      string = str.split(Mail::Patterns::WSP)
-      string.flatten.map do |s|
-        RubyVer.b_value_decode(s)
-      end.join('')
-    end
-    
     # Encode a string with Quoted-Printable Encoding and returns it ready to be inserted
     # as a value for a field, that is, in the =?<charset>?Q?<string>?= format
     #
@@ -136,7 +154,19 @@ module Mail
     #  #=> "=?UTF-8?Q?This_is_=E3=81=82_string?="
     def Encodings.q_value_encode(str, encoding = nil)
       string, encoding = RubyVer.q_value_encode(str, encoding)
-      "=?#{encoding}?Q?#{string.chomp}?="
+      "=?#{encoding}?Q?#{string.chomp.gsub(/ /, '_')}?="
+    end
+    
+    private
+    
+    # Decodes a Base64 string from the "=?UTF-8?B?VGhpcyBpcyDjgYIgc3RyaW5n?=" format
+    # 
+    # Example:
+    # 
+    #  Encodings.b_value_encode("=?UTF-8?B?VGhpcyBpcyDjgYIgc3RyaW5n?=") 
+    #  #=> 'This is あ string'
+    def Encodings.b_value_decode(str)
+      RubyVer.b_value_decode(str)
     end
     
     # Decodes a Quoted-Printable string from the "=?UTF-8?Q?This_is_=E3=81=82_string?=" format
@@ -146,13 +176,17 @@ module Mail
     #  Encodings.b_value_encode("=?UTF-8?Q?This_is_=E3=81=82_string?=") 
     #  #=> 'This is あ string'
     def Encodings.q_value_decode(str)
-      string = str.split(Mail::Patterns::WSP)
-      string.flatten.map do |s|
-        RubyVer.q_value_decode(s)
-      end.join('')
+      RubyVer.q_value_decode(str).gsub(/_/, ' ')
     end
     
-    private
+    def Encodings.split_encoding_from_string( str )
+      match = str.match(/\=\?(.+)?\?[QB]\?(.+)?\?\=/i)
+      if match
+        [match[1], match[2]]
+      else
+        nil
+      end
+    end
     
     def Encodings.find_encoding(str)
       RUBY_VERSION >= '1.9' ? str.encoding : $KCODE

data/lib/mail/encodings/quoted_printable.rb

@@ -5,11 +5,11 @@ module Mail
     
       # Decode the string from Quoted-Printable
       def self.decode(str)
-        str.unpack("M*").first.gsub('_', ' ')
+        str.unpack("M*").first
       end
 
       def self.encode(str)
-        str.gsub( /[^a-z ]/i ) { quoted_printable_encode($&) }.gsub( / /, "_" )
+        str.gsub( /[^a-z ]/i ) { quoted_printable_encode($&) }
       end
 
       private

data/lib/mail/fields/bcc_field.rb

@@ -37,8 +37,9 @@ module Mail
       super(CAPITALIZED_FIELD, strip_field(FIELD_NAME, args.last))
     end
     
+    # Bcc field should never be :encoded
     def encoded
-      do_encode(CAPITALIZED_FIELD)
+      ''
     end
     
     def decoded

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

@@ -6,9 +6,7 @@ module Mail
   # have the name*0="blah", name*1="bleh" keys, and will just return
   # a single key called name="blahbleh" and do any required un-encoding
   # to make that happen
-  class ParameterHash < Hash
-
-    include Enumerable
+  class ParameterHash < HashWithIndifferentAccess
 
     def [](key_name)
       pairs = select { |k,v| k =~ /^#{key_name}\*/ }

data/lib/mail/fields/content_type_field.rb

@@ -41,10 +41,12 @@ module Mail
       @sub_type ||= element.sub_type
     end
     
-    def content_type
+    def string
       "#{main_type}/#{sub_type}"
     end
     
+    alias :content_type :string
+    
     def parameters
       unless @parameters
         @parameters = ParameterHash.new

data/lib/mail/fields/return_path_field.rb

@@ -22,7 +22,7 @@
 module Mail
   class ReturnPathField < StructuredField
     
-    include CommonAddress
+    include Mail::CommonAddress
     
     FIELD_NAME = 'return-path'
     CAPITALIZED_FIELD = 'Return-Path'
@@ -39,5 +39,9 @@ module Mail
       do_decode
     end
     
+    def address
+      addresses.first
+    end
+    
   end
 end

data/lib/mail/message.rb

@@ -149,6 +149,13 @@ module Mail
       value ? self.header = value : @header
     end
     
+    # Provides a way to set custom headers, by passing in a hash
+    def headers(hash = {})
+      hash.each_pair do |k,v|
+        header[k] = v
+      end
+    end
+    
     # Sets the body object of the message object.
     # 
     # Example:
@@ -183,6 +190,7 @@ module Mail
       else
         @body = Mail::Body.new(value)
       end
+      add_encoding_to_body
     end
 
     # Returns the body of the message object. Or, if passed
@@ -196,7 +204,12 @@ module Mail
     #  mail.body 'This is another body'
     #  mail.body #=> #<Mail::Body:0x13919c @raw_source="This is anothe...
     def body(value = nil)
-      value ? self.body = value : @body
+      if value
+        self.body = value
+        add_encoding_to_body
+      else
+        @body
+      end
     end
     
     # Sets the to filed of the message header.
@@ -261,6 +274,30 @@ module Mail
     def destinations
       [to, cc, bcc].map { |f| f.addresses if f }.compact.flatten
     end
+
+    # Returns an array of addresses (the encoded value) in the From field,
+    # if no From field, returns an empty array
+    def from_addrs
+      from ? from.formatted.compact.flatten : []
+    end
+    
+    # Returns an array of addresses (the encoded value) in the To field,
+    # if no To field, returns an empty array
+    def to_addrs
+      to ? to.formatted.compact.flatten : []
+    end
+    
+    # Returns an array of addresses (the encoded value) in the Cc field,
+    # if no Cc field, returns an empty array
+    def cc_addrs
+      cc ? cc.formatted.compact.flatten : []
+    end
+    
+    # Returns an array of addresses (the encoded value) in the Bcc field,
+    # if no Bcc field, returns an empty array
+    def bcc_addrs
+      bcc ? bcc.formatted.compact.flatten : []
+    end
     
     # Sets the subject field in the message header.
     # 
@@ -295,6 +332,8 @@ module Mail
     def []=(name, value)
       if name.to_s == 'body'
         self.body = value
+      elsif name.to_s =~ /content[-_]type/i
+        header[underscoreize(name)] = value
       else
         header[underscoreize(name)] = value
       end
@@ -477,6 +516,16 @@ module Mail
     def charset
       content_type ? content_type.parameters['charset'] : nil
     end
+
+    # Sets the charset to the supplied value.  Will set the content type to text/plain if
+    # it does not already exist
+    def charset=(value)
+      if content_type
+        content_type.parameters['charset'] = value
+      else
+        self.content_type ['text', 'plain', {'charset' => value}]
+      end
+    end
     
     # Returns the main content type
     def main_type
@@ -551,10 +600,17 @@ module Mail
       body.parts
     end
     
+    # Returns an array of attachments in the email recursively
     def attachments
-      body.parts.select { |p| p.attachment? }.map { |p| p.attachment }
+      body.parts.map do |p| 
+        if p.parts.empty?
+          p.attachment if p.attachment?
+        else
+          p.attachments
+        end
+      end.compact.flatten
     end
-    
+
     def has_attachments?
       !attachments.empty?
     end
@@ -563,6 +619,7 @@ module Mail
     def html_part(&block)
       if block_given?
         @html_part = Mail::Part.new(&block)
+        add_multipart_alternate_header
         add_part(@html_part)
       else
         @html_part
@@ -573,6 +630,7 @@ module Mail
     def text_part(&block)
       if block_given?
         @text_part = Mail::Part.new(&block)
+        add_multipart_alternate_header
         add_part(@text_part)
       else
         @text_part
@@ -588,6 +646,7 @@ module Mail
       else
         @html_part = Mail::Part.new('Content-Type: text/html;')
       end
+      add_multipart_alternate_header
       add_part(@html_part)
     end
     
@@ -600,14 +659,37 @@ module Mail
       else
         @text_part = Mail::Part.new('Content-Type: text/plain;')
       end
+      add_multipart_alternate_header
       add_part(@text_part)
     end
 
     # Adds a part to the parts list or creates the part list
     def add_part(part)
-      add_multipart_alternate_header
+      if body.parts.empty? && !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
+      end
+      add_boundary
       self.body << part
     end
+
+    # Allows you to add a part in block form to an existing mail message object
+    # 
+    # Example:
+    # 
+    #  mail = Mail.new do
+    #    part :content_type => "multipart/alternative", :content_disposition => "inline" do |p|
+    #      p.part :content_type => "text/plain", :body => "test text\nline #2"
+    #      p.part :content_type => "text/html", :body => "<b>test</b> HTML<br/>\nline #2"
+    #    end
+    #  end
+    def part(params = {})
+      new_part = Part.new(params)
+      yield new_part if block_given?
+      add_part(new_part)
+    end
     
     # Adds a file to the message.  You have two options with this method, you can
     # just pass in the absolute path to the file you want and Mail will read the file,
@@ -735,6 +817,12 @@ module Mail
       body.split!(boundary)
     end
     
+    def add_encoding_to_body
+      unless content_transfer_encoding.blank?
+        body.encoding = content_transfer_encoding.decoded
+      end
+    end
+    
     def add_required_fields
       @body = Mail::Body.new('')    if body.nil?
       add_message_id                unless (has_message_id? || self.class == Mail::Part)
@@ -746,30 +834,37 @@ module Mail
     end
     
     def add_multipart_alternate_header
-      if html_part && text_part
-        unless header['content-type']
-          header['content-type'] = ContentTypeField.with_boundary('multipart/alternative').value
-          body.boundary = boundary
-        end
+      header['content-type'] = ContentTypeField.with_boundary('multipart/alternative').value
+      body.boundary = boundary
+    end
+    
+    def add_boundary
+      unless body.boundary && boundary
+        header['content-type'] = 'multipart/mixed' unless header['content-type']
+        header['content-type'].parameters[:boundary] = ContentTypeField.generate_boundary
+        body.boundary = boundary
       end
     end
     
     def add_multipart_mixed_header
       unless header['content-type']
         header['content-type'] = ContentTypeField.with_boundary('multipart/mixed').value
-        
         body.boundary = boundary
       end
     end
     
     def init_with_hash(hash)
+      passed_in_options = hash
       self.raw_source = ''
       @header = Mail::Header.new
       @body = Mail::Body.new
       hash.each_pair do |k,v|
         next if k.to_sym == :data
         if k.to_sym == :filename
-          add_attachment(hash)
+          add_attachment(passed_in_options)
+          break
+        elsif k == :headers
+          self.headers(v)
         else
           self[k] = v
         end
@@ -778,9 +873,13 @@ module Mail
     
     def add_attachment(options_hash)
       @attachment = Mail::Attachment.new(options_hash)
-      self.content_type = "#{attachment.mime_type}; filename=\"#{attachment.filename}\""
+      mime_type = options_hash[:content_type] || attachment.mime_type
+      self.content_type = "#{mime_type}; filename=\"#{attachment.filename}\""
       self.content_transfer_encoding = "Base64"
-      self.content_disposition = "attachment; filename=\"#{attachment.filename}\""
+
+      disposition = options_hash[:content_disposition] || "attachment"
+      self.content_disposition = "#{disposition}; filename=\"#{attachment.filename}\""
+      add_boundary
       self.body = attachment.encoded
     end
     

data/lib/mail/version.rb

@@ -3,7 +3,7 @@ module Mail
   module VERSION
     MAJOR = 1
     MINOR = 2
-    TINY  = 6
+    TINY  = 8
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/lib/mail/version_specific/ruby_1_8.rb

@@ -45,7 +45,7 @@ module Mail
     end
     
     def Ruby18.b_value_decode(str)
-      match = str.match(/\=\?(.+)?\?B\?(.+)?\?\=/)
+      match = str.match(/\=\?(.+)?\?[Bb]\?(.+)?\?\=/)
       if match
         encoding = match[1]
         str = Ruby18.decode_base64(match[2])
@@ -61,7 +61,7 @@ module Mail
     end
     
     def Ruby18.q_value_decode(str)
-      match = str.match(/\=\?(.+)?\?Q\?(.+)?\?\=/)
+      match = str.match(/\=\?(.+)?\?[Qq]\?(.+)?\?\=/)
       if match
         encoding = match[1]
         str = Encodings::QuotedPrintable.decode(match[2])

data/lib/mail/version_specific/ruby_1_9.rb

@@ -37,7 +37,7 @@ module Mail
     end
     
     def Ruby19.b_value_decode(str)
-      match = str.match(/\=\?(.+)?\?B\?(.+)?\?\=/)
+      match = str.match(/\=\?(.+)?\?[Bb]\?(.+)?\?\=/)
       if match
         encoding = match[1]
         str = Ruby19.decode_base64(match[2])
@@ -52,7 +52,7 @@ module Mail
     end
 
     def Ruby19.q_value_decode(str)
-      match = str.match(/\=\?(.+)?\?Q\?(.+)?\?\=/)
+      match = str.match(/\=\?(.+)?\?[Qq]\?(.+)?\?\=/)
       if match
         encoding = match[1]
         str = Encodings::QuotedPrintable.decode(match[2])

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mail
 version: !ruby/object:Gem::Version 
-  version: 1.2.6
+  version: 1.2.8
 platform: ruby
 authors: 
 - Mike Lindsaar
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-19 00:00:00 +11:00
+date: 2009-11-22 00:00:00 +11:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -30,7 +30,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: "0"
+        version: "1.4"
     version: 
 - !ruby/object:Gem::Dependency 
   name: activesupport
@@ -40,7 +40,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: "0"
+        version: "2.3"
     version: 
 - !ruby/object:Gem::Dependency 
   name: mime-types