kbaum-mail 2.1.2.1

data/lib/mail/elements/content_disposition_element.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+module Mail
+  class ContentDispositionElement # :nodoc:
+    
+    include Mail::Utilities
+    
+    def initialize( string )
+      parser = Mail::ContentDispositionParser.new
+      if tree = parser.parse(cleaned(string))
+        @disposition_type = tree.disposition_type.text_value
+        @parameters = tree.parameters
+      else
+        raise Mail::Field::ParseError, "ContentDispositionElement can not parse |#{string}|\nReason was: #{parser.failure_reason}\n"
+      end
+    end
+    
+    def disposition_type
+      @disposition_type
+    end
+    
+    def parameters
+      @parameters
+    end
+    
+    def cleaned(string)
+      string =~ /(.+);\s*$/ ? $1 : string
+    end
+    
+  end
+end

data/lib/mail/elements/content_location_element.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+module Mail
+  class ContentLocationElement # :nodoc:
+    
+    include Mail::Utilities
+    
+    def initialize( string )
+      parser = Mail::ContentLocationParser.new
+      if tree = parser.parse(string)
+        @location = tree.location.text_value
+      else
+        raise Mail::Field::ParseError, "ContentLocationElement can not parse |#{string}|\nReason was: #{parser.failure_reason}\n"
+      end
+    end
+    
+    def location
+      @location
+    end
+    
+    def to_s(*args)
+      location.to_s
+    end
+    
+  end
+end

data/lib/mail/elements/content_transfer_encoding_element.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+module Mail
+  class ContentTransferEncodingElement
+    
+    include Mail::Utilities
+    
+    def initialize( string )
+      parser = Mail::ContentTransferEncodingParser.new
+      if tree = parser.parse(string.downcase)
+        @encoding = tree.encoding.text_value
+      else
+        raise Mail::Field::ParseError, "ContentTransferEncodingElement can not parse |#{string}|\nReason was: #{parser.failure_reason}\n"
+      end
+    end
+    
+    def encoding
+      @encoding
+    end
+    
+  end
+end

data/lib/mail/elements/content_type_element.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+module Mail
+  class ContentTypeElement # :nodoc:
+    
+    include Mail::Utilities
+    
+    def initialize( string )
+      parser = Mail::ContentTypeParser.new
+      if tree = parser.parse(cleaned(string))
+        @main_type = tree.main_type.text_value
+        @sub_type = tree.sub_type.text_value
+        @parameters = tree.parameters
+      else
+        raise Mail::Field::ParseError, "ContentTypeElement can not parse |#{string}|\nReason was: #{parser.failure_reason}\n"
+      end
+    end
+    
+    def main_type
+      @main_type
+    end
+    
+    def sub_type
+      @sub_type
+    end
+    
+    def parameters
+      @parameters
+    end
+    
+    def cleaned(string)
+      string =~ /(.+);\s*$/ ? $1 : string
+    end
+    
+  end
+end

data/lib/mail/elements/date_time_element.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+module Mail
+  class DateTimeElement # :nodoc:
+    
+    include Mail::Utilities
+    
+    def initialize( string )
+      parser = Mail::DateTimeParser.new
+      if tree = parser.parse(string)
+        @date_string = tree.date.text_value
+        @time_string = tree.time.text_value
+      else
+        raise Mail::Field::ParseError, "DateTimeElement can not parse |#{string}|\nReason was: #{parser.failure_reason}\n"
+      end
+    end
+    
+    def date_string
+      @date_string
+    end
+    
+    def time_string
+      @time_string
+    end
+    
+  end
+end

data/lib/mail/elements/envelope_from_element.rb

@@ -0,0 +1,34 @@
+# encoding: utf-8
+module Mail
+  class EnvelopeFromElement
+    
+    include Mail::Utilities
+    
+    def initialize( string )
+      parser = Mail::EnvelopeFromParser.new
+      if @tree = parser.parse(string)
+        @address = tree.addr_spec.text_value.strip
+        @date_time = ::DateTime.parse("#{tree.ctime_date.text_value}")
+      else
+        raise Mail::Field::ParseError, "EnvelopeFromElement can not parse |#{string}|\nReason was: #{parser.failure_reason}\n"
+      end
+    end
+    
+    def tree
+      @tree
+    end
+    
+    def date_time
+      @date_time
+    end
+    
+    def address
+      @address
+    end
+    
+    def to_s(*args)
+      "#{@info}; #{@date_time.to_s(*args)}"
+    end
+    
+  end
+end

data/lib/mail/elements/message_ids_element.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+module Mail
+  class MessageIdsElement
+    
+    include Mail::Utilities
+    
+    def initialize(string)
+      parser = Mail::MessageIdsParser.new
+      if tree = parser.parse(string)
+        @message_ids = tree.message_ids.map { |msg_id| clean_msg_id(msg_id.text_value) }
+      else
+        raise Mail::Field::ParseError, "MessageIdsElement can not parse |#{string}|\nReason was: #{parser.failure_reason}\n"
+      end
+    end
+    
+    def message_ids
+      @message_ids
+    end
+    
+    def message_id
+      @message_ids.first
+    end
+    
+    def clean_msg_id( val )
+      val =~ /.*<(.*)>.*/ ; $1
+    end
+
+  end
+end

