mail-portertech 2.6.2.edge

data/Rakefile

@@ -0,0 +1,29 @@
+if !ENV["APPRAISAL_INITIALIZED"] && !ENV["TRAVIS"]
+  ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __FILE__)
+end
+require 'rubygems'
+require 'bundler/setup'
+
+require 'rake/testtask'
+require 'rspec/core/rake_task'
+
+desc "Build a gem file"
+task :build do
+  system "gem build mail.gemspec"
+end
+
+task :default => :spec
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.ruby_opts = '-w'
+  t.rspec_opts = %w(--backtrace --color)
+end
+
+begin
+  require "appraisal"
+rescue LoadError
+  warn "Appraisal is only available in test/development"
+end
+
+# load custom rake tasks
+Dir["#{File.dirname(__FILE__)}/tasks/**/*.rake"].sort.each { |ext| load ext }

data/TODO.rdoc

@@ -0,0 +1,9 @@
+== Not really in any order:
+
+* Add multibyte handling to fields, if they get a multibyte string, try encoding it into 
+  UTF-8 B first, if this fails, throw an error.
+
+* Cleanup the treetop parsers......... do I _really_ need that many entrance files?
+
+* Simplify the relationship of Headers and Fields.  Doing too much of the Field work
+  in the Header class on instantiating fields.  Header should just say "Field, do it!"

data/lib/mail.rb

@@ -0,0 +1,91 @@
+# encoding: utf-8
+module Mail # :doc:
+
+  require 'date'
+  require 'shellwords'
+
+  require 'uri'
+  require 'net/smtp'
+  require 'mime/types'
+
+  if RUBY_VERSION <= '1.8.6'
+    begin
+      require 'tlsmail'
+    rescue LoadError
+      raise "You need to install tlsmail if you are using ruby <= 1.8.6"
+    end
+  end
+
+  if RUBY_VERSION >= "1.9.0"
+    require 'mail/version_specific/ruby_1_9'
+    RubyVer = Ruby19
+  else
+    require 'mail/version_specific/ruby_1_8'
+    RubyVer = Ruby18
+  end
+
+  require 'mail/version'
+
+  require 'mail/core_extensions/nil'
+  require 'mail/core_extensions/object'
+  require 'mail/core_extensions/string'
+  require 'mail/core_extensions/smtp' if RUBY_VERSION < '1.9.3'
+  require 'mail/indifferent_hash'
+
+  # Only load our multibyte extensions if AS is not already loaded
+  if defined?(ActiveSupport)
+    require 'active_support/inflector'
+  else
+    require 'mail/core_extensions/string/access'
+    require 'mail/core_extensions/string/multibyte'
+    require 'mail/multibyte'
+  end
+
+  require 'mail/patterns'
+  require 'mail/utilities'
+  require 'mail/configuration'
+
+  @@autoloads = {}
+  def self.register_autoload(name, path)
+    @@autoloads[name] = path
+    autoload(name, path)
+  end
+
+  # This runs through the autoload list and explictly requires them for you.
+  # Useful when running mail in a threaded process.
+  #
+  # Usage:
+  #
+  #   require 'mail'
+  #   Mail.eager_autoload!
+  def self.eager_autoload!
+    @@autoloads.each { |_,path| require(path) }
+  end
+
+  # Autoload mail send and receive classes.
+  require 'mail/network'
+
+  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/envelope'
+
+  require 'mail/parsers'
+
+  # Autoload header field elements and transfer encodings.
+  require 'mail/elements'
+  require 'mail/encodings'
+  require 'mail/encodings/base64'
+  require 'mail/encodings/quoted_printable'
+
+  require 'mail/matchers/has_sent_mail'
+
+  # Finally... require all the Mail.methods
+  require 'mail/mail'
+end

data/lib/mail/attachments_list.rb

