mail 1.0.0

data/lib/mail/elements/content_disposition_element.rb

@@ -0,0 +1,34 @@
+# encoding: utf-8
+module Mail
+  class ContentDispositionElement # :nodoc:
+    
+    include Mail::Utilities
+    
+    def initialize( string )
+      parser = Mail::ContentDispositionParser.new
+      if tree = parser.parse(cleaned(string))
+        @disposition_type = tree.disposition_type.text_value
+        @parameters = tree.parameters
+      else
+        raise Mail::Field::ParseError, "ContentDispositionElement can not parse |#{string}|\nReason was: #{parser.failure_reason}\n"
+      end
+    end
+    
+    def disposition_type
+      @disposition_type
+    end
+    
+    def parameters
+      @parameters
+    end
+    
+    def to_s(*args)
+
+    end
+    
+    def cleaned(string)
+      string =~ /(.+);\s*$/ ? $1 : string
+    end
+    
+  end
+end

data/lib/mail/elements/content_transfer_encoding_element.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+module Mail
+  class ContentTransferEncodingElement
+    
+    include Mail::Utilities
+    
+    def initialize( string )
+      parser = Mail::ContentTransferEncodingParser.new
+      if tree = parser.parse(string.downcase)
+        @encoding = tree.encoding.text_value
+      else
+        raise Mail::Field::ParseError, "ContentTransferEncodingElement can not parse |#{string}|\nReason was: #{parser.failure_reason}\n"
+      end
+    end
+    
+    def encoding
+      @encoding
+    end
+    
+  end
+end

data/lib/mail/elements/content_type_element.rb

@@ -0,0 +1,39 @@
+# encoding: utf-8
+module Mail
+  class ContentTypeElement # :nodoc:
+    
+    include Mail::Utilities
+    
+    def initialize( string )
+      parser = Mail::ContentTypeParser.new
+      if tree = parser.parse(cleaned(string))
+        @main_type = tree.main_type.text_value
+        @sub_type = tree.sub_type.text_value
+        @parameters = tree.parameters
+      else
+        raise Mail::Field::ParseError, "ContentTypeElement can not parse |#{string}|\nReason was: #{parser.failure_reason}\n"
+      end
+    end
+    
+    def main_type
+      @main_type
+    end
+    
+    def sub_type
+      @sub_type
+    end
+    
+    def parameters
+      @parameters
+    end
+    
+    def to_s(*args)
+
+    end
+    
+    def cleaned(string)
+      string =~ /(.+);\s*$/ ? $1 : string
+    end
+    
+  end
+end

data/lib/mail/elements/date_time_element.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+module Mail
+  class DateTimeElement # :nodoc:
+    
+    include Mail::Utilities
+    
+    def initialize( string )
+      parser = Mail::DateTimeParser.new
+      if tree = parser.parse(string)
+        @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"
+      end
+    end
+    
+    def date_string
+      @date_string
+    end
+    
+    def time_string
+      @time_string
+    end
+    
+  end
+end

data/lib/mail/elements/envelope_from_element.rb

@@ -0,0 +1,34 @@
+# encoding: utf-8
+module Mail
+  class EnvelopeFromElement
+    
+    include Mail::Utilities
+    
+    def initialize( string )
+      parser = Mail::EnvelopeFromParser.new
+      if @tree = parser.parse(string)
+        @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"
+      end
+    end
+    
+    def tree
+      @tree
+    end
+    
+    def date_time
+      @date_time
+    end
+    
+    def address
+      @address
+    end
+    
+    def to_s(*args)
+      "#{@info}; #{@date_time.to_s(*args)}"
+    end
+    
+  end
+end

data/lib/mail/elements/message_ids_element.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+module Mail
+  class MessageIdsElement
+    
+    include Mail::Utilities
+    
+    def initialize(string)
+      parser = Mail::MessageIdsParser.new
+      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"
+      end
+    end
+    
+    def message_ids
+      @message_ids
+    end
+    
+    def message_id
+      @message_ids.first
+    end
+    
+    def clean_msg_id( val )
+      val =~ /.*<(.*)>.*/ ; $1
+    end
+
+  end
+end

data/lib/mail/elements/mime_version_element.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+module Mail
+  class MimeVersionElement
+    
+    include Mail::Utilities
+    
+    def initialize( string )
+      parser = Mail::MimeVersionParser.new
+      if tree = parser.parse(string)
+        @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"
+      end
+    end
+    
+    def major
+      @major
+    end
+    
+    def minor
+      @minor
+    end
+    
+  end
+end

data/lib/mail/elements/phrase_list.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+module Mail
+  class PhraseList
+    
+    include Mail::Utilities
+    
+    def initialize(string)
+      parser = Mail::PhraseListsParser.new
+      if tree = parser.parse(string)
+        @phrases = tree.phrases
+      else
+        raise Mail::Field::ParseError, "PhraseList can not parse |#{string}|\nReason was: #{parser.failure_reason}\n"
+      end
+    end
+    
+    def phrases
+      @phrases.map { |p| unquote(p.text_value) }
+    end
+
+  end
+end

data/lib/mail/elements/received_element.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+module Mail
+  class ReceivedElement
+    
+    include Mail::Utilities
+    
+    def initialize( string )
+      parser = Mail::ReceivedParser.new
+      if tree = parser.parse(string)
+        @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"
+      end
+    end
+    
+    def date_time
+      @date_time
+    end
+    
+    def info
+      @info
+    end
+    
+    def to_s(*args)
+      "#{@info}; #{@date_time.to_s(*args)}"
+    end
+    
+  end
+end

