mail-portertech 2.6.2.edge

data/lib/mail/fields/date_field.rb

@@ -0,0 +1,57 @@
+# encoding: utf-8
+#
+# = Date Field
+#
+# The Date field inherits from StructuredField and handles the Date: header
+# field in the email.
+#
+# Sending date to a mail message will instantiate a Mail::Field object that
+# has a DateField as its field type.  This includes all Mail::CommonAddress
+# module instance methods.
+#
+# There must be excatly one Date field in an RFC2822 email.
+#
+# == Examples:
+#
+#  mail = Mail.new
+#  mail.date = 'Mon, 24 Nov 1997 14:22:01 -0800'
+#  mail.date       #=> #<DateTime: 211747170121/86400,-1/3,2299161>
+#  mail.date.to_s  #=> 'Mon, 24 Nov 1997 14:22:01 -0800'
+#  mail[:date]     #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::DateField:0x180e1c4
+#  mail['date']    #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::DateField:0x180e1c4
+#  mail['Date']    #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::DateField:0x180e1c4
+#
+require 'mail/fields/common/common_date'
+
+module Mail
+  class DateField < StructuredField
+
+    include Mail::CommonDate
+
+    FIELD_NAME = 'date'
+    CAPITALIZED_FIELD = "Date"
+
+    def initialize(value = nil, charset = 'utf-8')
+      self.charset = charset
+      if value.blank?
+        value = ::DateTime.now.strftime('%a, %d %b %Y %H:%M:%S %z')
+      else
+        value = strip_field(FIELD_NAME, value)
+        value.to_s.gsub!(/\(.*?\)/, '')
+        value = ::DateTime.parse(value.to_s.squeeze(" ")).strftime('%a, %d %b %Y %H:%M:%S %z')
+      end
+      super(CAPITALIZED_FIELD, value, charset)
+    rescue ArgumentError => e
+      raise e unless "invalid date"==e.message
+    end
+
+    def encoded
+      do_encode(CAPITALIZED_FIELD)
+    end
+
+    def decoded
+      do_decode
+    end
+
+  end
+end

data/lib/mail/fields/from_field.rb

@@ -0,0 +1,55 @@
+# encoding: utf-8
+# 
+# = From Field
+# 
+# The From field inherits from StructuredField and handles the From: header
+# field in the email.
+# 
+# Sending from to a mail message will instantiate a Mail::Field object that
+# has a FromField as its field type.  This includes all Mail::CommonAddress
+# module instance metods.
+# 
+# Only one From field can appear in a header, though it can have multiple
+# addresses and groups of addresses.
+# 
+# == Examples:
+# 
+#  mail = Mail.new
+#  mail.from = 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
+#  mail.from    #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
+#  mail[:from]  #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::FromField:0x180e1c4
+#  mail['from'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::FromField:0x180e1c4
+#  mail['From'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::FromField:0x180e1c4
+# 
+#  mail[:from].encoded   #=> 'from: Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net\r\n'
+#  mail[:from].decoded   #=> 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
+#  mail[:from].addresses #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
+#  mail[:from].formatted #=> ['Mikel Lindsaar <mikel@test.lindsaar.net>', 'ada@test.lindsaar.net']
+# 
+require 'mail/fields/common/common_address'
+
+module Mail
+  class FromField < StructuredField
+    
+    include Mail::CommonAddress
+    
+    FIELD_NAME = 'from'
+    CAPITALIZED_FIELD = 'From'
+    
+    def initialize(value = nil, charset = 'utf-8')
+      self.charset = charset
+      super(CAPITALIZED_FIELD, strip_field(FIELD_NAME, value), charset)
+      self.parse
+      self
+    end
+    
+    def encoded
+      do_encode(CAPITALIZED_FIELD)
+    end
+    
+    def decoded
+      do_decode
+    end
+
+  end
+end

data/lib/mail/fields/in_reply_to_field.rb

