dball-mail 2.2.9.1

data/lib/mail/fields/common/parameter_hash.rb

@@ -0,0 +1,58 @@
+# encoding: utf-8
+module Mail
+
+  # ParameterHash is an intelligent Hash that allows you to add
+  # parameter values including the MIME extension paramaters that
+  # have the name*0="blah", name*1="bleh" keys, and will just return
+  # a single key called name="blahbleh" and do any required un-encoding
+  # to make that happen
+  # Parameters are defined in RFC2045, split keys are in RFC2231
+
+  class ParameterHash < HashWithIndifferentAccess
+
+    include Mail::Utilities
+
+    def [](key_name)
+      key_pattern = Regexp.escape(key_name.to_s)
+      pairs = []
+      exact = nil
+      each do |k,v|
+        if k =~ /^#{key_pattern}(\*|$)/i
+          if $1 == '*'
+            pairs << [k, v]
+          else
+            exact = k
+          end
+        end
+      end
+      if pairs.empty? # Just dealing with a single value pair
+        super(exact || key_name)
+      else # Dealing with a multiple value pair or a single encoded value pair
+        string = pairs.sort { |a,b| a.first <=> b.first }.map { |v| v.last }.join('')
+        if mt = string.match(/([\w\d\-]+)'(\w\w)'(.*)/)
+          string = mt[3]
+          encoding = mt[1]
+        else
+          encoding = nil
+        end
+        Mail::Encodings.param_decode(string, encoding)
+      end
+    end
+
+    def encoded
+      map.sort { |a,b| a.first <=> b.first }.map do |key_name, value|
+        unless value.ascii_only?
+          value = Mail::Encodings.param_encode(value)
+          key_name = "#{key_name}*"
+        end
+        %Q{#{key_name}=#{quote_token(value)}}
+      end.join(";\r\n\s")
+    end
+
+    def decoded
+      map.sort { |a,b| a.first <=> b.first }.map do |key_name, value|
+        %Q{#{key_name}=#{quote_token(value)}}
+      end.join("; ")
+    end
+  end
+end

data/lib/mail/fields/content_description_field.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+# 
+# 
+# 
+module Mail
+  class ContentDescriptionField < UnstructuredField
+    
+    FIELD_NAME = 'content-description'
+    CAPITALIZED_FIELD = 'Content-Description'
+    
+    def initialize(value = nil, charset = 'utf-8')
+      self.charset = charset
+      super(CAPITALIZED_FIELD, strip_field(FIELD_NAME, value), charset)
+      self.parse
+      self
+    end
+    
+  end
+end

data/lib/mail/fields/content_disposition_field.rb

@@ -0,0 +1,69 @@
+# encoding: utf-8
+require 'mail/fields/common/parameter_hash'
+
+module Mail
+  class ContentDispositionField < StructuredField
+    
+    FIELD_NAME = 'content-disposition'
+    CAPITALIZED_FIELD = 'Content-Disposition'
+    
+    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::ContentDispositionElement.new(val)
+      end
+    end
+    
+    def element
+      @element ||= Mail::ContentDispositionElement.new(value)
+    end
+
+    def disposition_type
+      element.disposition_type
+    end
+    
+    def parameters
+      @parameters = ParameterHash.new
+      element.parameters.each { |p| @parameters.merge!(p) }
+      @parameters
+    end
+
+    def filename
+      case
+      when !parameters['filename'].blank?
+        @filename = parameters['filename']
+      when !parameters['name'].blank?
+        @filename = parameters['name']
+      else 
+        @filename = nil
+      end
+      @filename
+    end
+
+    # TODO: Fix this up
+    def encoded
+      if parameters.length > 0
+        p = ";\r\n\s#{parameters.encoded}\r\n"
+      else
+        p = "\r\n"
+      end
+      "#{CAPITALIZED_FIELD}: #{disposition_type}" + p
+    end
+    
+    def decoded
+      if parameters.length > 0
+        p = "; #{parameters.decoded}"
+      else
+        p = ""
+      end
+      "#{disposition_type}" + p
+    end
+
+  end
+end

data/lib/mail/fields/content_id_field.rb

@@ -0,0 +1,63 @@
+# encoding: utf-8
+# 
+# 
+# 
+module Mail
+  class ContentIdField < StructuredField
+    
+    FIELD_NAME = 'content-id'
+    CAPITALIZED_FIELD = "Content-ID"
+    
+    def initialize(value = nil, charset = 'utf-8')
+      self.charset = charset
+      @uniq = 1
+      if value.blank?
+        value = generate_content_id
+      else
+        value = strip_field(FIELD_NAME, value)
+      end
+      super(CAPITALIZED_FIELD, strip_field(FIELD_NAME, value), charset)
+      self.parse
+      self
+    end
+    
+    def parse(val = value)
+      unless val.blank?
+        @element = Mail::MessageIdsElement.new(val)
+      end
+    end
+    
+    def element
+      @element ||= Mail::MessageIdsElement.new(value)
+    end
+    
+    def name
+      'Content-ID'
+    end
+    
+    def content_id
+      element.message_id
+    end
+    
+    def to_s
+      "<#{content_id}>"
+    end
+    
+    # TODO: Fix this up
+    def encoded
+      "#{CAPITALIZED_FIELD}: #{to_s}\r\n"
+    end
+    
+    def decoded
+      "#{to_s}"
+    end
+    
+    private
+    
+    def generate_content_id
+      fqdn = ::Socket.gethostname
+      "<#{Mail.random_tag}@#{fqdn}.mail>"
+    end
+    
+  end
+end

data/lib/mail/fields/content_location_field.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+# 
+# 
+# 
+module Mail
+  class ContentLocationField < StructuredField
+    
+    FIELD_NAME = 'content-location'
+    CAPITALIZED_FIELD = 'Content-Location'
+    
+    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::ContentLocationElement.new(val)
+      end
+    end
+    
+    def element
+      @element ||= Mail::ContentLocationElement.new(value)
+    end
+
+    def location
+      element.location
+    end
+
+    # TODO: Fix this up
+    def encoded
+      "#{CAPITALIZED_FIELD}: #{location}\r\n"
+    end
+    
+    def decoded
+      location 
+    end
+
+  end
+end

data/lib/mail/fields/content_transfer_encoding_field.rb

@@ -0,0 +1,50 @@
+# encoding: utf-8
+# 
+# 
+# 
+module Mail
+  class ContentTransferEncodingField < StructuredField
+    
+    FIELD_NAME = 'content-transfer-encoding'
+    CAPITALIZED_FIELD = 'Content-Transfer-Encoding'
+    
+    def initialize(value = nil, charset = 'utf-8')
+      self.charset = charset
+      value = '7bit' if value.to_s =~ /7-bit/i
+      value = '8bit' if value.to_s =~ /8-bit/i
+      super(CAPITALIZED_FIELD, strip_field(FIELD_NAME, value), charset)
+      self.parse
+      self
+    end
+    
+    def parse(val = value)
+      unless val.blank?
+        @element = Mail::ContentTransferEncodingElement.new(val)
+      end
+    end
+    
+    def tree
+      STDERR.puts("tree is deprecated.  Please use encoding to get parse result\n#{caller}")
+      @element ||= Mail::ContentTransferEncodingElement.new(value)
+      @tree ||= @element.tree
+    end
+    
+    def element
+      @element ||= Mail::ContentTransferEncodingElement.new(value)
+    end
+    
+    def encoding
+      element.encoding
+    end
+    
+    # TODO: Fix this up
+    def encoded
+      "#{CAPITALIZED_FIELD}: #{encoding}\r\n"
+    end
+    
+    def decoded
+      encoding
+    end
+    
+  end
+end

data/lib/mail/fields/content_type_field.rb

@@ -0,0 +1,198 @@
+# encoding: utf-8
+require 'mail/fields/common/parameter_hash'
+
+module Mail
+  class ContentTypeField < StructuredField
+
+    FIELD_NAME = 'content-type'
+    CAPITALIZED_FIELD = 'Content-Type'
+
+    def initialize(value = nil, charset = 'utf-8')
+      self.charset = charset
+      if value.class == Array
+        @main_type = value[0]
+        @sub_type = value[1]
+        @parameters = ParameterHash.new.merge!(value.last)
+      else
+        @main_type = nil
+        @sub_type = nil
+        @parameters = nil
+        value = strip_field(FIELD_NAME, value)
+      end
+      super(CAPITALIZED_FIELD, value, charset)
+      self.parse
+      self
+    end
+
+    def parse(val = value)
+      unless val.blank?
+        self.value = val
+        @element = nil
+        element
+      end
+    end
+
+    def element
+      begin
+        @element ||= Mail::ContentTypeElement.new(value)
+      rescue
+        attempt_to_clean
+      end
+    end
+
+    def attempt_to_clean
+      # Sanitize the value, handle special cases
+      @element ||= Mail::ContentTypeElement.new(sanatize(value))
+    rescue
+      # All else fails, just get the MIME media type
+      @element ||= Mail::ContentTypeElement.new(get_mime_type(value))
+    end
+
+    def main_type
+      @main_type ||= element.main_type
+    end
+
+    def sub_type
+      @sub_type ||= element.sub_type
+    end
+
+    def string
+      "#{main_type}/#{sub_type}"
+    end
+
+    def default
+      decoded
+    end
+
+    alias :content_type :string
+
+    def parameters
+      unless @parameters
+        @parameters = ParameterHash.new
+        element.parameters.each { |p| @parameters.merge!(p) }
+      end
+      @parameters
+    end
+
+    def ContentTypeField.with_boundary(type)
+      new("#{type}; boundary=#{generate_boundary}")
+    end
+
+    def ContentTypeField.generate_boundary
+      "--==_mimepart_#{Mail.random_tag}"
+    end
+
+    def value
+      if @value.class == Array
+        "#{@main_type}/#{@sub_type}; #{stringify(parameters)}"
+      else
+        @value
+      end
+    end
+
+    def stringify(params)
+      params.map { |k,v| "#{k}=#{Encodings.param_encode(v)}" }.join("; ")
+    end
+
+    def filename
+      case
+      when parameters['filename']
+        @filename = parameters['filename']
+      when parameters['name']
+        @filename = parameters['name']
+      else
+        @filename = nil
+      end
+      @filename
+    end
+
+    # TODO: Fix this up
+    def encoded
+      if parameters.length > 0
+        p = ";\r\n\s#{parameters.encoded}"
+      else
+        p = ""
+      end
+      "#{CAPITALIZED_FIELD}: #{content_type}#{p}\r\n"
+    end
+
+    def decoded
+      if parameters.length > 0
+        p = "; #{parameters.decoded}"
+      else
+        p = ""
+      end
+      "#{content_type}" + p
+    end
+
+    private
+
+    def method_missing(name, *args, &block)
+      if name.to_s =~ /([\w_]+)=/
+        self.parameters[$1] = args.first
+        @value = "#{content_type}; #{stringify(parameters)}"
+      else
+        super
+      end
+    end
+
+    # Various special cases from random emails found that I am not going to change
+    # the parser for
+    def sanatize( val )
+
+      # TODO: check if there are cases where whitespace is not a separator
+      val = val.tr(' ',';').
+        squeeze(';').
+        gsub(';', '; '). #use '; ' as a separator (or EOL)
+        gsub(/;\s*$/,'') #remove trailing to keep examples below
+
+      if val =~ /(boundary=(\S*))/i
+        val = "#{$`.downcase}boundary=#{$2}#{$'.downcase}"
+      else
+        val.downcase!
+      end
+
+      case
+      when val.chomp =~ /^\s*([\w\d\-_]+)\/([\w\d\-_]+)\s*;;+(.*)$/i
+        # Handles 'text/plain;; format="flowed"' (double semi colon)
+        "#{$1}/#{$2}; #{$3}"
+      when val.chomp =~ /^\s*([\w\d\-_]+)\/([\w\d\-_]+)\s*;\s?(ISO[\w\d\-_]+)$/i
+        # Microsoft helper:
+        # Handles 'type/subtype;ISO-8559-1'
+        "#{$1}/#{$2}; charset=#{quote_atom($3)}"
+      when val.chomp =~ /^text;?$/i
+        # Handles 'text;' and 'text'
+        "text/plain;"
+      when val.chomp =~ /^(\w+);\s(.*)$/i
+        # Handles 'text; <parameters>'
+        "text/plain; #{$2}"
+      when val =~ /([\w\d\-_]+\/[\w\d\-_]+);\scharset="charset="(\w+)""/i
+        # Handles text/html; charset="charset="GB2312""
+        "#{$1}; charset=#{quote_atom($2)}"
+      when val =~ /([\w\d\-_]+\/[\w\d\-_]+);\s+(.*)/i
+        type = $1
+        # Handles misquoted param values
+        # e.g: application/octet-stream; name=archiveshelp1[1].htm
+        # and: audio/x-midi;\r\n\sname=Part .exe
+        params = $2.to_s.split(/\s+/)
+        params = params.map { |i| i.to_s.chomp.strip }
+        params = params.map { |i| i.split(/\s*\=\s*/) }
+        params = params.map { |i| "#{i[0]}=#{dquote(i[1].to_s)}" }.join('; ')
+        "#{type}; #{params}"
+      when val =~ /^\s*$/
+        'text/plain'
+      else
+        ''
+      end
+    end
+
+    def get_mime_type( val )
+      case
+      when val =~ /^([\w\d\-_]+)\/([\w\d\-_]+);.+$/i
+        "#{$1}/#{$2}"
+      else
+        'text/plain'
+      end
+    end
+  end
+end

data/lib/mail/fields/date_field.rb

@@ -0,0 +1,55 @@
+# 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 it's 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 = Time.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)
+    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 it's 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 Lindsaar <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,55 @@
+# 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 it's 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
+      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