@@ -0,0 +1,104 @@
+module Mail
+  class AttachmentsList < Array
+
+    def initialize(parts_list)
+      @parts_list = parts_list
+      @content_disposition_type = 'attachment'
+      parts_list.map { |p|
+        if p.content_type == "message/rfc822"
+          Mail.new(p.body).attachments
+        elsif p.parts.empty?
+          p if p.attachment?
+        else
+          p.attachments
+        end
+      }.flatten.compact.each { |a| self << a }
+      self
+    end
+
+    def inline
+      @content_disposition_type = 'inline'
+      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)
+      encoded_name = Mail::Encodings.decode_encode name, :encode
+      default_values = { :content_type => "#{set_mime_type(name)}; filename=\"#{encoded_name}\"",
+                         :content_transfer_encoding => "#{guess_encoding}",
+                         :content_disposition => "#{@content_disposition_type}; filename=\"#{encoded_name}\"" }
+
+      if value.is_a?(Hash)
+
+        default_values[:body] = value.delete(:content) if value[:content]
+
+        default_values[:body] = value.delete(:data) if value[:data]
+
+        encoding = value.delete(:transfer_encoding) || value.delete(:encoding)
+        if encoding
+          if Mail::Encodings.defined? encoding
+            default_values[:content_transfer_encoding] = encoding
+          else
+            raise "Do not know how to handle Content Transfer Encoding #{encoding}, please choose either quoted-printable or base64"
+          end
+        end
+
+        if value[:mime_type]
+          default_values[:content_type] = value.delete(:mime_type)
+          @mime_type = MIME::Types[default_values[:content_type]].first
+          default_values[:content_transfer_encoding] ||= guess_encoding
+        end
+
+        hash = default_values.merge(value)
+      else
+        default_values[:body] = value
+        hash = default_values
+      end
+
+      if hash[:body].respond_to? :force_encoding and hash[:body].respond_to? :valid_encoding?
+        if not hash[:body].valid_encoding? and default_values[:content_transfer_encoding].downcase == "binary"
+          hash[:body].force_encoding("BINARY")
+        end
+      end
+
+      attachment = Part.new(hash)
+      attachment.add_content_id(hash[:content_id])
+
+      @parts_list << attachment
+    end
+
+    # Uses the mime type to try and guess the encoding, if it is a binary type, or unknown, then we
+    # set it to binary, otherwise as set to plain text
+    def guess_encoding
+      if @mime_type && !@mime_type.binary?
+        "7bit"
+      else
+        "binary"
+      end
+    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'
+        filename = filename.encode(Encoding::UTF_8) if filename.respond_to?(:encode)
+      end
+
+      @mime_type = MIME::Types.type_for(filename).first
+    end
+
+  end
+end

data/lib/mail/body.rb

