mail 1.0.0

data/lib/mail/fields/references_field.rb

@@ -0,0 +1,42 @@
+# 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 it's 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    #=> '#<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'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ReferencesField:0x180e1c4
+# 
+#  mail.references.to_s  #=> '<F6E2D0B4-CC35-4A91-BA4C-C7C712B10C13@test.me.dom>'
+#  mail.references.message_ids #=> ['F6E2D0B4-CC35-4A91-BA4C-C7C712B10C13@test.me.dom']
+# 
+module Mail
+  class ReferencesField < StructuredField
+    
+    include CommonMessageId
+    
+    FIELD_NAME = 'references'
+    
+    def initialize(*args)
+      super(FIELD_NAME, strip_field(FIELD_NAME, args.last))
+    end
+    
+  end
+end

data/lib/mail/fields/reply_to_field.rb

@@ -0,0 +1,40 @@
+# encoding: utf-8
+# 
+# = Reply-To Field
+# 
+# The Reply-To field inherits reply-to StructuredField and handles the Reply-To: header
+# field in the email.
+# 
+# Sending reply_to to a mail message will instantiate a Mail::Field object that
+# has a ReplyToField as it's field type.  This includes all Mail::CommonAddress
+# module instance metods.
+# 
+# Only one Reply-To field can appear in a header, though it can have multiple
+# addresses and groups of addresses.
+# 
+# == Examples:
+# 
+#  mail = Mail.new
+#  mail.reply_to = 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
+#  mail.reply_to    #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ReplyToField:0x180e1c4
+#  mail[:reply_to]  #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ReplyToField:0x180e1c4
+#  mail['reply-to'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ReplyToField:0x180e1c4
+#  mail['Reply-To'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ReplyToField:0x180e1c4
+# 
+#  mail.reply_to.to_s  #=> 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
+#  mail.reply_to.addresses #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
+#  mail.reply_to.formatted #=> ['Mikel Lindsaar <mikel@test.lindsaar.net>', 'ada@test.lindsaar.net']
+# 
+module Mail
+  class ReplyToField < StructuredField
+    
+    include Mail::CommonAddress
+    
+    FIELD_NAME = 'reply-to'
+    
+    def initialize(*args)
+      super(FIELD_NAME, strip_field(FIELD_NAME, args.last))
+    end
+    
+  end
+end

data/lib/mail/fields/resent_bcc_field.rb

@@ -0,0 +1,40 @@
+# encoding: utf-8
+# 
+# = Resent-Bcc Field
+# 
+# The Resent-Bcc field inherits resent-bcc StructuredField and handles the 
+# Resent-Bcc: header field in the email.
+# 
+# Sending resent_bcc to a mail message will instantiate a Mail::Field object that
+# has a ResentBccField as it's field type.  This includes all Mail::CommonAddress
+# module instance metods.
+# 
+# Only one Resent-Bcc field can appear in a header, though it can have multiple
+# addresses and groups of addresses.
+# 
+# == Examples:
+# 
+#  mail = Mail.new
+#  mail.resent_bcc = 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
+#  mail.resent_bcc    #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ResentBccField:0x180e1c4
+#  mail[:resent_bcc]  #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ResentBccField:0x180e1c4
+#  mail['resent-bcc'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ResentBccField:0x180e1c4
+#  mail['Resent-Bcc'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ResentBccField:0x180e1c4
+# 
+#  mail.resent_bcc.to_s  #=> 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
+#  mail.resent_bcc.addresses #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
+#  mail.resent_bcc.formatted #=> ['Mikel Lindsaar <mikel@test.lindsaar.net>', 'ada@test.lindsaar.net']
+# 
+module Mail
+  class ResentBccField < StructuredField
+    
+    include Mail::CommonAddress
+    
+    FIELD_NAME = 'resent-bcc'
+    
+    def initialize(*args)
+      super(FIELD_NAME, strip_field(FIELD_NAME, args.last))
+    end
+    
+  end
+end

data/lib/mail/fields/resent_cc_field.rb

@@ -0,0 +1,40 @@
+# encoding: utf-8
+# 
+# = Resent-Cc Field
+# 
+# The Resent-Cc field inherits resent-cc StructuredField and handles the Resent-Cc: header
+# field in the email.
+# 
+# Sending resent_cc to a mail message will instantiate a Mail::Field object that
+# has a ResentCcField as it's field type.  This includes all Mail::CommonAddress
+# module instance metods.
+# 
+# Only one Resent-Cc field can appear in a header, though it can have multiple
+# addresses and groups of addresses.
+# 
+# == Examples:
+# 
+#  mail = Mail.new
+#  mail.resent_cc = 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
+#  mail.resent_cc    #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ResentCcField:0x180e1c4
+#  mail[:resent_cc]  #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ResentCcField:0x180e1c4
+#  mail['resent-cc'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ResentCcField:0x180e1c4
+#  mail['Resent-Cc'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ResentCcField:0x180e1c4
+# 
+#  mail.resent_cc.to_s  #=> 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
+#  mail.resent_cc.addresses #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
+#  mail.resent_cc.formatted #=> ['Mikel Lindsaar <mikel@test.lindsaar.net>', 'ada@test.lindsaar.net']
+# 
+module Mail
+  class ResentCcField < StructuredField
+    
+    include Mail::CommonAddress
+    
+    FIELD_NAME = 'resent-cc'
+    
+    def initialize(*args)
+      super(FIELD_NAME, strip_field(FIELD_NAME, args.last))
+    end
+    
+  end
+end

