mail-trunk 2.3.0

data/lib/mail/elements/address_list.rb

@@ -0,0 +1,74 @@
+# encoding: utf-8
+module Mail
+  class AddressList # :nodoc:
+    
+    # Mail::AddressList is the class that parses To, From and other address fields from
+    # emails passed into Mail.
+    # 
+    # AddressList provides a way to query the groups and mailbox lists of the passed in
+    # string.
+    # 
+    # It can supply all addresses in an array, or return each address as an address object.
+    # 
+    # Mail::AddressList requires a correctly formatted group or mailbox list per RFC2822 or
+    # RFC822.  It also handles all obsolete versions in those RFCs.
+    # 
+    #  list = 'ada@test.lindsaar.net, My Group: mikel@test.lindsaar.net, Bob <bob@test.lindsaar.net>;'
+    #  a = AddressList.new(list)
+    #  a.addresses    #=> [#<Mail::Address:14943130 Address: |ada@test.lindsaar.net...
+    #  a.group_names  #=> ["My Group"]
+    def initialize(string)
+      if string.blank?
+        @address_nodes = []
+        return self
+      end
+      parser = Mail::AddressListsParser.new
+      if tree = parser.parse(string)
+        @address_nodes = tree.addresses
+      else
+        raise Mail::Field::ParseError, "AddressListsParser can not parse |#{string}|\nReason was: #{parser.failure_reason}\n"
+      end
+    end
+    
+    # Returns a list of address objects from the parsed line
+    def addresses
+      @addresses ||= get_addresses.map do |address_tree|
+        Mail::Address.new(address_tree)
+      end
+    end
+    
+    # Returns a list of all recipient syntax trees that are not part of a group
+    def individual_recipients # :nodoc:
+      @individual_recipients ||= @address_nodes - group_recipients
+    end
+    
+    # Returns a list of all recipient syntax trees that are part of a group
+    def group_recipients # :nodoc:
+      @group_recipients ||= @address_nodes.select { |an| an.respond_to?(:group_name) }
+    end
+    
+    # Returns the names as an array of strings of all groups
+    def group_names # :nodoc:
+      group_recipients.map { |g| g.group_name.text_value }
+    end
+    
+    # Returns a list of address syntax trees
+    def address_nodes # :nodoc:
+      @address_nodes
+    end
+    
+    private
+    
+    def get_addresses
+      (individual_recipients + group_recipients.map { |g| get_group_addresses(g) }).flatten
+    end
+    
+    def get_group_addresses(g)
+      if g.group_list.respond_to?(:addresses)
+        g.group_list.addresses
+      else
+        []
+      end
+    end
+  end
+end

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.downcase
+        @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,24 @@
+# encoding: utf-8
+module Mail
+  class ContentTransferEncodingElement
+    
+    include Mail::Utilities
+    
+    def initialize( string )
+      parser = Mail::ContentTransferEncodingParser.new
+      case
+      when string.blank?
+        @encoding = ''
+      when tree = parser.parse(string.to_s.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.downcase
+        @sub_type = tree.sub_type.text_value.downcase
+        @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.rb

@@ -0,0 +1,266 @@
+# encoding: utf-8
+
+module Mail
+  # Raised when attempting to decode an unknown encoding type
+  class UnknownEncodingType < StandardError #:nodoc:
+  end
+
+  module Encodings
+
+    include Mail::Patterns
+    extend  Mail::Utilities
+
+    @transfer_encodings = {}
+
+    # Register transfer encoding
+    #
+    # Example
+    #
+    # Encodings.register "base64", Mail::Encodings::Base64
+    def Encodings.register(name, cls)
+        @transfer_encodings[get_name(name)] = cls
+    end
+
+    # Is the encoding we want defined?
+    #
+    # Example:
+    #
+    #  Encodings.defined?(:base64) #=> true
+    def Encodings.defined?( str )
+      @transfer_encodings.include? get_name(str)
+    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 )
+      @transfer_encodings[get_name(str)]
+    end
+
+    def Encodings.get_all
+      @transfer_encodings.values
+    end
+
+    def Encodings.get_name(enc)
+      enc = enc.to_s.gsub("-", "_").downcase
+    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)
+      # Optimization: If there's no encoded-words in the string, just return it
+      return str unless str.index("=?")
+
+      str = str.gsub(/\?=(\s*)=\?/, '?==?') # Remove whitespaces between 'encoded-word's
+
+      # Split on white-space boundaries with capture, so we capture the white-space as well
+      str.split(/([ \t])/).map do |text|
+        if text.index('=?') .nil?
+          text
+        else
+          # Join QP encoded-words that are adjacent to avoid decoding partial chars
+          text.gsub!(/\?\=\=\?.+?\?[Qq]\?/m, '') if text =~ /\?==\?/
+
+          # Separate encoded-words with a space, so we can treat them one by one
+          text.gsub!(/\?\=\=\?/, '?= =?')
+          text.split(/ /).map do |word|
+            word.to_str.
+              gsub( /=\?.+\?[Bb]\?.+\?=/m ) { |substr| b_value_decode(substr) }.
+              gsub( /=\?.+\?[Qq]\?.+\?=/m ) { |substr| q_value_decode(substr) }
+            end
+        end
+      end.join("")
+    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
+          if RUBY_VERSION >= '1.9'
+            output.encode(to_encoding)
+          else
+            require 'iconv'
+            Iconv.iconv(to_encoding, original_encoding, output).first
+          end
+        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
+
+    def Encodings.address_encode(address, charset = 'utf-8')
+      if address.is_a?(Array)
+        # loop back through for each element
+        address.map { |a| Encodings.address_encode(a, charset) }.join(", ")
+      else
+        # find any word boundary that is not ascii and encode it
+        encode_non_usascii(address, charset)
+      end
+    end
+
+    def Encodings.encode_non_usascii(address, charset)
+      return address if address.ascii_only? or charset.nil?
+      us_ascii = %Q{\x00-\x7f}
+      # Encode any non usascii strings embedded inside of quotes
+      address.gsub!(/(".*?[^#{us_ascii}].+?")/) { |s| Encodings.b_value_encode(unquote(s), charset) }
+      # Then loop through all remaining items and encode as needed
+      tokens = address.split(/\s/)
+      map_with_index(tokens) do |word, i|
+        if word.ascii_only?
+          word
+        else
+          previous_non_ascii = tokens[i-1] && !tokens[i-1].ascii_only?
+          if previous_non_ascii
+            word = " #{word}"
+          end
+          Encodings.b_value_encode(word, charset)
+        end
+      end.join(' ')
+    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(encoded_str, encoding = nil)
+      return encoded_str if encoded_str.to_s.ascii_only?
+      string, encoding = RubyVer.b_value_encode(encoded_str, encoding)
+      map_lines(string) 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(encoded_str, encoding = nil)
+      return encoded_str if encoded_str.to_s.ascii_only?
+      string, encoding = RubyVer.q_value_encode(encoded_str, encoding)
+      string.gsub!("=\r\n", '') # We already have limited the string to the length we want
+      map_lines(string) do |str|
+        "=?#{encoding}?Q?#{str.chomp.gsub(/ /, '_')}?="
+      end.join(" ")
+    end
+
+    private
+
+    # Decodes a Base64 string from the "=?UTF-8?B?VGhpcyBpcyDjgYIgc3RyaW5n?=" format
+    #
+    # Example:
+    #
+    #  Encodings.b_value_decode("=?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.q_value_decode("=?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