mail 2.4.0 → 2.4.1

data/CHANGELOG.rdoc

@@ -1,3 +1,13 @@
+== Thu Jan 19 13:49:34 UTC 2012 Mikel Lindsaar <mikel@reinteractive.net>
+
+* Fix non ascii character folding problems
+* Handle multipart mail in Mail::Message#to_yaml / #from_yaml
+* More warning fixes
+* Normalize the Parse Error class and messages
+* Fix for Mail::Encodings.unquote_and_convert not handling unquoted characters mixed in between quoted strings
+* Updated treetop to latest version, specs now run approximately 25-30% faster!
+* Version bump to 2.4.1 and gem release
+
 == Sun Jan 15 18:15:56 UTC 2011 Mikel Lindsaar <mikel@reinteractive.net>
 
 * Speed up reading of messages by about 12x
@@ -578,4 +588,4 @@ content-disposition or content-location
 
 == Sat Oct 25 13:38:01 UTC 2009 Mikel Lindsaar <raasdnil@gmail.com>
 
-* Birthday, Mail released as a gem... phew
+* Birthday, Mail released as a gem... phew

data/Gemfile

@@ -3,7 +3,7 @@ source :rubygems
 gem "activesupport", ">= 2.3.6"
 gem "tlsmail" if RUBY_VERSION <= '1.8.6'
 gem "mime-types", "~> 1.16"
-gem "treetop", "~> 1.4.8"
+gem "treetop", "~> 1.4.10"
 gem "i18n", ">= 0.4.0"
 
 if defined?(RUBY_ENGINE) && RUBY_ENGINE == 'jruby'

data/Gemfile.lock

@@ -2,11 +2,15 @@ GEM
   remote: http://rubygems.org/
   specs:
     activesupport (3.0.6)
+    columnize (0.3.6)
     diff-lcs (1.1.3)
     i18n (0.5.0)
+    linecache (0.46)
+      rbx-require-relative (> 0.0.4)
     mime-types (1.16)
-    polyglot (0.3.1)
+    polyglot (0.3.3)
     rake (0.9.2.2)
+    rbx-require-relative (0.0.5)
     rspec (2.8.0)
       rspec-core (~> 2.8.0)
       rspec-expectations (~> 2.8.0)
@@ -15,7 +19,13 @@ GEM
     rspec-expectations (2.8.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.8.0)
-    treetop (1.4.9)
+    ruby-debug (0.10.4)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.4.0)
+    ruby-debug-base (0.10.4)
+      linecache (>= 0.3)
+    treetop (1.4.10)
+      polyglot
       polyglot (>= 0.3.1)
 
 PLATFORMS
@@ -28,4 +38,5 @@ DEPENDENCIES
   mime-types (~> 1.16)
   rake (> 0.8.7)
   rspec (~> 2.8.0)
-  treetop (~> 1.4.8)
+  ruby-debug
+  treetop (~> 1.4.10)

data/lib/VERSION

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

data/lib/mail/elements/address_list.rb

@@ -26,7 +26,7 @@ module Mail
       if tree = parser.parse(string)
         @address_nodes = tree.addresses
       else
-        raise Mail::Field::ParseError, "AddressListsParser can not parse |#{string}|\nReason was: #{parser.failure_reason}\n"
+        raise Mail::Field::ParseError.new(AddressListsParser, string, parser.failure_reason)
       end
     end
     
@@ -71,4 +71,4 @@ module Mail
       end
     end
   end
-end
+end

data/lib/mail/elements/content_disposition_element.rb

@@ -10,7 +10,7 @@ module Mail
         @disposition_type = tree.disposition_type.text_value.downcase
         @parameters = tree.parameters
       else
-        raise Mail::Field::ParseError, "ContentDispositionElement can not parse |#{string}|\nReason was: #{parser.failure_reason}\n"
+        raise Mail::Field::ParseError.new(ContentDispositionElement, string, parser.failure_reason)
       end
     end
     

data/lib/mail/elements/content_location_element.rb

@@ -9,7 +9,7 @@ module Mail
       if tree = parser.parse(string)
         @location = tree.location.text_value
       else
-        raise Mail::Field::ParseError, "ContentLocationElement can not parse |#{string}|\nReason was: #{parser.failure_reason}\n"
+        raise Mail::Field::ParseError.new(ContentLocationElement, string, parser.failure_reason)
       end
     end
     