data/lib/mail/fields/resent_date_field.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+# 
+# resent-date     =       "Resent-Date:" date-time CRLF
+module Mail
+  class ResentDateField < StructuredField
+    
+    include Mail::CommonDate
+    
+    FIELD_NAME = 'resent-date'
+    
+    def initialize(*args)
+      super(FIELD_NAME, strip_field(FIELD_NAME, args.last))
+    end
+    
+  end
+end

data/lib/mail/fields/resent_from_field.rb

@@ -0,0 +1,40 @@
+# encoding: utf-8
+# 
+# = Resent-From Field
+# 
+# The Resent-From field inherits resent-from StructuredField and handles the Resent-From: header
+# field in the email.
+# 
+# Sending resent_from to a mail message will instantiate a Mail::Field object that
+# has a ResentFromField as it's field type.  This includes all Mail::CommonAddress
+# module instance metods.
+# 
+# Only one Resent-From field can appear in a header, though it can have multiple
+# addresses and groups of addresses.
+# 
+# == Examples:
+# 
+#  mail = Mail.new
+#  mail.resent_from = 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
+#  mail.resent_from    #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ResentFromField:0x180e1c4
+#  mail[:resent_from]  #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ResentFromField:0x180e1c4
+#  mail['resent-from'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ResentFromField:0x180e1c4
+#  mail['Resent-From'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ResentFromField:0x180e1c4
+# 
+#  mail.resent_from.to_s  #=> 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
+#  mail.resent_from.addresses #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
+#  mail.resent_from.formatted #=> ['Mikel Lindsaar <mikel@test.lindsaar.net>', 'ada@test.lindsaar.net']
+# 
+module Mail
+  class ResentFromField < StructuredField
+    
+    include Mail::CommonAddress
+    
+    FIELD_NAME = 'resent-from'
+    
+    def initialize(*args)
+      super(FIELD_NAME, strip_field(FIELD_NAME, args.last))
+    end
+    
+  end
+end

data/lib/mail/fields/resent_message_id_field.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+# 
+# resent-msg-id   =       "Resent-Message-ID:" msg-id CRLF
+module Mail
+  class ResentMessageIdField < StructuredField
+    
+    include CommonMessageId
+    
+    FIELD_NAME = 'resent-message-id'
+    
+    def initialize(*args)
+      super(FIELD_NAME, strip_field(FIELD_NAME, args.last))
+    end
+    
+    def name
+      'Resent-Message-ID'
+    end
+    
+  end
+end

data/lib/mail/fields/resent_sender_field.rb

@@ -0,0 +1,48 @@
+# encoding: utf-8
+# 
+# = Resent-Sender Field
+# 
+# The Resent-Sender field inherits resent-sender StructuredField and handles the Resent-Sender: header
+# field in the email.
+# 
+# Sending resent_sender to a mail message will instantiate a Mail::Field object that
+# has a ResentSenderField as it's field type.  This includes all Mail::CommonAddress
+# module instance metods.
+# 
+# Only one Resent-Sender field can appear in a header, though it can have multiple
+# addresses and groups of addresses.
+# 
+# == Examples:
+# 
+#  mail = Mail.new
+#  mail.resent_sender = 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
+#  mail.resent_sender    #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ResentSenderField:0x180e1c4
+#  mail[:resent_sender]  #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ResentSenderField:0x180e1c4
+#  mail['resent-sender'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ResentSenderField:0x180e1c4
+#  mail['Resent-Sender'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ResentSenderField:0x180e1c4
+# 
+#  mail.resent_sender.to_s  #=> 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
+#  mail.resent_sender.addresses #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
+#  mail.resent_sender.formatted #=> ['Mikel Lindsaar <mikel@test.lindsaar.net>', 'ada@test.lindsaar.net']
+# 
+module Mail
+  class ResentSenderField < StructuredField
+    
+    include Mail::CommonAddress
+    
+    FIELD_NAME = 'resent-sender'
+
+    def initialize(*args)
+      super(FIELD_NAME, strip_field(FIELD_NAME, args.last))
+    end
+
+    def addresses
+      [address]
+    end
+
+    def address
+      result = tree.addresses.first
+    end
+    
+  end
+end

