mail-trunk 2.3.0

data/lib/mail/encodings/7bit.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+require 'mail/encodings/8bit'
+
+module Mail
+  module Encodings
+    class SevenBit < EightBit
+      NAME = '7bit'
+    
+      PRIORITY = 1
+
+      # 7bit and 8bit operate the same
+      
+      # Decode the string
+      def self.decode(str)
+        super
+      end
+    
+      # Encode the string
+      def self.encode(str)
+        super
+      end
+     
+      # Idenity encodings have a fixed cost, 1 byte out per 1 byte in
+      def self.cost(str)
+        super 
+      end
+
+      Encodings.register(NAME, self) 
+    end
+  end
+end

data/lib/mail/encodings/8bit.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+require 'mail/encodings/binary'
+
+module Mail
+  module Encodings
+    class EightBit < Binary
+      NAME = '8bit'
+
+      PRIORITY = 4
+
+      # 8bit is an identiy encoding, meaning nothing to do
+      
+      # Decode the string
+      def self.decode(str)
+        str.to_lf
+      end
+    
+      # Encode the string
+      def self.encode(str)
+        str.to_crlf
+      end
+     
+      # Idenity encodings have a fixed cost, 1 byte out per 1 byte in
+      def self.cost(str)
+        1.0
+      end
+
+      Encodings.register(NAME, self) 
+    end
+  end
+end

data/lib/mail/encodings/base64.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+require 'mail/encodings/7bit'
+
+module Mail
+  module Encodings
+    class Base64 < SevenBit
+      NAME = 'base64'
+     
+      PRIORITY = 3
+ 
+      def self.can_encode?(enc)
+        true
+      end
+
+      # Decode the string from Base64
+      def self.decode(str)
+        RubyVer.decode_base64( str )
+      end
+    
+      # Encode the string to Base64
+      def self.encode(str)
+        RubyVer.encode_base64( str ).to_crlf
+      end
+
+      # Base64 has a fixed cost, 4 bytes out per 3 bytes in
+      def self.cost(str)
+        4.0/3
+      end
+
+      Encodings.register(NAME, self)      
+    end
+  end
+end

data/lib/mail/encodings/binary.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+require 'mail/encodings/transfer_encoding'
+
+module Mail
+  module Encodings
+    class Binary < TransferEncoding
+      NAME = 'binary'
+
+      PRIORITY = 5
+
+      # Binary is an identiy encoding, meaning nothing to do
+      
+      # Decode the string
+      def self.decode(str)
+        str
+      end
+    
+      # Encode the string
+      def self.encode(str)
+        str
+      end
+     
+      # Idenity encodings have a fixed cost, 1 byte out per 1 byte in
+      def self.cost(str)
+        1.0
+      end
+
+      Encodings.register(NAME, self) 
+    end
+  end
+end

data/lib/mail/encodings/quoted_printable.rb

@@ -0,0 +1,38 @@
+# encoding: utf-8
+require 'mail/encodings/7bit'
+
+module Mail
+  module Encodings
+    class QuotedPrintable < SevenBit
+      NAME='quoted-printable'
+   
+      PRIORITY = 2
+
+      def self.can_encode?(str)
+        EightBit.can_encode? str
+      end
+
+      # Decode the string from Quoted-Printable
+      def self.decode(str)
+        str.unpack("M*").first
+      end
+
+      def self.encode(str)
+        [str].pack("M").gsub(/\n/, "\r\n")
+      end
+
+      def self.cost(str)
+        # These bytes probably do not need encoding
+        c = str.count("\x9\xA\xD\x20-\x3C\x3E-\x7E")
+        # Everything else turns into =XX where XX is a 
+        # two digit hex number (taking 3 bytes)
+        total = (str.bytesize - c)*3 + c
+        total.to_f/str.bytesize
+      end
+        
+      private
+
+      Encodings.register(NAME, self)
+    end
+  end
+end

data/lib/mail/encodings/transfer_encoding.rb