data/lib/mail/elements/content_transfer_encoding_element.rb

@@ -12,7 +12,7 @@ module Mail
       when tree = parser.parse(string.to_s.downcase)
         @encoding = tree.encoding.text_value
       else
-        raise Mail::Field::ParseError, "ContentTransferEncodingElement can not parse |#{string}|\nReason was: #{parser.failure_reason}\n"
+        raise Mail::Field::ParseError.new(ContentTransferEncodingElement, string, parser.failure_reason)
       end
     end
     

data/lib/mail/elements/content_type_element.rb

@@ -11,7 +11,7 @@ module Mail
         @sub_type = tree.sub_type.text_value.downcase
         @parameters = tree.parameters
       else
-        raise Mail::Field::ParseError, "ContentTypeElement can not parse |#{string}|\nReason was: #{parser.failure_reason}\n"
+        raise Mail::Field::ParseError.new(ContentTypeElement, string, parser.failure_reason)
       end
     end
     

data/lib/mail/elements/date_time_element.rb

@@ -10,7 +10,7 @@ module Mail
         @date_string = tree.date.text_value
         @time_string = tree.time.text_value
       else
-        raise Mail::Field::ParseError, "DateTimeElement can not parse |#{string}|\nReason was: #{parser.failure_reason}\n"
+        raise Mail::Field::ParseError.new(DateTimeElement, string, parser.failure_reason)
       end
     end
     

data/lib/mail/elements/envelope_from_element.rb

@@ -10,7 +10,7 @@ module Mail
         @address = tree.addr_spec.text_value.strip
         @date_time = ::DateTime.parse("#{tree.ctime_date.text_value}")
       else
-        raise Mail::Field::ParseError, "EnvelopeFromElement can not parse |#{string}|\nReason was: #{parser.failure_reason}\n"
+        raise Mail::Field::ParseError.new(EnvelopeFromElement, string, parser.failure_reason)
       end
     end
     

data/lib/mail/elements/message_ids_element.rb

@@ -9,7 +9,7 @@ module Mail
       if tree = parser.parse(string)
         @message_ids = tree.message_ids.map { |msg_id| clean_msg_id(msg_id.text_value) }
       else
-        raise Mail::Field::ParseError, "MessageIdsElement can not parse |#{string}|\nReason was: #{parser.failure_reason}\n"
+        raise Mail::Field::ParseError.new(MessageIdsElement, string, parser.failure_reason)
       end
     end
     
@@ -26,4 +26,4 @@ module Mail
     end
 
   end
-end
+end

data/lib/mail/elements/mime_version_element.rb

@@ -10,7 +10,7 @@ module Mail
         @major = tree.major.text_value
         @minor = tree.minor.text_value
       else
-        raise Mail::Field::ParseError, "MimeVersionElement can not parse |#{string}|\nReason was: #{parser.failure_reason}\n"
+        raise Mail::Field::ParseError.new(MimeVersionElement, string, parser.failure_reason)
       end
     end
     

data/lib/mail/elements/phrase_list.rb

@@ -9,7 +9,7 @@ module Mail
       if tree = parser.parse(string)
         @phrases = tree.phrases
       else
-        raise Mail::Field::ParseError, "PhraseList can not parse |#{string}|\nReason was: #{parser.failure_reason}\n"
+        raise Mail::Field::ParseError.new(PhraseList, string, parser.failure_reason)
       end
     end
     
@@ -18,4 +18,4 @@ module Mail
     end
 
   end
-end
+end

data/lib/mail/elements/received_element.rb

@@ -10,7 +10,7 @@ module Mail
         @date_time = ::DateTime.parse("#{tree.date_time.date.text_value} #{tree.date_time.time.text_value}")
         @info = tree.name_val_list.text_value
       else
-        raise Mail::Field::ParseError, "ReceivedElement can not parse |#{string}|\nReason was: #{parser.failure_reason}\n"
+        raise Mail::Field::ParseError.new(ReceivedElement, string, parser.failure_reason)
       end
     end
     

data/lib/mail/encodings.rb

@@ -126,20 +126,28 @@ module Mail
           # Join QP encoded-words that are adjacent to avoid decoding partial chars
           text.gsub!(/\?\=\=\?.+?\?[Qq]\?/m, '') if text =~ /\?==\?/
 