@@ -0,0 +1,291 @@
+# encoding: utf-8
+module Mail
+  
+  # = Body
+  # 
+  # The body is where the text of the email is stored.  Mail treats the body
+  # as a single object.  The body itself has no information about boundaries
+  # used in the MIME standard, it just looks at its content as either a single
+  # block of text, or (if it is a multipart message) as an array of blocks of text.
+  # 
+  # A body has to be told to split itself up into a multipart message by calling
+  # #split with the correct boundary.  This is because the body object has no way
+  # of knowing what the correct boundary is for itself (there could be many
+  # boundaries in a body in the case of a nested MIME text).
+  # 
+  # Once split is called, Mail::Body will slice itself up on this boundary,
+  # assigning anything that appears before the first part to the preamble, and
+  # anything that appears after the closing boundary to the epilogue, then
+  # each part gets initialized into a Mail::Part object.
+  # 
+  # The boundary that is used to split up the Body is also stored in the Body
+  # object for use on encoding itself back out to a string.  You can 
+  # overwrite this if it needs to be changed.
+  # 
+  # On encoding, the body will return the preamble, then each part joined by
+  # the boundary, followed by a closing boundary string and then the epilogue.
+  class Body
+
+    def initialize(string = '')
+      @boundary = nil
+      @preamble = nil
+      @epilogue = nil
+      @charset  = nil
+      @part_sort_order = [ "text/plain", "text/enriched", "text/html" ]
+      @parts = Mail::PartsList.new
+      if string.blank?
+        @raw_source = ''
+      else
+        # 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 = (only_us_ascii? ? '7bit' : '8bit')
+      set_charset
+    end
+    
+    # Matches this body with another body.  Also matches the decoded value of this
+    # body with a string.
+    # 
+    # Examples:
+    # 
+    #   body = Mail::Body.new('The body')
+    #   body == body #=> true
+    #   
+    #   body = Mail::Body.new('The body')
+    #   body == 'The body' #=> true
+    #   
+    #   body = Mail::Body.new("VGhlIGJvZHk=\n")
+    #   body.encoding = 'base64'
+    #   body == "The body" #=> true
+    def ==(other)
+      if other.class == String
+        self.decoded == other
+      else
+        super
+      end
+    end
+    
+    # Accepts a string and performs a regular expression against the decoded text
+    # 
+    # Examples:
+    # 
+    #   body = Mail::Body.new('The body')
+    #   body =~ /The/ #=> 0
+    #   
+    #   body = Mail::Body.new("VGhlIGJvZHk=\n")
+    #   body.encoding = 'base64'
+    #   body =~ /The/ #=> 0
+    def =~(regexp)
+      self.decoded =~ regexp
+    end
+    
+    # Accepts a string and performs a regular expression against the decoded text
+    # 
+    # Examples:
+    # 
+    #   body = Mail::Body.new('The body')
+    #   body.match(/The/) #=> #<MatchData "The">
+    #   
+    #   body = Mail::Body.new("VGhlIGJvZHk=\n")
+    #   body.encoding = 'base64'
+    #   body.match(/The/) #=> #<MatchData "The">
+    def match(regexp)
+      self.decoded.match(regexp)
+    end
+
+    # Accepts anything that responds to #to_s and checks if it's a substring of the decoded text
+    #
+    # Examples:
+    #
+    #   body = Mail::Body.new('The body')
+    #   body.include?('The') #=> true
+    #
+    #   body = Mail::Body.new("VGhlIGJvZHk=\n")
+    #   body.encoding = 'base64'
+    #   body.include?('The') #=> true
+    def include?(other)
+      self.decoded.include?(other.to_s)
+    end
+
+    # Allows you to set the sort order of the parts, overriding the default sort order.
+    # Defaults to 'text/plain', then 'text/enriched', then 'text/html' with any other content
+    # type coming after.
+    def set_sort_order(order)
+      @part_sort_order = order
+    end
+    
+    # Allows you to sort the parts according to the default sort order, or the sort order you
+    # set with :set_sort_order.
+    #
+    # sort_parts! is also called from :encode, so there is no need for you to call this explicitly
+    def sort_parts!
+      @parts.each do |p|
+        p.body.set_sort_order(@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
+    # any tampering
+    def raw_source
+      @raw_source
+    end
+   
+    def get_best_encoding(target)
+      target_encoding = Mail::Encodings.get_encoding(target)
+      target_encoding.get_best_compatible(encoding, raw_source)
+    end
+ 
+    # Returns a body encoded using transfer_encoding.  Multipart always uses an
+    # identiy encoding (i.e. no encoding).
+    # Calling this directly is not a good idea, but supported for compatibility
+    # TODO: Validate that preamble and epilogue are valid for requested encoding
+    def encoded(transfer_encoding = '8bit')
+      if multipart?
+        self.sort_parts!
+        encoded_parts = parts.map { |p| p.encoded }
+        ([preamble] + encoded_parts).join(crlf_boundary) + end_boundary + epilogue.to_s
+      else
+        be = get_best_encoding(transfer_encoding)
+        dec = Mail::Encodings::get_encoding(encoding)
+        enc = Mail::Encodings::get_encoding(be)
+        if transfer_encoding == encoding and dec.nil?
+            # Cannot decode, so skip normalization
+            raw_source
+        else
+            # Decode then encode to normalize and allow transforming 
+            # from base64 to Q-P and vice versa
+            decoded = dec.decode(raw_source)
+            if defined?(Encoding) && charset && charset != "US-ASCII"
+              decoded.encode!(charset)
+              decoded.force_encoding('BINARY') unless Encoding.find(charset).ascii_compatible?
+            end
+            enc.encode(decoded)
+        end
+      end
+    end
+    
+    def decoded
+      if !Encodings.defined?(encoding)
+        raise UnknownEncodingType, "Don't know how to decode #{encoding}, please call #encoded and decode it yourself."
+      else
+        Encodings.get_encoding(encoding).decode(raw_source)
+      end
+    end
+    
+    def to_s
+      decoded
+    end
+    
+    def charset
+      @charset
+    end
+    
+    def charset=( val )
+      @charset = val
+    end
+
+    def encoding(val = nil)
+      if val
+        self.encoding = val
+      else
+        @encoding
+      end
+    end
+    
+    def encoding=( val )
+      @encoding = if val == "text" || val.blank?
+          (only_us_ascii? ? '7bit' : '8bit')
+      else
+          val
+      end
+    end
+
+    # Returns the preamble (any text that is before the first MIME boundary)
+    def preamble
+      @preamble
+    end
+
+    # Sets the preamble to a string (adds text before the first MIME boundary)
+    def preamble=( val )
+      @preamble = val
+    end
+    
+    # Returns the epilogue (any text that is after the last MIME boundary)
+    def epilogue
+      @epilogue
+    end
+    
+    # Sets the epilogue to a string (adds text after the last MIME boundary)
+    def epilogue=( val )
+      @epilogue = val
+    end
+    
+    # Returns true if there are parts defined in the body
+    def multipart?
+      true unless parts.empty?
+    end
+    
+    # Returns the boundary used by the body
+    def boundary
+      @boundary
+    end
+    
+    # Allows you to change the boundary of this Body object
+    def boundary=( val )
+      @boundary = val
+    end
+
+    def parts
+      @parts
+    end
+    
+    def <<( val )
+      if @parts
+        @parts << val
+      else
+        @parts = Mail::PartsList.new[val]
+      end
+    end
+    
+    def split!(boundary)
+      self.boundary = boundary
+      parts = raw_source.split(/(?:\A|\r\n)--#{Regexp.escape(boundary || "")}(?=(?:--)?\s*$)/)
+      # Make the preamble equal to the preamble (if any)
+      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[1...-1].to_a.each { |part| @parts << Mail::Part.new(part) }
+      self
+    end
+    
+    def only_us_ascii?
+      !(raw_source =~ /[^\x01-\x7f]/)
+    end
+    
+    def empty?
+      !!raw_source.to_s.empty?
+    end
+    
+    private
+    
+    def crlf_boundary
+      "\r\n--#{boundary}\r\n"
+    end
+    
+    def end_boundary
+      "\r\n--#{boundary}--\r\n"
+    end
+    
+    def set_charset
+      only_us_ascii? ? @charset = 'US-ASCII' : @charset = nil
+    end
+  end
+end