@@ -0,0 +1,56 @@
+# encoding: utf-8
+# 
+# = In-Reply-To Field
+# 
+# The In-Reply-To field inherits from StructuredField and handles the 
+# In-Reply-To: header field in the email.
+# 
+# Sending in_reply_to to a mail message will instantiate a Mail::Field object that
+# has a InReplyToField as its field type.  This includes all Mail::CommonMessageId
+# module instance metods.
+# 
+# Note that, the #message_ids method will return an array of message IDs without the
+# enclosing angle brackets which per RFC are not syntactically part of the message id.
+# 
+# Only one InReplyTo field can appear in a header, though it can have multiple
+# Message IDs.
+# 
+# == Examples:
+# 
+#  mail = Mail.new
+#  mail.in_reply_to = '<F6E2D0B4-CC35-4A91-BA4C-C7C712B10C13@test.me.dom>'
+#  mail.in_reply_to    #=> '<F6E2D0B4-CC35-4A91-BA4C-C7C712B10C13@test.me.dom>'
+#  mail[:in_reply_to]  #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::InReplyToField:0x180e1c4
+#  mail['in_reply_to'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::InReplyToField:0x180e1c4
+#  mail['In-Reply-To'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::InReplyToField:0x180e1c4
+# 
+#  mail[:in_reply_to].message_ids #=> ['F6E2D0B4-CC35-4A91-BA4C-C7C712B10C13@test.me.dom']
+# 
+require 'mail/fields/common/common_message_id'
+
+module Mail
+  class InReplyToField < StructuredField
+    
+    include Mail::CommonMessageId
+    
+    FIELD_NAME = 'in-reply-to'
+    CAPITALIZED_FIELD = 'In-Reply-To'
+    
+    def initialize(value = nil, charset = 'utf-8')
+      self.charset = charset
+      value = value.join("\r\n\s") if value.is_a?(Array)
+      super(CAPITALIZED_FIELD, strip_field(FIELD_NAME, value), charset)
+      self.parse
+      self
+    end
+    
+    def encoded
+      do_encode(CAPITALIZED_FIELD)
+    end
+    
+    def decoded
+      do_decode
+    end
+    
+  end
+end

data/lib/mail/fields/keywords_field.rb

@@ -0,0 +1,44 @@
+# encoding: utf-8
+# 
+# keywords        =       "Keywords:" phrase *("," phrase) CRLF
+module Mail
+  class KeywordsField < StructuredField
+    
+    FIELD_NAME = 'keywords'
+    CAPITALIZED_FIELD = 'Keywords'
+    
+    def initialize(value = nil, charset = 'utf-8')
+      self.charset = charset
+      super(CAPITALIZED_FIELD, strip_field(FIELD_NAME, value), charset)
+      self.parse
+      self
+    end
+
+    def parse(val = value)
+      unless val.blank?
+        @phrase_list ||= PhraseList.new(value)
+      end
+    end
+    
+    def phrase_list
+      @phrase_list ||= PhraseList.new(value)
+    end
+      
+    def keywords
+      phrase_list.phrases
+    end
+    
+    def encoded
+      "#{CAPITALIZED_FIELD}: #{keywords.join(",\r\n ")}\r\n"
+    end
+    
+    def decoded
+      keywords.join(', ')
+    end
+
+    def default
+      keywords
+    end
+    
+  end
+end

data/lib/mail/fields/message_id_field.rb