-          # Separate encoded-words with a space, so we can treat them one by one
-          text.gsub!(/\?\=\=\?/, '?= =?')
-          text.split(/ /).map do |word|
-            word.to_str.
-              gsub( /=\?.+\?[Bb]\?.+\?=/m ) { |substr| b_value_decode(substr) }.
-              gsub( /=\?.+\?[Qq]\?.+\?=/m ) { |substr| q_value_decode(substr) }
+          # Search for occurences of quoted strings or plain strings
+          text.scan(/(                                  # Group around entire regex to include it in matches
+                       \=\?[^?]+\?([QB])\?[^?]+?\?\=  # Quoted String with subgroup for encoding method
+                       |                                # or
+                       .+?(?=\=\?)                      # Plain String
+                     )/xmi).map do |matches|
+            string, method = *matches
+            if    method == 'b' || method == 'B'
+              b_value_decode(string)
+            elsif method == 'q' || method == 'Q'
+              q_value_decode(string)
+            else
+              string
             end
+          end
         end
       end.join("")
     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 )
+      original_encoding = split_encoding_from_string( str )
 
       output = value_decode( str ).to_s
 
@@ -253,7 +261,7 @@ module Mail
     def Encodings.split_encoding_from_string( str )
       match = str.match(/\=\?([^?]+)?\?[QB]\?(.+)?\?\=/mi)
       if match
-        [match[1], match[2]]
+        match[1]
       else
         nil
       end

data/lib/mail/field.rb

@@ -42,6 +42,14 @@ module Mail
     # Raised when a parsing error has occurred (ie, a StructuredField has tried
     # to parse a field that is invalid or improperly written)
     class ParseError < FieldError #:nodoc:
+      attr_accessor :element, :value, :reason
+
+      def initialize(element, value, reason)
+        @element = element
+        @value = value
+        @reason = reason
+        super("#{element} can not parse |#{value}|\nReason was: #{reason}")
+      end
     end
 
     # Raised when attempting to set a structured field's contents to an invalid syntax

data/lib/mail/fields/resent_sender_field.rb

@@ -47,7 +47,7 @@ module Mail
     end
 
     def address
-      result = tree.addresses.first
+      tree.addresses.first
     end
     
     def encoded

data/lib/mail/fields/sender_field.rb

@@ -48,7 +48,7 @@ module Mail
     end
 
     def address
-      result = tree.addresses.first
+      tree.addresses.first
     end
     
     def encoded

data/lib/mail/fields/unstructured_field.rb

@@ -18,9 +18,11 @@ module Mail
     
     include Mail::CommonField
     include Mail::Utilities
-    
+   
+    attr_accessor :charset
+    attr_reader :errors
+ 
     def initialize(name, value, charset = nil)
-      self.charset = charset
       @errors = []
       if charset
         self.charset = charset
@@ -35,21 +37,9 @@ module Mail
       self.value = value
       self
     end
-    
-    def charset
-      @charset
-    end
-    
-    def charset=(val)
-      @charset = val
-    end
-
-    def errors
-      @errors
-    end
-    
+   
     def encoded
-      do_encode(self.name)
+      do_encode
     end
     
     def decoded
@@ -66,7 +56,7 @@ module Mail
 
     private
     
-    def do_encode(name)
+    def do_encode
       value.nil? ? '' : "#{wrapped_value}\r\n"
     end
     
@@ -103,10 +93,7 @@ module Mail
     #  preference to other places where the field could be folded, even if
     #  it is allowed elsewhere.
     def wrapped_value # :nodoc:
-      @folded_line = []
-      @unfolded_line = decoded.to_s.split(/[ \t]/)
-      fold("#{name}: ".length)
-      wrap_lines(name, @folded_line)
+      wrap_lines(name, fold("#{name}: ".length))
     end
    
     # 6.2. Display of 'encoded-word's
@@ -118,64 +105,86 @@ module Mail
     #  without having to separate 'encoded-word's where spaces occur in the
     #  unencoded text.)
     def wrap_lines(name, folded_lines)