@@ -0,0 +1,58 @@
+# encoding: utf-8
+module Mail
+  module Encodings
+    class TransferEncoding
+      NAME = ''
+
+      PRIORITY = -1
+
+      def self.can_transport?(enc)
+        enc = Encodings.get_name(enc)
+        if Encodings.defined? enc
+          Encodings.get_encoding(enc).new.is_a? self
+        else
+          false
+        end
+      end
+
+      def self.can_encode?(enc)
+        can_transport? enc 
+      end
+
+      def self.cost(str)
+        raise "Unimplemented"
+      end
+
+      def self.to_s
+        self::NAME
+      end
+
+      def self.get_best_compatible(source_encoding, str)
+        if self.can_transport? source_encoding then
+            source_encoding 
+        else
+            choices = []
+            Encodings.get_all.each do |enc|
+                choices << enc if self.can_transport? enc and enc.can_encode? source_encoding
+            end
+            best = nil 
+            best_cost = 100
+            choices.each do |enc|
+                this_cost = enc.cost str
+                if this_cost < best_cost then
+                    best_cost = this_cost
+                    best = enc
+                elsif this_cost == best_cost then 
+                    best = enc if enc::PRIORITY < best::PRIORITY
+                end
+            end
+            best
+        end
+      end
+
+      def to_s
+        self.class.to_s
+      end
+    end
+  end
+end

data/lib/mail/envelope.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+# 
+# = Mail Envelope
+# 
+# The Envelope class provides a field for the first line in an
+# mbox file, that looks like "From mikel@test.lindsaar.net DATETIME"
+# 
+# This envelope class reads that line, and turns it into an
+# Envelope.from and Envelope.date for your use.
+module Mail
+  class Envelope < StructuredField
+    
+    def initialize(*args)
+      super(FIELD_NAME, strip_field(FIELD_NAME, args.last))
+    end
+    
+    def tree
+      @element ||= Mail::EnvelopeFromElement.new(value)
+      @tree ||= @element.tree
+    end
+    
+    def element
+      @element ||= Mail::EnvelopeFromElement.new(value)
+    end
+    
+    def date
+      ::DateTime.parse("#{element.date_time}")
+    end
+
+    def from
+      element.address
+    end
+    
+  end
+end

data/lib/mail/field.rb