data/lib/mail/elements/mime_version_element.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+module Mail
+  class MimeVersionElement
+    
+    include Mail::Utilities
+    
+    def initialize( string )
+      parser = Mail::MimeVersionParser.new
+      if tree = parser.parse(string)
+        @major = tree.major.text_value
+        @minor = tree.minor.text_value
+      else
+        raise Mail::Field::ParseError, "MimeVersionElement can not parse |#{string}|\nReason was: #{parser.failure_reason}\n"
+      end
+    end
+    
+    def major
+      @major
+    end
+    
+    def minor
+      @minor
+    end
+    
+  end
+end

data/lib/mail/elements/phrase_list.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+module Mail
+  class PhraseList
+    
+    include Mail::Utilities
+    
+    def initialize(string)
+      parser = Mail::PhraseListsParser.new
+      if tree = parser.parse(string)
+        @phrases = tree.phrases
+      else
+        raise Mail::Field::ParseError, "PhraseList can not parse |#{string}|\nReason was: #{parser.failure_reason}\n"
+      end
+    end
+    
+    def phrases
+      @phrases.map { |p| unquote(p.text_value) }
+    end
+
+  end
+end

data/lib/mail/elements/received_element.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+module Mail
+  class ReceivedElement
+    
+    include Mail::Utilities
+    
+    def initialize( string )
+      parser = Mail::ReceivedParser.new
+      if tree = parser.parse(string)
+        @date_time = ::DateTime.parse("#{tree.date_time.date.text_value} #{tree.date_time.time.text_value}")
+        @info = tree.name_val_list.text_value
+      else
+        raise Mail::Field::ParseError, "ReceivedElement can not parse |#{string}|\nReason was: #{parser.failure_reason}\n"
+      end
+    end
+    
+    def date_time
+      @date_time
+    end
+    
+    def info
+      @info
+    end
+    
+    def to_s(*args)
+      "#{@info}; #{@date_time.to_s(*args)}"
+    end
+    
+  end
+end

data/lib/mail/encodings/base64.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+module Mail
+  module Encodings
+    class Base64
+      
+      # Decode the string from Base64
+      def self.decode(str)
+        RubyVer.decode_base64( str )
+      end
+    
+      # Encode the string to Base64
+      def self.encode(str)
+        RubyVer.encode_base64( str )
+      end
+      
+    end
+  end
+end

data/lib/mail/encodings/encodings.rb