-      result = []
-      index = 0
-      result[index] = "#{name}: #{folded_lines.shift}"
+      result = ["#{name}: #{folded_lines.shift}"]
       result.concat(folded_lines)
       result.join("\r\n\s")
     end
 
     def fold(prepend = 0) # :nodoc:
-      encoding = @charset.to_s.upcase.gsub('_', '-')
-      while !@unfolded_line.empty?
-        encoded = false
+      encoding       = normalized_encoding
+      decoded_string = decoded.to_s
+      should_encode  = decoded_string.not_ascii_only?
+      if should_encode
+        first = true
+        words = decoded_string.split(/[ \t]/).map do |word|
+          if first
+            first = !first
+          else
+            word = " " << word
+          end
+          if word.not_ascii_only?
+            word
+          else
+            word.scan(/.{7}|.+$/)
+          end
+        end.flatten
+      else
+        words = decoded_string.split(/[ \t]/)
+      end
+      
+      folded_lines   = []
+      while !words.empty?
         limit = 78 - prepend
+        limit = limit - 7 - encoding.length if should_encode
         line = ""
-        while !@unfolded_line.empty?          
-          break unless word = @unfolded_line.first.dup
-          # Remember whether it was non-ascii before we encode it ('cause then we can't tell anymore)
-          non_ascii = word.not_ascii_only?
-          encoded_word = encode(word)
+        while !words.empty?
+          break unless word = words.first.dup
+          word.encode!(charset) if defined?(Encoding) && charset
+          word = encode(word) if should_encode
+          word = encode_crlf(word)
           # Skip to next line if we're going to go past the limit
           # Unless this is the first word, in which case we're going to add it anyway
           # Note: This means that a word that's longer than 998 characters is going to break the spec. Please fix if this is a problem for you.
           # (The fix, it seems, would be to use encoded-word encoding on it, because that way you can break it across multiple lines and 
           # the linebreak will be ignored)
-          break if !line.empty? && (line.length + encoded_word.length + 1 > limit)
-          # If word was the first non-ascii word, we're going to make the entire line encoded and we're going to reduce the limit accordingly
-          if non_ascii && !encoded
-            encoded = true
-            encoded_word_safify!(line)
-            limit = limit - 8 - encoding.length  # minus the =?...?Q?...?= part, the possible leading white-space, and the name of the encoding
-          end
+          break if !line.empty? && (line.length + word.length + 1 > limit)
           # Remove the word from the queue ...
-          @unfolded_line.shift
+          words.shift
+          # Add word separator
+          line << " " unless (line.empty? || should_encode)
           # ... add it in encoded form to the current line
-          line << " " unless line.empty?
-          encoded_word_safify!(encoded_word) if encoded
-          line << encoded_word          
+          line << word          
         end
-        # Add leading whitespace if both this and the last line were encoded, because whitespace between two encoded-words is ignored when decoding
-        line = " " + line if encoded && @folded_line.last && @folded_line.last.index('=?') == 0
         # Encode the line if necessary
-        line = "=?#{encoding}?Q?#{line.gsub(/ /, '_')}?=" if encoded
+        line = "=?#{encoding}?Q?#{line}?=" if should_encode
         # Add the line to the output and reset the prepend
-        @folded_line << line
+        folded_lines << line
         prepend = 0
       end
+      folded_lines
     end
-        
+ 
     def encode(value)