data/lib/mail/encodings/base64.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+module Mail
+  module Encodings
+    class Base64
+      
+      # 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 )
+      end
+    end
+  end
+end

data/lib/mail/encodings/encodings.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+module Mail
+  module Encodings
+    
+    def Encodings.defined?( str )
+      string = str.to_s.split(/[_-]/).map { |v| v.capitalize }.join('')
+      RubyVer.has_constant?(Mail::Encodings, string)
+    end
+    
+    def Encodings.get_encoding( str )
+      string = str.to_s.split(/[_-]/).map { |v| v.capitalize }.join('')
+      RubyVer.get_constant(Mail::Encodings, string)
+    end
+    
+    def Encodings.b_encode(str, encoding = nil)
+      RubyVer.b_encode(str, encoding)
+    end
+    
+    def Encodings.q_encode(str, encoding = nil)
+      RubyVer.q_encode(str, encoding)
+    end
+    
+  end
+end

data/lib/mail/encodings/quoted_printable.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+module Mail
+  module Encodings
+    class QuotedPrintable
+    
+      # Decode the string from Quoted-Printable
+      def self.decode(str)
+        str.unpack("M*").first
+      end
+
+      def self.encode(str)
+        str.gsub( /[^a-z ]/i ) { quoted_printable_encode($&) }.gsub( / /, "_" )
+      end
+
+      private
+
+      # Convert the given character to quoted printable format, taking into
+      # account multi-byte characters (if executing with $KCODE="u", for instance)
+      def self.quoted_printable_encode(character)
+        result = ""
+        character.each_byte { |b| result << "=%02X" % b }
+        result
+      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,202 @@
+# 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-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 text string in the format of:
+    # 
+    #  "field-name: field data"
+    # 
+    # Note, does not want a terminating carriage return.  Returns
+    # self appropriately parsed
+    def initialize(raw_field_text)
+      if raw_field_text !~ /:/
+        name = raw_field_text
+        create_field(name, nil)
+      else
+        name, value = split(raw_field_text)
+        create_field(name, value)
+      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=(str)
+      create_field(name, str)
+    end
+    
+    def to_s
+      field.to_s
+    end
+    
+    def update(name, value)
+      create_field(name, value)
+    end
+    
+    def same( other )
+      match_to_s(other.name, field.name)
+    end
+    
+    def <=>( other )
+      self_order = FIELD_ORDER.rindex(self.name.downcase) || 100
+      other_order = FIELD_ORDER.rindex(other.name.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-disposition content-description ]
+    
+    private
+    
+    def split(raw_field)
+      match_data = raw_field.match(/^(#{FIELD_NAME})\s*:\s*(#{FIELD_BODY})$/)
+      [match_data[1].to_s.strip, match_data[2].to_s.strip]
+    rescue
+      STDERR.puts "WARNING: Could not parse (and so ignorning) '#{raw_field}'"
+    end
+
+    def create_field(name, value)
+      begin
+        self.field = new_field(name, value)
+      rescue
+        self.field = Mail::UnstructuredField.new(name, value)
+      end
+    end
+
+    def new_field(name, value)
+      # Could do this with constantize and make it as DRY as, but a simple case is,
+      # well, simpler... 
+      case name.downcase
+      when /^to$/
+        ToField.new(name,value)
+      when /^cc$/
+        CcField.new(name,value)
+      when /^bcc$/
+        BccField.new(name, value)
+      when /^message-id$/
+        MessageIdField.new(name, value)
+      when /^in-reply-to$/
+        InReplyToField.new(name, value)
+      when /^references$/
+        ReferencesField.new(name, value)
+      when /^subject$/
+        SubjectField.new(name, value)
+      when /^comments$/
+        CommentsField.new(name, value)
+      when /^keywords$/
+        KeywordsField.new(name, value)
+      when /^date$/
+        DateField.new(name, value)
+      when /^from$/
+        FromField.new(name, value)
+      when /^sender$/
+        SenderField.new(name, value)
+      when /^reply-to$/
+        ReplyToField.new(name, value)
+      when /^resent-date$/
+        ResentDateField.new(name, value)
+      when /^resent-from$/
+        ResentFromField.new(name, value)
+      when /^resent-sender$/ 
+        ResentSenderField.new(name, value)
+      when /^resent-to$/
+        ResentToField.new(name, value)
+      when /^resent-cc$/
+        ResentCcField.new(name, value)
+      when /^resent-bcc$/
+        ResentBccField.new(name, value)
+      when /^resent-message-id$/
+        ResentMessageIdField.new(name, value)
+      when /^return-path$/
+        ReturnPathField.new(name, value)
+      when /^received$/
+        ReceivedField.new(name, value)
+      when /^mime-version$/
+        MimeVersionField.new(name, value)
+      when /^content-transfer-encoding$/
+        ContentTransferEncodingField.new(name, value)
+      when /^content-description$/
+        ContentDescriptionField.new(name, value)
+      when /^content-disposition$/
+        ContentDispositionField.new(name, value)
+      when /^content-type$/
+        ContentTypeField.new(name, value)
+      when /^content-id$/
+        ContentIdField.new(name, value)
+      else 
+        OptionalField.new(name, value)
+      end
+      
+    end
+
+  end
+  
+end