@@ -0,0 +1,224 @@
+require 'mail/fields'
+
+# encoding: utf-8
+module Mail
+  # Provides a single class to call to create a new structured or unstructured
+  # field.  Works out per RFC what field of field it is being given and returns
+  # the correct field of class back on new.
+  # 
+  # ===Per RFC 2822
+  #  
+  #  2.2. Header Fields
+  #  
+  #     Header fields are lines composed of a field name, followed by a colon
+  #     (":"), followed by a field body, and terminated by CRLF.  A field
+  #     name MUST be composed of printable US-ASCII characters (i.e.,
+  #     characters that have values between 33 and 126, inclusive), except
+  #     colon.  A field body may be composed of any US-ASCII characters,
+  #     except for CR and LF.  However, a field body may contain CRLF when
+  #     used in header "folding" and  "unfolding" as described in section
+  #     2.2.3.  All field bodies MUST conform to the syntax described in
+  #     sections 3 and 4 of this standard.
+  #  
+  class Field
+    
+    include Patterns
+    include Comparable
+    
+    STRUCTURED_FIELDS = %w[ bcc cc content-description content-disposition
+                            content-id content-location content-transfer-encoding
+                            content-type date from in-reply-to keywords message-id
+                            mime-version received references reply-to
+                            resent-bcc resent-cc resent-date resent-from
+                            resent-message-id resent-sender resent-to
+                            return-path sender to ]
+
+    KNOWN_FIELDS = STRUCTURED_FIELDS + ['comments', 'subject']
+    
+    # Generic Field Exception
+    class FieldError < StandardError
+    end
+
+    # 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:
+    end
+
+    # Raised when attempting to set a structured field's contents to an invalid syntax
+    class SyntaxError < FieldError #:nodoc:
+    end
+    
+    # Accepts a string:
+    # 
+    #  Field.new("field-name: field data")
+    # 
+    # Or name, value pair:
+    # 
+    #  Field.new("field-name", "value")
+    # 
+    # Or a name by itself:
+    # 
+    #  Field.new("field-name")
+    # 
+    # Note, does not want a terminating carriage return.  Returns
+    # self appropriately parsed.  If value is not a string, then
+    # it will be passed through as is, for example, content-type
+    # field can accept an array with the type and a hash of 
+    # parameters:
+    # 
+    #  Field.new('content-type', ['text', 'plain', {:charset => 'UTF-8'}])
+    def initialize(name, value = nil, charset = 'utf-8')
+      case
+      when name =~ /:/                  # Field.new("field-name: field data")
+        charset = value unless value.blank?
+        name, value = split(name)
+        create_field(name, value, charset)
+      when name !~ /:/ && value.blank?  # Field.new("field-name")
+        create_field(name, nil, charset)
+      else                              # Field.new("field-name", "value")
+        create_field(name, value, charset)
+      end
+      return self
+    end
+
+    def field=(value)
+      @field = value
+    end
+    
+    def field
+      @field
+    end
+    
+    def name
+      field.name
+    end
+    
+    def value
+      field.value
+    end
+    
+    def value=(val)
+      create_field(name, val, charset)
+    end
+    
+    def to_s
+      field.to_s
+    end
+    
+    def update(name, value)
+      create_field(name, value, charset)
+    end
+    
+    def same( other )
+      match_to_s(other.name, field.name)
+    end
+    
+    def <=>( other )
+      self_order = FIELD_ORDER.rindex(self.name.to_s.downcase) || 100
+      other_order = FIELD_ORDER.rindex(other.name.to_s.downcase) || 100
+      self_order <=> other_order
+    end
+    
+    def method_missing(name, *args, &block)
+      field.send(name, *args, &block)
+    end
+    
+    FIELD_ORDER = %w[ return-path received
+                      resent-date resent-from resent-sender resent-to
+                      resent-cc resent-bcc resent-message-id
+                      date from sender reply-to to cc bcc
+                      message-id in-reply-to references
+                      subject comments keywords
+                      mime-version content-type content-transfer-encoding
+                      content-location content-disposition content-description ]
+    
+    private
+    
+    def split(raw_field)
+      match_data = raw_field.mb_chars.match(/^(#{FIELD_NAME})\s*:\s*(#{FIELD_BODY})?$/)
+      [match_data[1].to_s.mb_chars.strip, match_data[2].to_s.mb_chars.strip]
+    rescue
+      STDERR.puts "WARNING: Could not parse (and so ignorning) '#{raw_field}'"
+    end
+    
+    def create_field(name, value, charset)
+      begin
+        self.field = new_field(name, value, charset)
+      rescue Mail::Field::ParseError => e
+        self.field = Mail::UnstructuredField.new(name, value)
+        self.field.errors << [name, value, e]
+        self.field
+      end
+    end
+
+    def new_field(name, value, charset)
+      # Could do this with constantize and make it "as DRY as", but a simple case 
+      # statement is, well, simpler... 
+      case name.to_s.downcase
+      when /^to$/i
+        ToField.new(value, charset)
+      when /^cc$/i
+        CcField.new(value, charset)
+      when /^bcc$/i
+        BccField.new(value, charset)
+      when /^message-id$/i
+        MessageIdField.new(value, charset)
+      when /^in-reply-to$/i
+        InReplyToField.new(value, charset)
+      when /^references$/i
+        ReferencesField.new(value, charset)
+      when /^subject$/i
+        SubjectField.new(value, charset)
+      when /^comments$/i
+        CommentsField.new(value, charset)
+      when /^keywords$/i
+        KeywordsField.new(value, charset)
+      when /^date$/i
+        DateField.new(value, charset)
+      when /^from$/i
+        FromField.new(value, charset)
+      when /^sender$/i
+        SenderField.new(value, charset)
+      when /^reply-to$/i
+        ReplyToField.new(value, charset)
+      when /^resent-date$/i
+        ResentDateField.new(value, charset)
+      when /^resent-from$/i
+        ResentFromField.new(value, charset)
+      when /^resent-sender$/i 
+        ResentSenderField.new(value, charset)
+      when /^resent-to$/i
+        ResentToField.new(value, charset)
+      when /^resent-cc$/i
+        ResentCcField.new(value, charset)
+      when /^resent-bcc$/i
+        ResentBccField.new(value, charset)
+      when /^resent-message-id$/i
+        ResentMessageIdField.new(value, charset)
+      when /^return-path$/i
+        ReturnPathField.new(value, charset)
+      when /^received$/i
+        ReceivedField.new(value, charset)
+      when /^mime-version$/i
+        MimeVersionField.new(value, charset)
+      when /^content-transfer-encoding$/i
+        ContentTransferEncodingField.new(value, charset)
+      when /^content-description$/i
+        ContentDescriptionField.new(value, charset)
+      when /^content-disposition$/i
+        ContentDispositionField.new(value, charset)
+      when /^content-type$/i
+        ContentTypeField.new(value, charset)
+      when /^content-id$/i
+        ContentIdField.new(value, charset)
+      when /^content-location$/i
+        ContentLocationField.new(value, charset)
+      else 
+        OptionalField.new(name, value, charset)
+      end
+      
+    end
+
+  end
+  
+end