otherinbox-mail 2.4.4

data/lib/mail/fields/return_path_field.rb

@@ -0,0 +1,65 @@
+# 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')
+      value = nil if value == '<>'
+      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
+      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,191 @@
+# 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
+   
+    attr_accessor :charset
+    attr_reader :errors
+ 
+    def initialize(name, value, charset = nil)
+      @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 encoded
+      do_encode
+    end
+    
+    def decoded
+      do_decode
+    end
+
+    def default
+      decoded
+    end
+    
+    def parse # An unstructured field does not parse
+      self
+    end
+
+    private
+    
+    def do_encode
+      value.nil? ? '' : "#{wrapped_value}\r\n"
+    end
+    
+    def do_decode
+      result = value.blank? ? nil : Encodings.decode_encode(value, :decode)
+      result.encode!(value.encoding || "UTF-8") if RUBY_VERSION >= '1.9' && !result.blank?
+      result
+    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:
+      wrap_lines(name, fold("#{name}: ".length))
+    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 = ["#{name}: #{folded_lines.shift}"]
+      result.concat(folded_lines)
+      result.join("\r\n\s")
+    end
+
+    def fold(prepend = 0) # :nodoc:
+      encoding       = normalized_encoding
+      decoded_string = decoded.to_s
+      should_encode  = decoded_string.not_ascii_only?
+      if should_encode
+        first = true
+        words = decoded_string.split(/[ \t]/).map do |word|
+          if first
+            first = !first
+          else
+            word = " " << word
+          end
+          if word.not_ascii_only?
+            word
+          else
+            word.scan(/.{7}|.+$/)
+          end
+        end.flatten
+      else
+        words = decoded_string.split(/[ \t]/)
+      end
+      
+      folded_lines   = []
+      while !words.empty?
+        limit = 78 - prepend
+        limit = limit - 7 - encoding.length if should_encode
+        line = ""
+        while !words.empty?
+          break unless word = words.first.dup
+          word.encode!(charset) if defined?(Encoding) && charset
+          word = encode(word) if should_encode
+          word = encode_crlf(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 + word.length + 1 > limit)
+          # Remove the word from the queue ...
+          words.shift
+          # Add word separator
+          line << " " unless (line.empty? || should_encode)
+          # ... add it in encoded form to the current line
+          line << word          
+        end
+        # Encode the line if necessary
+        line = "=?#{encoding}?Q?#{line}?=" if should_encode
+        # Add the line to the output and reset the prepend
+        folded_lines << line
+        prepend = 0
+      end
+      folded_lines
+    end
+ 
+    def encode(value)
+      value = [value].pack("M").gsub("=\n", '')
+      value.gsub!(/"/,  '=22')
+      value.gsub!(/\(/, '=28')
+      value.gsub!(/\)/, '=29')
+      value.gsub!(/\?/, '=3F')
+      value.gsub!(/_/,  '=5F')
+      value.gsub!(/ /,  '_')
+      value
+    end
+
+    def encode_crlf(value)
+      value.gsub!("\r", '=0D')
+      value.gsub!("\n", '=0A')
+      value
+    end
+
+    def normalized_encoding
+      encoding = charset.to_s.upcase.gsub('_', '-')
+      encoding = 'UTF-8' if encoding == 'UTF8' # Ruby 1.8.x and $KCODE == 'u'
+      encoding
+    end
+
+  end
+end