mail-portertech 2.6.2.edge

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

@@ -0,0 +1,48 @@
+# encoding: utf-8
+module Mail
+  module CommonMessageId # :nodoc:
+    def element
+      @element ||= Mail::MessageIdsElement.new(value) unless value.blank?
+    end
+
+    def parse(val = value)
+      unless val.blank?
+        @element = Mail::MessageIdsElement.new(val)
+      else
+        nil
+      end
+    end
+    
+    def message_id
+      element.message_id if element
+    end
+    
+    def message_ids
+      element.message_ids if element
+    end
+    
+    def default
+      return nil unless message_ids
+      if message_ids.length == 1
+        message_ids[0]
+      else
+        message_ids
+      end
+    end
+
+    private
+
+    def do_encode(field_name)
+      %Q{#{field_name}: #{formated_message_ids("\r\n ")}\r\n}
+    end
+
+    def do_decode
+      formated_message_ids(' ')
+    end
+
+    def formated_message_ids(join)
+      message_ids.map{ |m| "<#{m}>" }.join(join) if message_ids
+    end
+
+  end
+end

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 < IndifferentHash
+
+    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.to_s <=> b.first.to_s }.map { |v| v.last }.join('')
+        if mt = string.match(/([\w\-]+)'(\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.to_s <=> b.first.to_s }.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.to_s <=> b.first.to_s }.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,70 @@
+# 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
+      ensure_filename_quoted(value)
+      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,62 @@
+# 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
+      "<#{Mail.random_tag}@#{::Socket.gethostname}.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,44 @@
+# 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-?bits?/i
+      value = '8bit' if value.to_s =~ /8-?bits?/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 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,201 @@
+# 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
+      ensure_filename_quoted(value)
+      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.
+        gsub(/\s*=\s*/,'='). # remove whitespaces around equal sign
+        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\-]+)\/([\w\-]+)\s*;;+(.*)$/i
+        # Handles 'text/plain;; format="flowed"' (double semi colon)
+        "#{$1}/#{$2}; #{$3}"
+      when val.chomp =~ /^\s*([\w\-]+)\/([\w\-]+)\s*;\s?(ISO[\w\-]+)$/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\-]+\/[\w\-]+);\scharset="charset="(\w+)""/i
+        # Handles text/html; charset="charset="GB2312""
+        "#{$1}; charset=#{quote_atom($2)}"
+      when val =~ /([\w\-]+\/[\w\-]+);\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.gsub(/;$/,""))}" }.join('; ')
+        "#{type}; #{params}"
+      when val =~ /^\s*$/
+        'text/plain'
+      else
+        ''
+      end
+    end
+
+    def get_mime_type( val )
+      case
+      when val =~ /^([\w\-]+)\/([\w\-]+);.+$/i
+        "#{$1}/#{$2}"
+      else
+        'text/plain'
+      end
+    end
+  end
+end