dball-mail 2.2.9.1

data/lib/mail/fields/resent_to_field.rb

@@ -0,0 +1,55 @@
+# 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    #=> ['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].encoded   #=> 'Resent-To: Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net\r\n'
+#  mail[:resent_to].decoded   #=> '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']
+# 
+require 'mail/fields/common/common_address'
+
+module Mail
+  class ResentToField < StructuredField
+    
+    include Mail::CommonAddress
+    
+    FIELD_NAME = 'resent-to'
+    CAPITALIZED_FIELD = 'Resent-To'
+    
+    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/return_path_field.rb

@@ -0,0 +1,64 @@
+# encoding: utf-8
+# 
+# 4.4.3.  REPLY-TO / RESENT-REPLY-TO
+# 
+#    Note:  The "Return-Path" field is added by the mail  transport
+#           service,  at the time of final deliver.  It is intended
+#           to identify a path back to the orginator  of  the  mes-
+#           sage.   The  "Reply-To"  field  is added by the message
+#           originator and is intended to direct replies.
+# 
+# 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
+# 
+require 'mail/fields/common/common_address'
+
+module Mail
+  class ReturnPathField < StructuredField
+    
+    include Mail::CommonAddress
+    
+    FIELD_NAME = 'return-path'
+    CAPITALIZED_FIELD = 'Return-Path'
+    
+    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
+      "#{CAPITALIZED_FIELD}: <#{address}>\r\n"
+    end
+    
+    def decoded
+      do_decode
+    end
+    
+    def address
+      addresses.first
+    end
+    
+    def default
+      address
+    end
+    
+  end
+end

data/lib/mail/fields/sender_field.rb

@@ -0,0 +1,67 @@
+# 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    #=> ['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].encoded   #=> 'Sender: Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net\r\n'
+#  mail[:sender].decoded   #=> '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']
+# 
+require 'mail/fields/common/common_address'
+
+module Mail
+  class SenderField < StructuredField
+    
+    include Mail::CommonAddress
+    
+    FIELD_NAME = 'sender'
+    CAPITALIZED_FIELD = 'Sender'
+
+    def initialize(value = nil, charset = 'utf-8')
+      self.charset = charset
+      super(CAPITALIZED_FIELD, strip_field(FIELD_NAME, value), charset)
+      self.parse
+      self
+    end
+
+    def addresses
+      [address.address]
+    end
+
+    def address
+      result = tree.addresses.first
+    end
+    
+    def encoded
+      do_encode(CAPITALIZED_FIELD)
+    end
+    
+    def decoded
+      do_decode
+    end
+    
+    def default
+      address.address
+    end
+    
+  end
+end

data/lib/mail/fields/structured_field.rb

@@ -0,0 +1,51 @@
+# encoding: utf-8
+require 'mail/fields/common/common_field'
+
+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(name = nil, value = nil, charset = nil)
+      self.name    = name
+      self.value   = value
+      self.charset = charset
+      self
+    end
+    
+    def charset
+      @charset
+    end
+    
+    def charset=(val)
+      @charset = val
+    end
+    
+    def default
+      decoded
+    end
+    
+    def errors
+      []
+    end
+
+  end
+end

data/lib/mail/fields/subject_field.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+# 
+# subject         =       "Subject:" unstructured CRLF
+module Mail
+  class SubjectField < UnstructuredField
+    
+    FIELD_NAME = 'subject'
+    CAPITALIZED_FIELD = "Subject"
+    
+    def initialize(value = nil, charset = 'utf-8')
+      self.charset = charset
+      super(CAPITALIZED_FIELD, strip_field(FIELD_NAME, value), charset)
+    end
+    
+  end
+end

data/lib/mail/fields/to_field.rb

@@ -0,0 +1,55 @@
+# encoding: utf-8
+# 
+# = To Field
+# 
+# The To field inherits to StructuredField and handles the To: header
+# field in the email.
+# 
+# Sending to to a mail message will instantiate a Mail::Field object that
+# has a ToField as it's field type.  This includes all Mail::CommonAddress
+# module instance metods.
+# 
+# Only one To field can appear in a header, though it can have multiple
+# addresses and groups of addresses.
+# 
+# == Examples:
+# 
+#  mail = Mail.new
+#  mail.to = 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
+#  mail.to    #=> ['Mikel Lindsaar <mikel@test.lindsaar.net>', 'ada@test.lindsaar.net']
+#  mail[:to]  #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ToField:0x180e1c4
+#  mail['to'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ToField:0x180e1c4
+#  mail['To'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ToField:0x180e1c4
+# 
+#  mail[:to].encoded   #=> 'To: Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net\r\n'
+#  mail[:to].decoded   #=> 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
+#  mail[:to].addresses #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
+#  mail[:to].formatted #=> ['Mikel Lindsaar <mikel@test.lindsaar.net>', 'ada@test.lindsaar.net']
+# 
+require 'mail/fields/common/common_address'
+
+module Mail
+  class ToField < StructuredField
+    
+    include Mail::CommonAddress
+    
+    FIELD_NAME = 'to'
+    CAPITALIZED_FIELD = 'To'
+    
+    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/unstructured_field.rb