@@ -0,0 +1,82 @@
+# encoding: utf-8
+# 
+# = Message-ID Field
+# 
+# The Message-ID field inherits from StructuredField and handles the 
+# Message-ID: header field in the email.
+# 
+# Sending message_id to a mail message will instantiate a Mail::Field object that
+# has a MessageIdField as its field type.  This includes all Mail::CommonMessageId
+# module instance metods.
+# 
+# Only one MessageId field can appear in a header, and syntactically it can only have
+# one Message ID.  The message_ids method call has been left in however as it will only
+# return the one message id, ie, an array of length 1.
+# 
+# Note that, the #message_ids method will return an array of message IDs without the
+# enclosing angle brackets which per RFC are not syntactically part of the message id.
+# 
+# == Examples:
+# 
+#  mail = Mail.new
+#  mail.message_id = '<F6E2D0B4-CC35-4A91-BA4C-C7C712B10C13@test.me.dom>'
+#  mail.message_id    #=> '<F6E2D0B4-CC35-4A91-BA4C-C7C712B10C13@test.me.dom>'
+#  mail[:message_id]  #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::MessageIdField:0x180e1c4
+#  mail['message_id'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::MessageIdField:0x180e1c4
+#  mail['Message-ID'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::MessageIdField:0x180e1c4
+# 
+#  mail[:message_id].message_id   #=> 'F6E2D0B4-CC35-4A91-BA4C-C7C712B10C13@test.me.dom'
+#  mail[:message_id].message_ids  #=> ['F6E2D0B4-CC35-4A91-BA4C-C7C712B10C13@test.me.dom']
+# 
+require 'mail/fields/common/common_message_id'
+
+module Mail
+  class MessageIdField < StructuredField
+    
+    include Mail::CommonMessageId
+    
+    FIELD_NAME = 'message-id'
+    CAPITALIZED_FIELD = 'Message-ID'
+    
+    def initialize(value = nil, charset = 'utf-8')
+      self.charset = charset
+      @uniq = 1
+      if value.blank?
+        self.name = CAPITALIZED_FIELD
+        self.value = generate_message_id
+      else
+        super(CAPITALIZED_FIELD, strip_field(FIELD_NAME, value), charset)
+      end
+      self.parse
+      self
+
+    end
+    
+    def name
+      'Message-ID'
+    end
+    
+    def message_ids
+      [message_id]
+    end
+    
+    def to_s
+      "<#{message_id}>"
+    end
+    
+    def encoded
+      do_encode(CAPITALIZED_FIELD)
+    end
+    
+    def decoded
+      do_decode
+    end
+    
+    private
+    
+    def generate_message_id
+      "<#{Mail.random_tag}@#{::Socket.gethostname}.mail>"
+    end
+    
+  end
+end

data/lib/mail/fields/mime_version_field.rb

@@ -0,0 +1,53 @@
+# encoding: utf-8
+# 
+# 
+# 
+module Mail
+  class MimeVersionField < StructuredField
+    
+    FIELD_NAME = 'mime-version'
+    CAPITALIZED_FIELD = 'Mime-Version'
+
+    def initialize(value = nil, charset = 'utf-8')
+      self.charset = charset
+      if value.blank?
+        value = '1.0'
+      end
+      super(CAPITALIZED_FIELD, strip_field(FIELD_NAME, value), charset)
+      self.parse
+      self
+
+    end
+    
+    def parse(val = value)
+      unless val.blank?
+        @element = Mail::MimeVersionElement.new(val)
+      end
+    end
+    
+    def element
+      @element ||= Mail::MimeVersionElement.new(value)
+    end
+    
+    def version
+      "#{element.major}.#{element.minor}"
+    end
+
+    def major
+      element.major.to_i
+    end
+
+    def minor
+      element.minor.to_i
+    end
+    
+    def encoded
+      "#{CAPITALIZED_FIELD}: #{version}\r\n"
+    end
+    
+    def decoded
+      version
+    end
+    
+  end
+end

data/lib/mail/fields/optional_field.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+# 
+#    The field names of any optional-field MUST NOT be identical to any
+#    field name specified elsewhere in this standard.
+# 
+# optional-field  =       field-name ":" unstructured CRLF
+require 'mail/fields/unstructured_field'
+
+module Mail
+  class OptionalField < UnstructuredField
+    
+  end
+end

data/lib/mail/fields/received_field.rb