@@ -0,0 +1,201 @@
+# encoding: utf-8
+module Mail
+  # Raised when attempting to decode an unknown encoding type
+  class UnknownEncodingType < StandardError #:nodoc:
+  end
+
+  module Encodings
+    
+    include Mail::Patterns
+    
+    # Is the encoding we want defined?
+    # 
+    # Example:
+    # 
+    #  Encodings.defined?(:base64) #=> true
+    def Encodings.defined?( str )
+      string = str.to_s.split(/[_-]/).map { |v| v.capitalize }.join('')
+      RubyVer.has_constant?(Mail::Encodings, string)
+    end
+    
+    # Gets a defined encoding type, QuotedPrintable or Base64 for now.
+    # 
+    # Each encoding needs to be defined as a Mail::Encodings::ClassName for 
+    # this to work, allows us to add other encodings in the future.
+    # 
+    # Example:
+    # 
+    #  Encodings.get_encoding(:base64) #=> Mail::Encodings::Base64
+    def Encodings.get_encoding( str )
+      string = str.to_s.split(/[_-]/).map { |v| v.capitalize }.join('')
+      RubyVer.get_constant(Mail::Encodings, string)
+    end
+
+    # Encodes a parameter value using URI Escaping, note the language field 'en' can
+    # be set using Mail::Configuration, like so:
+    # 
+    #  Mail.defaults.do
+    #    param_encode_language 'jp'
+    #  end
+    #
+    # The character set used for encoding will either be the value of $KCODE for 
+    # Ruby < 1.9 or the encoding on the string passed in.
+    # 
+    # Example:
+    # 
+    #  Mail::Encodings.param_encode("This is fun") #=> "us-ascii'en'This%20is%20fun"
+    def Encodings.param_encode(str)
+      case
+      when str.ascii_only? && str =~ TOKEN_UNSAFE
+        %Q{"#{str}"}
+      when str.ascii_only?
+        str
+      else
+        RubyVer.param_encode(str)
+      end
+    end
+
+    # Decodes a parameter value using URI Escaping.
+    # 
+    # Example:
+    # 
+    #  Mail::Encodings.param_decode("This%20is%20fun", 'us-ascii') #=> "This is fun"
+    #
+    #  str = Mail::Encodings.param_decode("This%20is%20fun", 'iso-8559-1')
+    #  str.encoding #=> 'ISO-8859-1'      ## Only on Ruby 1.9
+    #  str #=> "This is fun"
+    def Encodings.param_decode(str, encoding)
+      RubyVer.param_decode(str, encoding)
+    end
+    
+    # Decodes or encodes a string as needed for either Base64 or QP encoding types in
+    # the =?<encoding>?[QB]?<string>?=" format.
+    # 
+    # The output type needs to be :decode to decode the input string or :encode to
+    # encode the input string.  The character set used for encoding will either be
+    # the value of $KCODE for Ruby < 1.9 or the encoding on the string passed in.
+    # 
+    # On encoding, will only send out Base64 encoded strings.
+    def Encodings.decode_encode(str, output_type)
+      case
+      when output_type == :decode
+        Encodings.value_decode(str)
+      else
+        if str.ascii_only?
+          str
+        else
+          Encodings.b_value_encode(str, find_encoding(str))
+        end
+      end
+    end
+    
+    # Decodes a given string as Base64 or Quoted Printable, depending on what
+    # type it is.
+    # 
+    # String has to be of the format =?<encoding>?[QB]?<string>?=
+    def Encodings.value_decode(str)
+      str.gsub!(/\?=(\s*)=\?/, '?==?') # Remove whitespaces between 'encoded-word's
+      str.gsub(/(.*?)(=\?.*?\?.\?.*?\?=)|$/m) do
+        before = $1.to_s
+        text = $2.to_s
+        
+        case
+        when text =~ /=\?.+\?[Bb]\?/m
+          before + b_value_decode(text)
+        when text =~ /=\?.+\?[Qq]\?/m
+          before + q_value_decode(text)
+        else
+          before + text
+        end
+      end
+    end
+    
+    # Takes an encoded string of the format =?<encoding>?[QB]?<string>?=
+    def Encodings.unquote_and_convert_to(str, to_encoding)
+      original_encoding, string = split_encoding_from_string( str )
+
+      output = value_decode( str ).to_s
+
+      if original_encoding.to_s.downcase.gsub("-", "") == to_encoding.to_s.downcase.gsub("-", "")
+        output
+      elsif original_encoding && to_encoding
+        begin
+          require 'iconv'
+          Iconv.iconv(to_encoding, original_encoding, output).first
+        rescue Iconv::IllegalSequence, Iconv::InvalidEncoding, Errno::EINVAL
+          # the 'from' parameter specifies a charset other than what the text
+          # actually is...not much we can do in this case but just return the
+          # unconverted text.
+          #
+          # Ditto if either parameter represents an unknown charset, like
+          # X-UNKNOWN.
+          output
+        end
+      else
+        output
+      end
+    end
+    
+    # Encode a string with Base64 Encoding and returns it ready to be inserted
+    # as a value for a field, that is, in the =?<charset>?B?<string>?= format
+    #
+    # Example:
+    # 
+    #  Encodings.b_value_encode('This is あ string', 'UTF-8') 
+    #  #=> "=?UTF-8?B?VGhpcyBpcyDjgYIgc3RyaW5n?="
+    def Encodings.b_value_encode(str, encoding = nil)
+      string, encoding = RubyVer.b_value_encode(str, encoding)
+      string.split("\n").map do |str|
+        "=?#{encoding}?B?#{str.chomp}?="
+      end.join(" ")
+    end
+    
+    # Encode a string with Quoted-Printable Encoding and returns it ready to be inserted
+    # as a value for a field, that is, in the =?<charset>?Q?<string>?= format
+    #
+    # Example:
+    # 
+    #  Encodings.q_value_encode('This is あ string', 'UTF-8') 
+    #  #=> "=?UTF-8?Q?This_is_=E3=81=82_string?="
+    def Encodings.q_value_encode(str, encoding = nil)
+      string, encoding = RubyVer.q_value_encode(str, encoding)
+      "=?#{encoding}?Q?#{string.chomp.gsub(/ /, '_')}?="
+    end
+    
+    private
+    
+    # Decodes a Base64 string from the "=?UTF-8?B?VGhpcyBpcyDjgYIgc3RyaW5n?=" format
+    # 
+    # Example:
+    # 
+    #  Encodings.b_value_encode("=?UTF-8?B?VGhpcyBpcyDjgYIgc3RyaW5n?=") 
+    #  #=> 'This is あ string'
+    def Encodings.b_value_decode(str)
+      RubyVer.b_value_decode(str)
+    end
+    
+    # Decodes a Quoted-Printable string from the "=?UTF-8?Q?This_is_=E3=81=82_string?=" format
+    # 
+    # Example:
+    # 
+    #  Encodings.b_value_encode("=?UTF-8?Q?This_is_=E3=81=82_string?=") 
+    #  #=> 'This is あ string'
+    def Encodings.q_value_decode(str)
+      RubyVer.q_value_decode(str).gsub(/_/, ' ')
+    end
+    
+    def Encodings.split_encoding_from_string( str )
+      match = str.match(/\=\?(.+)?\?[QB]\?(.+)?\?\=/mi)
+      if match
+        [match[1], match[2]]
+      else
+        nil
+      end
+    end
+    
+    def Encodings.find_encoding(str)
+      RUBY_VERSION >= '1.9' ? str.encoding : $KCODE
+    end
+    
+  end
+end