mail-trunk 2.3.0

data/lib/mail/version.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+module Mail
+  module VERSION
+    
+    version = {}
+    File.read(File.join(File.dirname(__FILE__), '../', 'VERSION')).each_line do |line|
+      type, value = line.chomp.split(":")
+      next if type =~ /^\s+$/  || value =~ /^\s+$/
+      version[type] = value
+    end
+    
+    MAJOR = version['major']
+    MINOR = version['minor']
+    PATCH = version['patch']
+    BUILD = version['build']
+
+    STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')
+    
+    def self.version
+      STRING
+    end
+    
+  end
+end

data/lib/mail/version_specific/ruby_1_8.rb

@@ -0,0 +1,98 @@
+# encoding: utf-8
+
+module Mail
+  class Ruby18
+    require 'base64'
+
+    # Escapes any parenthesis in a string that are unescaped. This can't
+    # use the Ruby 1.9.1 regexp feature of negative look behind so we have
+    # to do two replacement, first unescape everything, then re-escape it
+    def Ruby18.escape_paren( str )
+      re = /\\\)/
+      str = str.gsub(re) { |s| ')'}
+      re = /\\\(/
+      str = str.gsub(re) { |s| '('}
+      re = /([\(\)])/          # Only match unescaped parens
+      str.gsub(re) { |s| '\\' + s }
+    end
+
+    def Ruby18.paren( str )
+      str = $1 if str =~ /^\((.*)?\)$/
+      str = escape_paren( str )
+      '(' + str + ')'
+    end
+
+    def Ruby18.escape_bracket( str )
+      re = /\\\>/
+      str = str.gsub(re) { |s| '>'}
+      re = /\\\</
+      str = str.gsub(re) { |s| '<'}
+      re = /([\<\>])/          # Only match unescaped parens
+      str.gsub(re) { |s| '\\' + s }
+    end
+
+    def Ruby18.bracket( str )
+      str = $1 if str =~ /^\<(.*)?\>$/
+      str = escape_bracket( str )
+      '<' + str + '>'
+    end
+
+    def Ruby18.decode_base64(str)
+      Base64.decode64(str) if str
+    end
+
+    def Ruby18.encode_base64(str)
+      Base64.encode64(str)
+    end
+
+    def Ruby18.has_constant?(klass, string)
+      klass.constants.include?( string )
+    end
+
+    def Ruby18.get_constant(klass, string)
+      klass.const_get( string )
+    end
+
+    def Ruby18.b_value_encode(str, encoding)
+      # Ruby 1.8 requires an encoding to work
+      raise ArgumentError, "Must supply an encoding" if encoding.nil?
+      encoding = encoding.to_s.upcase.gsub('_', '-')
+      [Encodings::Base64.encode(str), encoding]
+    end
+
+    def Ruby18.b_value_decode(str)
+      match = str.match(/\=\?(.+)?\?[Bb]\?(.+)?\?\=/m)
+      if match
+        encoding = match[1]
+        str = Ruby18.decode_base64(match[2])
+      end
+      str
+    end
+
+    def Ruby18.q_value_encode(str, encoding)
+      # Ruby 1.8 requires an encoding to work
+      raise ArgumentError, "Must supply an encoding" if encoding.nil?
+      encoding = encoding.to_s.upcase.gsub('_', '-')
+      [Encodings::QuotedPrintable.encode(str), encoding]
+    end
+
+    def Ruby18.q_value_decode(str)
+      match = str.match(/\=\?(.+)?\?[Qq]\?(.+)?\?\=/m)
+      if match
+        encoding = match[1]
+        str = Encodings::QuotedPrintable.decode(match[2])
+      end
+      str
+    end
+
+    def Ruby18.param_decode(str, encoding)
+      URI.unescape(str)
+    end
+
+    def Ruby18.param_encode(str)
+      encoding = $KCODE.to_s.downcase
+      language = Configuration.instance.param_encode_language
+      "#{encoding}'#{language}'#{URI.escape(str)}"
+    end
+  end
+end

data/lib/mail/version_specific/ruby_1_9.rb

@@ -0,0 +1,113 @@
+# encoding: utf-8
+
+module Mail
+  class Ruby19
+
+    # Escapes any parenthesis in a string that are unescaped this uses
+    # a Ruby 1.9.1 regexp feature of negative look behind
+    def Ruby19.escape_paren( str )
+      re = /(?<!\\)([\(\)])/          # Only match unescaped parens
+      str.gsub(re) { |s| '\\' + s }
+    end
+
+    def Ruby19.paren( str )
+      str = $1 if str =~ /^\((.*)?\)$/
+      str = escape_paren( str )
+      '(' + str + ')'
+    end
+
+    def Ruby19.escape_bracket( str )
+      re = /(?<!\\)([\<\>])/          # Only match unescaped brackets
+      str.gsub(re) { |s| '\\' + s }
+    end
+
+    def Ruby19.bracket( str )
+      str = $1 if str =~ /^\<(.*)?\>$/
+      str = escape_bracket( str )
+      '<' + str + '>'
+    end
+
+    def Ruby19.decode_base64(str)
+      str.unpack( 'm' ).first
+    end
+
+    def Ruby19.encode_base64(str)
+      [str].pack( 'm' )
+    end
+
+    def Ruby19.has_constant?(klass, string)
+      klass.const_defined?( string, false )
+    end
+
+    def Ruby19.get_constant(klass, string)
+      klass.const_get( string )
+    end
+
+    def Ruby19.b_value_encode(str, encoding = nil)
+      encoding = str.encoding.to_s
+      [Ruby19.encode_base64(str), encoding]
+    end
+
+    def Ruby19.b_value_decode(str)
+      match = str.match(/\=\?(.+)?\?[Bb]\?(.+)?\?\=/m)
+      if match
+        encoding = match[1]
+        str = Ruby19.decode_base64(match[2])
+        str.force_encoding(fix_encoding(encoding))
+      end
+      decoded = str.encode("utf-8", :invalid => :replace, :replace => "")
+      decoded.valid_encoding? ? decoded : decoded.encode("utf-16le", :invalid => :replace, :replace => "").encode("utf-8")
+    end
+
+    def Ruby19.q_value_encode(str, encoding = nil)
+      encoding = str.encoding.to_s
+      [Encodings::QuotedPrintable.encode(str), encoding]
+    end
+
+    def Ruby19.q_value_decode(str)
+      match = str.match(/\=\?(.+)?\?[Qq]\?(.+)?\?\=/m)
+      if match
+        encoding = match[1]
+        str = Encodings::QuotedPrintable.decode(match[2])
+        str.force_encoding(fix_encoding(encoding))
+      end
+      decoded = str.encode("utf-8", :invalid => :replace, :replace => "")
+      decoded.valid_encoding? ? decoded : decoded.encode("utf-16le", :invalid => :replace, :replace => "").encode("utf-8")
+    end
+
+    def Ruby19.param_decode(str, encoding)
+      string = uri_parser.unescape(str)
+      string.force_encoding(encoding) if encoding
+      string
+    end
+
+    def Ruby19.param_encode(str)
+      encoding = str.encoding.to_s.downcase
+      language = Configuration.instance.param_encode_language
+      "#{encoding}'#{language}'#{uri_parser.escape(str)}"
+    end
+
+    def Ruby19.uri_parser
+      @uri_parser ||= URI::Parser.new
+    end
+
+     # mails somtimes includes invalid encodings like iso885915 or utf8 so we transform them to iso885915 or utf8
+     # TODO: add this as a test somewhere
+     # Encoding.list.map{|e| [e.to_s.upcase==fix_encoding(e.to_s.downcase.gsub("-", "")), e.to_s] }.select {|a,b| !b}
+     #  Encoding.list.map{|e| [e.to_s==fix_encoding(e.to_s), e.to_s] }.select {|a,b| !b}
+    def Ruby19.fix_encoding(encoding)
+      case encoding
+        # ISO-8859-15, ISO-2022-JP and alike
+        when /iso-?(\d{4})-?(\w{1,2})/i then return "ISO-#{$1}-#{$2}"
+        # "ISO-2022-JP-KDDI"  and alike
+        when /iso-?(\d{4})-?(\w{1,2})-?(\w*)/i then return "ISO-#{$1}-#{$2}-#{$3}"
+        # UTF-8, UTF-32BE and alike
+        when /utf-?(\d{1,2})?(\w{1,2})/i then return "UTF-#{$1}#{$2}"
+        # Windows-1252 and alike
+        when /Windows-?(.*)/i then return "Windows-#{$1}"
+        #more aliases to be added if needed
+        else return encoding
+      end
+    end
+  end
+end

data/lib/tasks/corpus.rake

@@ -0,0 +1,125 @@
+namespace :corpus do
+
+  task :load_mail do
+    require File.expand_path('../../../spec/environment')
+    require 'mail'
+  end
+
+  # Used to run parsing against an arbitrary corpus of email.
+  # For example: http://plg.uwaterloo.ca/~gvcormac/treccorpus/
+  desc "Provide a LOCATION=/some/dir to verify parsing in bulk, otherwise defaults"
+  task :verify_all => :load_mail do
+
+    root_of_corpus    = ENV['LOCATION'] || 'corpus/spam'
+    @save_failures_to = ENV['SAVE_TO']  || 'spec/fixtures/emails/failed_emails'
+    @failed_emails    = []
+    @checked_count    = 0
+
+    if root_of_corpus
+      root_of_corpus = File.expand_path(root_of_corpus)
+      if not File.directory?(root_of_corpus)
+        raise "\n\tPath '#{root_of_corpus}' is not a directory.\n\n"
+      end
+    else
+      raise "\n\tSupply path to corpus: LOCATION=/path/to/corpus\n\n"
+    end
+
+    if @save_failures_to
+      if not File.directory?(@save_failures_to)
+        raise "\n\tPath '#{@save_failures_to}' is not a directory.\n\n"
+      end
+      @save_failures_to = File.expand_path(@save_failures_to)
+      puts "Mail which fails to parse will be saved in '#{@save_failures_to}'"
+    end
+
+    puts "Checking '#{root_of_corpus}' directory (recursively)"
+
+    # we're tracking all the errors separately, don't clutter terminal
+    $stderr_backup = $stderr.dup
+    $stderr.reopen("/dev/null", "w")
+    STDERR = $stderr
+
+    dir_node(root_of_corpus)
+
+    # put our toys back now that we're done with them
+    $stderr = $stderr_backup.dup
+    STDERR = $stderr
+
+    puts "\n\n"
+        
+    if @failed_emails.any?
+      report_failures_to_stdout
+    end
+    puts "Out of Total: #{@checked_count}"
+
+    if @save_failures_to
+      puts "Add SAVE_TO=/some/dir to save failed emails to for review.,"
+      puts "May result in a lot of saved files. Do a dry run first!\n\n"
+    else
+      puts "There are no errors"
+    end
+  end
+
+  def dir_node(path)
+    puts "\n\n"
+    puts "Checking emails in '#{path}':"
+
+    entries = Dir.entries(path)
+
+    entries.each do |entry|
+      next if ['.', '..'].include?(entry)
+      full_path = File.join(path, entry)
+
+      if File.file?(full_path)
+        file_node(full_path)
+      elsif File.directory?(full_path)
+        dir_node(full_path)
+      end
+    end
+  end
+  
+  def file_node(path)
+    verify(path)
+  end
+  
+  def verify(path)
+    result, message = parse_as_mail(path)
+    if result
+      print '.'
+      $stdout.flush
+    else
+      save_failure(path, message)
+      print 'x'
+    end
+  end
+
+  def save_failure(path, message)
+    @failed_emails << [path, message]
+    if @save_failures_to
+      email_basename = File.basename(path)
+      failure_as_filename = message.gsub(/\W/, '_')
+      new_email_name = [failure_as_filename, email_basename].join("_")
+      File.open(File.join(@save_failures_to, new_email_name), 'w+') do |fh|
+        fh << File.read(path)
+      end 
+    end
+  end
+
+  def parse_as_mail(path)
+    @checked_count += 1
+    begin
+      parsed_mail = Mail.read(path)
+      [true, nil]
+    rescue => e
+      [false, e.message]
+    end
+  end
+  
+  def report_failures_to_stdout
+    @failed_emails.each do |failed|
+      puts "#{failed[0]} : #{failed[1]}"
+    end
+    puts "Failed: #{@failed_emails.size}"
+  end
+  
+end

data/lib/tasks/treetop.rake

@@ -0,0 +1,10 @@
+namespace :treetop do
+
+  desc "Pre-generate all the .treetop files into .rb files"
+  task :generate do
+    Dir.glob(File.expand_path('../../mail/parsers/*.treetop', __FILE__)).each do |filename|
+      `bundle exec tt #{filename}`
+    end
+  end
+
+end

metadata

@@ -0,0 +1,221 @@
+--- !ruby/object:Gem::Specification 
+name: mail-trunk
+version: !ruby/object:Gem::Version 
+  version: 2.3.0
+platform: ruby
+authors: 
+- Mikel Lindsaar
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-12-28 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mime-types
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.16"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: treetop
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.4.8
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: i18n
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.4.0
+    version: 
+description: A really Ruby Mail handler.
+email: raasdnil@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.mkd
+- CHANGELOG.rdoc
+- TODO.rdoc
+files: 
+- README.mkd
+- CHANGELOG.rdoc
+- Dependencies.txt
+- Gemfile
+- Rakefile
+- TODO.rdoc
+- lib/mail.rb
+- lib/tasks/treetop.rake
+- lib/tasks/corpus.rake
+- lib/VERSION
+- lib/mail/patterns.rb
+- lib/mail/message.rb
+- lib/mail/multibyte/unicode.rb
+- lib/mail/multibyte/chars.rb
+- lib/mail/multibyte/utils.rb
+- lib/mail/multibyte/exceptions.rb
+- lib/mail/header.rb
+- lib/mail/version_specific/ruby_1_9.rb
+- lib/mail/version_specific/ruby_1_8.rb
+- lib/mail/version.rb
+- lib/mail/mail.rb
+- lib/mail/multibyte.rb
+- lib/mail/elements/phrase_list.rb
+- lib/mail/elements/content_type_element.rb
+- lib/mail/elements/content_location_element.rb
+- lib/mail/elements/content_disposition_element.rb
+- lib/mail/elements/received_element.rb
+- lib/mail/elements/address_list.rb
+- lib/mail/elements/date_time_element.rb
+- lib/mail/elements/address.rb
+- lib/mail/elements/message_ids_element.rb
+- lib/mail/elements/mime_version_element.rb
+- lib/mail/elements/content_transfer_encoding_element.rb
+- lib/mail/elements/envelope_from_element.rb
+- lib/mail/envelope.rb
+- lib/mail/utilities.rb
+- lib/mail/field_list.rb
+- lib/mail/fields/resent_bcc_field.rb
+- lib/mail/fields/received_field.rb
+- lib/mail/fields/sender_field.rb
+- lib/mail/fields/content_disposition_field.rb
+- lib/mail/fields/resent_cc_field.rb
+- lib/mail/fields/content_location_field.rb
+- lib/mail/fields/cc_field.rb
+- lib/mail/fields/resent_to_field.rb
+- lib/mail/fields/references_field.rb
+- lib/mail/fields/resent_from_field.rb
+- lib/mail/fields/content_type_field.rb
+- lib/mail/fields/date_field.rb
+- lib/mail/fields/content_id_field.rb
+- lib/mail/fields/from_field.rb
+- lib/mail/fields/resent_sender_field.rb
+- lib/mail/fields/common/common_message_id.rb
+- lib/mail/fields/common/common_address.rb
+- lib/mail/fields/common/common_field.rb
+- lib/mail/fields/common/parameter_hash.rb
+- lib/mail/fields/common/common_date.rb
+- lib/mail/fields/common/address_container.rb
+- lib/mail/fields/content_description_field.rb
+- lib/mail/fields/in_reply_to_field.rb
+- lib/mail/fields/message_id_field.rb
+- lib/mail/fields/structured_field.rb
+- lib/mail/fields/mime_version_field.rb
+- lib/mail/fields/optional_field.rb
+- lib/mail/fields/to_field.rb
+- lib/mail/fields/return_path_field.rb
+- lib/mail/fields/unstructured_field.rb
+- lib/mail/fields/resent_date_field.rb
+- lib/mail/fields/reply_to_field.rb
+- lib/mail/fields/comments_field.rb
+- lib/mail/fields/resent_message_id_field.rb
+- lib/mail/fields/content_transfer_encoding_field.rb
+- lib/mail/fields/bcc_field.rb
+- lib/mail/fields/keywords_field.rb
+- lib/mail/fields/subject_field.rb
+- lib/mail/elements.rb
+- lib/mail/fields.rb
+- lib/mail/core_extensions/smtp.rb
+- lib/mail/core_extensions/shellwords.rb
+- lib/mail/core_extensions/string.rb
+- lib/mail/core_extensions/nil.rb
+- lib/mail/core_extensions/object.rb
+- lib/mail/core_extensions/string/multibyte.rb
+- lib/mail/core_extensions/string/access.rb
+- lib/mail/configuration.rb
+- lib/mail/body.rb
+- lib/mail/attachments_list.rb
+- lib/mail/encodings/7bit.rb
+- lib/mail/encodings/binary.rb
+- lib/mail/encodings/quoted_printable.rb
+- lib/mail/encodings/base64.rb
+- lib/mail/encodings/8bit.rb
+- lib/mail/encodings/transfer_encoding.rb
+- lib/mail/indifferent_hash.rb
+- lib/mail/field.rb
+- lib/mail/parsers/date_time.treetop
+- lib/mail/parsers/content_type.rb
+- lib/mail/parsers/received.rb
+- lib/mail/parsers/date_time.rb
+- lib/mail/parsers/rfc2045.treetop
+- lib/mail/parsers/message_ids.rb
+- lib/mail/parsers/phrase_lists.rb
+- lib/mail/parsers/rfc2822_obsolete.rb
+- lib/mail/parsers/envelope_from.treetop
+- lib/mail/parsers/content_disposition.rb
+- lib/mail/parsers/received.treetop
+- lib/mail/parsers/rfc2822_obsolete.treetop
+- lib/mail/parsers/mime_version.rb
+- lib/mail/parsers/phrase_lists.treetop
+- lib/mail/parsers/content_location.treetop
+- lib/mail/parsers/mime_version.treetop
+- lib/mail/parsers/rfc2822.treetop
+- lib/mail/parsers/content_transfer_encoding.rb
+- lib/mail/parsers/message_ids.treetop
+- lib/mail/parsers/content_disposition.treetop
+- lib/mail/parsers/rfc2045.rb
+- lib/mail/parsers/address_lists.rb
+- lib/mail/parsers/rfc2822.rb
+- lib/mail/parsers/content_type.treetop
+- lib/mail/parsers/content_location.rb
+- lib/mail/parsers/content_transfer_encoding.treetop
+- lib/mail/parsers/envelope_from.rb
+- lib/mail/parsers/address_lists.treetop
+- lib/mail/part.rb
+- lib/mail/encodings.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/delivery_methods/smtp.rb
+- lib/mail/network/delivery_methods/sendmail.rb
+- lib/mail/network/delivery_methods/test_mailer.rb
+- lib/mail/network/delivery_methods/smtp_connection.rb
+- lib/mail/network/delivery_methods/file_delivery.rb
+- lib/mail/network.rb
+- lib/mail/parts_list.rb
+has_rdoc: true
+homepage: http://github.com/mikel/mail
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Mail provides a nice Ruby DSL for making, sending and reading emails.
+test_files: []
+