@@ -0,0 +1,75 @@
+# encoding: utf-8
+# 
+# trace           =       [return]
+#                         1*received
+# 
+# return          =       "Return-Path:" path CRLF
+# 
+# path            =       ([CFWS] "<" ([CFWS] / addr-spec) ">" [CFWS]) /
+#                         obs-path
+# 
+# received        =       "Received:" name-val-list ";" date-time CRLF
+# 
+# name-val-list   =       [CFWS] [name-val-pair *(CFWS name-val-pair)]
+# 
+# name-val-pair   =       item-name CFWS item-value
+# 
+# item-name       =       ALPHA *(["-"] (ALPHA / DIGIT))
+# 
+# item-value      =       1*angle-addr / addr-spec /
+#                          atom / domain / msg-id
+# 
+module Mail
+  class ReceivedField < StructuredField
+    
+    FIELD_NAME = 'received'
+    CAPITALIZED_FIELD = 'Received'
+    
+    def initialize(value = nil, charset = 'utf-8')
+      self.charset = charset
+      super(CAPITALIZED_FIELD, strip_field(FIELD_NAME, value), charset)
+      self.parse
+      self
+
+    end
+    
+    def parse(val = value)
+      unless val.blank?
+        @element = Mail::ReceivedElement.new(val)
+      end
+    end
+    
+    def element
+      @element ||= Mail::ReceivedElement.new(value)
+    end
+    
+    def date_time
+      @datetime ||= ::DateTime.parse("#{element.date_time}")
+    end
+
+    def info
+      element.info
+    end
+   
+    def formatted_date
+      date_time.strftime("%a, %d %b %Y %H:%M:%S ") + date_time.zone.delete(':')
+    end
+ 
+    def encoded
+      if value.blank?
+        "#{CAPITALIZED_FIELD}: \r\n"
+      else
+        "#{CAPITALIZED_FIELD}: #{info}; #{formatted_date}\r\n"
+      end
+    end
+    
+    def decoded
+      if value.blank?
+        ""
+      else
+        "#{info}; #{formatted_date}" 
+      end
+    end
+    
+  end
+end

data/lib/mail/fields/references_field.rb

@@ -0,0 +1,56 @@
+# encoding: utf-8
+# 
+# = References Field
+# 
+# The References field inherits references StructuredField and handles the References: header
+# field in the email.
+# 
+# Sending references to a mail message will instantiate a Mail::Field object that
+# has a ReferencesField as its field type.  This includes all Mail::CommonAddress
+# module instance metods.
+# 
+# Note that, the #message_ids method will return an array of message IDs without the
+# enclosing angle brackets which per RFC are not syntactically part of the message id.
+# 
+# Only one References field can appear in a header, though it can have multiple
+# Message IDs.
+# 
+# == Examples:
+# 
+#  mail = Mail.new
+#  mail.references = '<F6E2D0B4-CC35-4A91-BA4C-C7C712B10C13@test.me.dom>'
+#  mail.references    #=> '<F6E2D0B4-CC35-4A91-BA4C-C7C712B10C13@test.me.dom>'
+#  mail[:references]  #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ReferencesField:0x180e1c4
+#  mail['references'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ReferencesField:0x180e1c4
+#  mail['References'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ReferencesField:0x180e1c4
+# 
+#  mail[:references].message_ids #=> ['F6E2D0B4-CC35-4A91-BA4C-C7C712B10C13@test.me.dom']
+# 
+require 'mail/fields/common/common_message_id'
+
+module Mail
+  class ReferencesField < StructuredField
+    
+    include CommonMessageId
+    
+    FIELD_NAME = 'references'
+    CAPITALIZED_FIELD = 'References'
+    
+    def initialize(value = nil, charset = 'utf-8')
+      self.charset = charset
+      value = value.join("\r\n\s") if value.is_a?(Array)
+      super(CAPITALIZED_FIELD, strip_field(FIELD_NAME, value), charset)
+      self.parse
+      self
+    end
+    
+    def encoded
+      do_encode(CAPITALIZED_FIELD)
+    end
+    
+    def decoded
+      do_decode
+    end
+    
+  end
+end