data/lib/mail/fields/resent_to_field.rb

@@ -0,0 +1,40 @@
+# encoding: utf-8
+# 
+# = Resent-To Field
+# 
+# The Resent-To field inherits resent-to StructuredField and handles the Resent-To: header
+# field in the email.
+# 
+# Sending resent_to to a mail message will instantiate a Mail::Field object that
+# has a ResentToField as it's field type.  This includes all Mail::CommonAddress
+# module instance metods.
+# 
+# Only one Resent-To field can appear in a header, though it can have multiple
+# addresses and groups of addresses.
+# 
+# == Examples:
+# 
+#  mail = Mail.new
+#  mail.resent_to = 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
+#  mail.resent_to    #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ResentToField:0x180e1c4
+#  mail[:resent_to]  #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ResentToField:0x180e1c4
+#  mail['resent-to'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ResentToField:0x180e1c4
+#  mail['Resent-To'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ResentToField:0x180e1c4
+# 
+#  mail.resent_to.to_s  #=> 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
+#  mail.resent_to.addresses #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
+#  mail.resent_to.formatted #=> ['Mikel Lindsaar <mikel@test.lindsaar.net>', 'ada@test.lindsaar.net']
+# 
+module Mail
+  class ResentToField < StructuredField
+    
+    include Mail::CommonAddress
+    
+    FIELD_NAME = 'resent-to'
+    
+    def initialize(*args)
+      super(FIELD_NAME, strip_field(FIELD_NAME, args.last))
+    end
+    
+  end
+end

data/lib/mail/fields/return_path_field.rb

@@ -0,0 +1,34 @@
+# 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 ReturnPathField < StructuredField
+    
+    include CommonAddress
+    
+    FIELD_NAME = 'return-path'
+    
+    def initialize(*args)
+      super(FIELD_NAME, strip_field(FIELD_NAME, args.last))
+    end
+    
+  end
+end

data/lib/mail/fields/sender_field.rb

@@ -0,0 +1,48 @@
+# encoding: utf-8
+# 
+# = Sender Field
+# 
+# The Sender field inherits sender StructuredField and handles the Sender: header
+# field in the email.
+# 
+# Sending sender to a mail message will instantiate a Mail::Field object that
+# has a SenderField as it's field type.  This includes all Mail::CommonAddress
+# module instance metods.
+# 
+# Only one Sender field can appear in a header, though it can have multiple
+# addresses and groups of addresses.
+# 
+# == Examples:
+# 
+#  mail = Mail.new
+#  mail.sender = 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
+#  mail.sender    #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::SenderField:0x180e1c4
+#  mail[:sender]  #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::SenderField:0x180e1c4
+#  mail['sender'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::SenderField:0x180e1c4
+#  mail['Sender'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::SenderField:0x180e1c4
+# 
+#  mail.sender.to_s  #=> 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
+#  mail.sender.addresses #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
+#  mail.sender.formatted #=> ['Mikel Lindsaar <mikel@test.lindsaar.net>', 'ada@test.lindsaar.net']
+# 
+module Mail
+  class SenderField < StructuredField
+    
+    include Mail::CommonAddress
+    
+    FIELD_NAME = 'sender'
+
+    def initialize(*args)
+      super(FIELD_NAME, strip_field(FIELD_NAME, args.last))
+    end
+
+    def addresses
+      [address]
+    end
+
+    def address
+      result = tree.addresses.first
+    end
+    
+  end
+end

data/lib/mail/fields/structured_field.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+module Mail
+  # Provides access to a structured header field
+  #
+  # ===Per RFC 2822:
+  #  2.2.2. Structured Header Field Bodies
+  #  
+  #     Some field bodies in this standard have specific syntactical
+  #     structure more restrictive than the unstructured field bodies
+  #     described above. These are referred to as "structured" field bodies.
+  #     Structured field bodies are sequences of specific lexical tokens as
+  #     described in sections 3 and 4 of this standard.  Many of these tokens
+  #     are allowed (according to their syntax) to be introduced or end with
+  #     comments (as described in section 3.2.3) as well as the space (SP,
+  #     ASCII value 32) and horizontal tab (HTAB, ASCII value 9) characters
+  #     (together known as the white space characters, WSP), and those WSP
+  #     characters are subject to header "folding" and "unfolding" as
+  #     described in section 2.2.3.  Semantic analysis of structured field
+  #     bodies is given along with their syntax.
+  class StructuredField
+    
+    include Mail::CommonField
+    include Mail::Utilities
+    
+    def initialize(*args)
+      self.name = args.first
+      self.value = args.last
+      self
+    end
+    
+  end
+end