@@ -0,0 +1,179 @@
+# encoding: utf-8
+require 'mail/fields/common/common_field'
+
+module Mail
+  # Provides access to an unstructured header field
+  #
+  # ===Per RFC 2822:
+  #  2.2.1. Unstructured Header Field Bodies
+  #  
+  #     Some field bodies in this standard are defined simply as
+  #     "unstructured" (which is specified below as any US-ASCII characters,
+  #     except for CR and LF) with no further restrictions.  These are
+  #     referred to as unstructured field bodies.  Semantically, unstructured
+  #     field bodies are simply to be treated as a single line of characters
+  #     with no further processing (except for header "folding" and
+  #     "unfolding" as described in section 2.2.3).
+  class UnstructuredField
+    
+    include Mail::CommonField
+    include Mail::Utilities
+    
+    def initialize(name, value, charset = nil)
+      self.charset = charset
+      @errors = []
+      if charset
+        self.charset = charset
+      else
+        if value.to_s.respond_to?(:encoding)
+          self.charset = value.to_s.encoding
+        else
+          self.charset = $KCODE
+        end
+      end
+      self.name = name
+      self.value = value
+      self
+    end
+    
+    def charset
+      @charset
+    end
+    
+    def charset=(val)
+      @charset = val
+    end
+
+    def errors
+      @errors
+    end
+    
+    def encoded
+      do_encode(self.name)
+    end
+    
+    def decoded
+      do_decode
+    end
+
+    def default
+      decoded
+    end
+    
+    def parse # An unstructured field does not parse
+      self
+    end
+
+    private
+    
+    def do_encode(name)
+      value.nil? ? '' : "#{wrapped_value}\r\n"
+    end
+    
+    def do_decode
+      value.blank? ? nil : Encodings.decode_encode(value, :decode)
+    end
+    
+    # 2.2.3. Long Header Fields
+    # 
+    #  Each header field is logically a single line of characters comprising
+    #  the field name, the colon, and the field body.  For convenience
+    #  however, and to deal with the 998/78 character limitations per line,
+    #  the field body portion of a header field can be split into a multiple
+    #  line representation; this is called "folding".  The general rule is
+    #  that wherever this standard allows for folding white space (not
+    #  simply WSP characters), a CRLF may be inserted before any WSP.  For
+    #  example, the header field:
+    #  
+    #          Subject: This is a test
+    #  
+    #  can be represented as:
+    #  
+    #          Subject: This
+    #           is a test
+    #  
+    #  Note: Though structured field bodies are defined in such a way that
+    #  folding can take place between many of the lexical tokens (and even
+    #  within some of the lexical tokens), folding SHOULD be limited to
+    #  placing the CRLF at higher-level syntactic breaks.  For instance, if
+    #  a field body is defined as comma-separated values, it is recommended
+    #  that folding occur after the comma separating the structured items in
+    #  preference to other places where the field could be folded, even if
+    #  it is allowed elsewhere.
+    def wrapped_value # :nodoc:
+      @folded_line = []
+      @unfolded_line = decoded.to_s.split(/[ \t]/)
+      fold("#{name}: ".length)
+      wrap_lines(name, @folded_line)
+    end
+   
+    # 6.2. Display of 'encoded-word's
+    # 
+    #  When displaying a particular header field that contains multiple
+    #  'encoded-word's, any 'linear-white-space' that separates a pair of
+    #  adjacent 'encoded-word's is ignored.  (This is to allow the use of
+    #  multiple 'encoded-word's to represent long strings of unencoded text,
+    #  without having to separate 'encoded-word's where spaces occur in the
+    #  unencoded text.)
+    def wrap_lines(name, folded_lines)
+      result = []
+      index = 0
+      result[index] = "#{name}: #{folded_lines.shift}"
+      result.concat(folded_lines)
+      result.join("\r\n\s")
+    end
+
+    def fold(prepend = 0) # :nodoc:
+      encoding = @charset.to_s.upcase.gsub('_', '-')
+      while !@unfolded_line.empty?
+        encoded = false
+        limit = 78 - prepend
+        line = ""
+        while !@unfolded_line.empty?          
+          break unless word = @unfolded_line.first.dup
+          # Remember whether it was non-ascii before we encode it ('cause then we can't tell anymore)
+          non_ascii = word.not_ascii_only?
+          encoded_word = encode(word)
+          # Skip to next line if we're going to go past the limit
+          # Unless this is the first word, in which case we're going to add it anyway
+          # Note: This means that a word that's longer than 998 characters is going to break the spec. Please fix if this is a problem for you.
+          # (The fix, it seems, would be to use encoded-word encoding on it, because that way you can break it across multiple lines and 
+          # the linebreak will be ignored)
+          break if !line.empty? && (line.length + encoded_word.length + 1 > limit)
+          # If word was the first non-ascii word, we're going to make the entire line encoded and we're going to reduce the limit accordingly
+          if non_ascii && !encoded
+            encoded = true
+            encoded_word_safify!(line)
+            limit = limit - 8 - encoding.length  # minus the =?...?Q?...?= part, the possible leading white-space, and the name of the encoding
+          end
+          # Remove the word from the queue ...
+          @unfolded_line.shift
+          # ... add it in encoded form to the current line
+          line << " " unless line.empty?
+          encoded_word_safify!(encoded_word) if encoded
+          line << encoded_word          
+        end
+        # Add leading whitespace if both this and the last line were encoded, because whitespace between two encoded-words is ignored when decoding
+        line = " " + line if encoded && @folded_line.last && @folded_line.last.index('=?') == 0
+        # Encode the line if necessary
+        line = "=?#{encoding}?Q?#{line.gsub(/ /, '_')}?=" if encoded
+        # Add the line to the output and reset the prepend
+        @folded_line << line
+        prepend = 0
+      end
+    end
+        
+    def encode(value)
+      (value.not_ascii_only? ? [value].pack("M").gsub("=\n", '') : value).gsub("\r", "=0D").gsub("\n", "=0A")
+    end
+    
+    def encoded_word_safify!(value)
+      value.gsub!(/"/,  '=22')
+      value.gsub!(/\(/, '=28')
+      value.gsub!(/\)/, '=29')
+      value.gsub!(/\?/, '=3F')
+      value.gsub!(/_/,  '=5F')
+    end
+
+  end
+end

data/lib/mail/fields.rb

@@ -0,0 +1,35 @@
+module Mail
+  autoload :UnstructuredField, 'mail/fields/unstructured_field'
+  autoload :StructuredField, 'mail/fields/structured_field'
+  autoload :OptionalField, 'mail/fields/optional_field'
+
+  autoload :BccField, 'mail/fields/bcc_field'
+  autoload :CcField, 'mail/fields/cc_field'
+  autoload :CommentsField, 'mail/fields/comments_field'
+  autoload :ContentDescriptionField, 'mail/fields/content_description_field'
+  autoload :ContentDispositionField, 'mail/fields/content_disposition_field'
+  autoload :ContentIdField, 'mail/fields/content_id_field'
+  autoload :ContentLocationField, 'mail/fields/content_location_field'
+  autoload :ContentTransferEncodingField, 'mail/fields/content_transfer_encoding_field'
+  autoload :ContentTypeField, 'mail/fields/content_type_field'
+  autoload :DateField, 'mail/fields/date_field'
+  autoload :FromField, 'mail/fields/from_field'
+  autoload :InReplyToField, 'mail/fields/in_reply_to_field'
+  autoload :KeywordsField, 'mail/fields/keywords_field'
+  autoload :MessageIdField, 'mail/fields/message_id_field'
+  autoload :MimeVersionField, 'mail/fields/mime_version_field'
+  autoload :ReceivedField, 'mail/fields/received_field'
+  autoload :ReferencesField, 'mail/fields/references_field'
+  autoload :ReplyToField, 'mail/fields/reply_to_field'
+  autoload :ResentBccField, 'mail/fields/resent_bcc_field'
+  autoload :ResentCcField, 'mail/fields/resent_cc_field'
+  autoload :ResentDateField, 'mail/fields/resent_date_field'
+  autoload :ResentFromField, 'mail/fields/resent_from_field'
+  autoload :ResentMessageIdField, 'mail/fields/resent_message_id_field'
+  autoload :ResentSenderField, 'mail/fields/resent_sender_field'
+  autoload :ResentToField, 'mail/fields/resent_to_field'
+  autoload :ReturnPathField, 'mail/fields/return_path_field'
+  autoload :SenderField, 'mail/fields/sender_field'
+  autoload :SubjectField, 'mail/fields/subject_field'
+  autoload :ToField, 'mail/fields/to_field'
+end