-      value.encode!(charset) if charset && value.respond_to?(:encode!)
-      (value.not_ascii_only? ? [value].pack("M").gsub("=\n", '') : value).gsub("\r", "=0D").gsub("\n", "=0A")
-    end
-    
-    def encoded_word_safify!(value)
+      value = [value].pack("M").gsub("=\n", '')
       value.gsub!(/"/,  '=22')
       value.gsub!(/\(/, '=28')
       value.gsub!(/\)/, '=29')
       value.gsub!(/\?/, '=3F')
       value.gsub!(/_/,  '=5F')
+      value.gsub!(/ /,  '_')
+      value
+    end
+
+    def encode_crlf(value)
+      value.gsub!("\r", '=0D')
+      value.gsub!("\n", '=0A')
+      value
+    end
+
+    def normalized_encoding
+      encoding = charset.to_s.upcase.gsub('_', '-')
+      encoding = 'UTF-8' if encoding == 'UTF8' # Ruby 1.8.x and $KCODE == 'u'
+      encoding
     end
 
   end

data/lib/mail/message.rb

@@ -1734,6 +1734,11 @@ module Mail
       hash['delivery_handler'] = delivery_handler.to_s if delivery_handler
       hash['transport_encoding'] = transport_encoding.to_s
       special_variables = [:@header, :@delivery_handler, :@transport_encoding]
+      if multipart?
+        hash['multipart_body'] = []
+        body.parts.map { |part| hash['multipart_body'] << part.to_yaml }
+        special_variables.push(:@body, :@text_part, :@html_part)
+      end
       (instance_variables.map(&:to_sym) - special_variables).each do |var|
         hash[var.to_s] = instance_variable_get(var)
       end
@@ -1742,7 +1747,7 @@ module Mail
 
     def self.from_yaml(str)
       hash = YAML.load(str)
-      m = Mail::Message.new(:headers => hash['headers'])
+      m = self.new(:headers => hash['headers'])
       hash.delete('headers')
       hash.each do |k,v|
         case
@@ -1753,6 +1758,8 @@ module Mail
           end
         when k == 'transport_encoding'
           m.transport_encoding(v)
+        when k == 'multipart_body'
+          v.map {|part| m.add_part Mail::Part.from_yaml(part) }
         when k =~ /^@/
           m.instance_variable_set(k.to_sym, v)
         end

data/lib/mail/multibyte/chars.rb

@@ -435,7 +435,7 @@ module Mail #:nodoc:
 
           begin
             @wrapped_string[0...byte_offset].unpack('U*').length
-          rescue ArgumentError => e
+          rescue ArgumentError
             byte_offset -= 1
             retry
           end

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

@@ -125,8 +125,8 @@ module Mail
     def start(config = Configuration.instance, &block)
       raise ArgumentError.new("Mail::Retrievable#pop3_start takes a block") unless block_given?
     
-      pop3 = Net::POP3.new(settings[:address], settings[:port], isapop = false)
-      pop3.enable_ssl(verify = OpenSSL::SSL::VERIFY_NONE) if settings[:enable_ssl]
+      pop3 = Net::POP3.new(settings[:address], settings[:port], false)
+      pop3.enable_ssl(OpenSSL::SSL::VERIFY_NONE) if settings[:enable_ssl]
       pop3.start(settings[:user_name], settings[:password])
     
       yield pop3

metadata

@@ -1,60 +1,81 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: mail
-version: !ruby/object:Gem::Version
-  version: 2.4.0
+version: !ruby/object:Gem::Version 
+  hash: 29
   prerelease: 
+  segments: 
+  - 2
+  - 4
+  - 1
+  version: 2.4.1
 platform: ruby
-authors:
+authors: 
 - Mikel Lindsaar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-15 00:00:00.000000000 +10:30
-default_executable: 
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2012-01-20 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: mime-types
-  requirement: &70128923044060 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.16'
+      - !ruby/object:Gem::Version 
+        hash: 47
+        segments: 
+        - 1
+        - 16
+        version: "1.16"
   type: :runtime
-  prerelease: false
-  version_requirements: *70128923044060
-- !ruby/object:Gem::Dependency
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: treetop
-  requirement: &70128923043580 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 4
+        - 8
         version: 1.4.8
   type: :runtime
-  prerelease: false
-  version_requirements: *70128923043580
-- !ruby/object:Gem::Dependency
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
   name: i18n
-  requirement: &70128923043120 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 0
+        - 4
+        - 0
         version: 0.4.0
   type: :runtime
-  prerelease: false
-  version_requirements: *70128923043120
+  version_requirements: *id003
 description: A really Ruby Mail handler.
 email: raasdnil@gmail.com
 executables: []
+
 extensions: []
-extra_rdoc_files:
+
+extra_rdoc_files: 
 - README.md
 - CONTRIBUTING.md
 - CHANGELOG.rdoc
 - TODO.rdoc
-files:
+files: 
 - README.md
 - CONTRIBUTING.md
 - CHANGELOG.rdoc
@@ -195,29 +216,38 @@ files:
 - lib/tasks/corpus.rake
 - lib/tasks/treetop.rake
 - lib/VERSION
-has_rdoc: true
 homepage: http://github.com/mikel/mail
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Mail provides a nice Ruby DSL for making, sending and reading emails.
 test_files: []
+