mail-trunk 2.3.0

data/lib/mail/field_list.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+module Mail
+
+  # Field List class provides an enhanced array that keeps a list of 
+  # email fields in order.  And allows you to insert new fields without
+  # having to worry about the order they will appear in.
+  class FieldList < Array
+
+    include Enumerable
+
+    def <<( new_field )
+      current_entry = self.rindex(new_field)
+      if current_entry
+        self.insert((current_entry + 1), new_field)
+      else
+        insert_idx = -1
+        self.each_with_index do |item, idx|
+          case item <=> new_field
+          when -1
+            next
+          when 0
+            next
+          when 1
+            insert_idx = idx
+            break
+          end
+        end
+        insert(insert_idx, new_field)
+      end
+    end
+    
+  end
+end

data/lib/mail/fields.rb

@@ -0,0 +1,35 @@
+module Mail
+  autoload :UnstructuredField, 'mail/fields/unstructured_field'
+  autoload :StructuredField, 'mail/fields/structured_field'
+  autoload :OptionalField, 'mail/fields/optional_field'
+
+  autoload :BccField, 'mail/fields/bcc_field'
+  autoload :CcField, 'mail/fields/cc_field'
+  autoload :CommentsField, 'mail/fields/comments_field'
+  autoload :ContentDescriptionField, 'mail/fields/content_description_field'
+  autoload :ContentDispositionField, 'mail/fields/content_disposition_field'
+  autoload :ContentIdField, 'mail/fields/content_id_field'
+  autoload :ContentLocationField, 'mail/fields/content_location_field'
+  autoload :ContentTransferEncodingField, 'mail/fields/content_transfer_encoding_field'
+  autoload :ContentTypeField, 'mail/fields/content_type_field'
+  autoload :DateField, 'mail/fields/date_field'
+  autoload :FromField, 'mail/fields/from_field'
+  autoload :InReplyToField, 'mail/fields/in_reply_to_field'
+  autoload :KeywordsField, 'mail/fields/keywords_field'
+  autoload :MessageIdField, 'mail/fields/message_id_field'
+  autoload :MimeVersionField, 'mail/fields/mime_version_field'
+  autoload :ReceivedField, 'mail/fields/received_field'
+  autoload :ReferencesField, 'mail/fields/references_field'
+  autoload :ReplyToField, 'mail/fields/reply_to_field'
+  autoload :ResentBccField, 'mail/fields/resent_bcc_field'
+  autoload :ResentCcField, 'mail/fields/resent_cc_field'
+  autoload :ResentDateField, 'mail/fields/resent_date_field'
+  autoload :ResentFromField, 'mail/fields/resent_from_field'
+  autoload :ResentMessageIdField, 'mail/fields/resent_message_id_field'
+  autoload :ResentSenderField, 'mail/fields/resent_sender_field'
+  autoload :ResentToField, 'mail/fields/resent_to_field'
+  autoload :ReturnPathField, 'mail/fields/return_path_field'
+  autoload :SenderField, 'mail/fields/sender_field'
+  autoload :SubjectField, 'mail/fields/subject_field'
+  autoload :ToField, 'mail/fields/to_field'
+end

data/lib/mail/fields/bcc_field.rb

@@ -0,0 +1,56 @@
+# encoding: utf-8
+# 
+# = Blind Carbon Copy Field
+# 
+# The Bcc field inherits from StructuredField and handles the Bcc: header
+# field in the email.
+# 
+# Sending bcc to a mail message will instantiate a Mail::Field object that
+# has a BccField as it's field type.  This includes all Mail::CommonAddress
+# module instance metods.
+# 
+# Only one Bcc field can appear in a header, though it can have multiple
+# addresses and groups of addresses.
+# 
+# == Examples:
+# 
+#  mail = Mail.new
+#  mail.bcc = 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
+#  mail.bcc    #=> ['Mikel Lindsaar <mikel@test.lindsaar.net>', 'ada@test.lindsaar.net']
+#  mail[:bcc]  #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::BccField:0x180e1c4
+#  mail['bcc'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::BccField:0x180e1c4
+#  mail['Bcc'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::BccField:0x180e1c4
+# 
+#  mail[:bcc].encoded   #=> ''      # Bcc field does not get output into an email
+#  mail[:bcc].decoded   #=> 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
+#  mail[:bcc].addresses #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
+#  mail[:bcc].formatted #=> ['Mikel Lindsaar <mikel@test.lindsaar.net>', 'ada@test.lindsaar.net']
+# 
+require 'mail/fields/common/common_address'
+
+module Mail
+  class BccField < StructuredField
+    
+    include Mail::CommonAddress
+    
+    FIELD_NAME = 'bcc'
+    CAPITALIZED_FIELD = 'Bcc'
+    
+    def initialize(value = '', charset = 'utf-8')
+      @charset = charset
+      super(CAPITALIZED_FIELD, strip_field(FIELD_NAME, value), charset)
+      self.parse
+      self
+    end
+    
+    # Bcc field should never be :encoded
+    def encoded
+      ''
+    end
+    
+    def decoded
+      do_decode
+    end
+    
+  end
+end

data/lib/mail/fields/cc_field.rb

@@ -0,0 +1,55 @@
+# encoding: utf-8
+# 
+# = Carbon Copy Field
+# 
+# The Cc field inherits from StructuredField and handles the Cc: header
+# field in the email.
+# 
+# Sending cc to a mail message will instantiate a Mail::Field object that
+# has a CcField as it's field type.  This includes all Mail::CommonAddress
+# module instance metods.
+# 
+# Only one Cc field can appear in a header, though it can have multiple
+# addresses and groups of addresses.
+# 
+# == Examples:
+# 
+#  mail = Mail.new
+#  mail.cc = 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
+#  mail.cc    #=> ['Mikel Lindsaar <mikel@test.lindsaar.net>', 'ada@test.lindsaar.net']
+#  mail[:cc]  #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::CcField:0x180e1c4
+#  mail['cc'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::CcField:0x180e1c4
+#  mail['Cc'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::CcField:0x180e1c4
+# 
+#  mail[:cc].encoded   #=> 'Cc: Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net\r\n'
+#  mail[:cc].decoded   #=> 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
+#  mail[:cc].addresses #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
+#  mail[:cc].formatted #=> ['Mikel Lindsaar <mikel@test.lindsaar.net>', 'ada@test.lindsaar.net']
+# 
+require 'mail/fields/common/common_address'
+
+module Mail
+  class CcField < StructuredField
+    
+    include Mail::CommonAddress
+    
+    FIELD_NAME = 'cc'
+    CAPITALIZED_FIELD = 'Cc'
+    
+    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/comments_field.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+# 
+# = Comments Field
+# 
+# The Comments field inherits from UnstructuredField and handles the Comments:
+# header field in the email.
+# 
+# Sending comments to a mail message will instantiate a Mail::Field object that
+# has a CommentsField as it's field type.
+#  
+# An email header can have as many comments fields as it wants.  There is no upper
+# limit, the comments field is also optional (that is, no comment is needed)
+# 
+# == Examples:
+# 
+#  mail = Mail.new
+#  mail.comments = 'This is a comment'
+#  mail.comments    #=> 'This is a comment'
+#  mail[:comments]  #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::CommentsField:0x180e1c4
+#  mail['comments'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::CommentsField:0x180e1c4
+#  mail['comments'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::CommentsField:0x180e1c4
+# 
+#  mail.comments = "This is another comment"
+#  mail[:comments].map { |c| c.to_s } 
+#  #=> ['This is a comment', "This is another comment"]
+#
+module Mail
+  class CommentsField < UnstructuredField
+    
+    FIELD_NAME = 'comments'
+    CAPITALIZED_FIELD = 'Comments'
+    
+    def initialize(value = nil, charset = 'utf-8')
+      @charset = charset
+      super(CAPITALIZED_FIELD, strip_field(FIELD_NAME, value))
+      self.parse
+      self
+    end
+    
+  end
+end

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

@@ -0,0 +1,16 @@
+module Mail
+  
+  class AddressContainer < Array
+    
+    def initialize(field, list = [])
+      @field = field
+      super(list)
+    end
+
+    def << (address)
+      @field << address
+    end
+
+  end
+  
+end

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

@@ -0,0 +1,125 @@
+# encoding: utf-8
+require 'mail/fields/common/address_container'
+
+module Mail
+  module CommonAddress # :nodoc:
+      
+    def parse(val = value)
+      unless val.blank?
+        @tree = AddressList.new(encode_if_needed(val))
+      else
+        nil
+      end
+    end
+    
+    def charset
+      @charset
+    end
+    
+    def encode_if_needed(val)
+      Encodings.address_encode(val, charset)
+    end
+    
+    # Allows you to iterate through each address object in the syntax tree
+    def each
+      tree.addresses.each do |address|
+        yield(address)
+      end
+    end
+
+    # Returns the address string of all the addresses in the address list
+    def addresses
+      list = tree.addresses.map { |a| a.address }
+      Mail::AddressContainer.new(self, list)
+    end
+
+    # Returns the formatted string of all the addresses in the address list
+    def formatted
+      list = tree.addresses.map { |a| a.format }
+      Mail::AddressContainer.new(self, list)
+    end
+  
+    # Returns the display name of all the addresses in the address list
+    def display_names
+      list = tree.addresses.map { |a| a.display_name }
+      Mail::AddressContainer.new(self, list)
+    end
+  
+    # Returns the actual address objects in the address list
+    def addrs
+      list = tree.addresses
+      Mail::AddressContainer.new(self, list)
+    end
+  
+    # Returns a hash of group name => address strings for the address list
+    def groups
+      @groups = Hash.new
+      tree.group_recipients.each do |group|
+        @groups[group.group_name.text_value.to_str] = get_group_addresses(group.group_list)
+      end
+      @groups
+    end
+  
+    # Returns the addresses that are part of groups
+    def group_addresses
+      groups.map { |k,v| v.map { |a| a.format } }.flatten
+    end
+
+    # Returns the name of all the groups in a string
+    def group_names # :nodoc:
+      tree.group_names
+    end
+  
+    def default
+      addresses
+    end
+
+    def <<(val)
+      case
+      when val.nil?
+        raise ArgumentError, "Need to pass an address to <<"
+      when val.blank?
+        parse(encoded)
+      else
+        parse((formatted + [val]).join(", "))
+      end
+    end
+  
+    private
+  
+    def do_encode(field_name)
+      return '' if value.blank?
+      address_array = tree.addresses.reject { |a| group_addresses.include?(a.encoded) }.compact.map { |a| a.encoded }
+      address_text  = address_array.join(", \r\n\s")
+      group_array = groups.map { |k,v| "#{k}: #{v.map { |a| a.encoded }.join(", \r\n\s")};" }
+      group_text  = group_array.join(" \r\n\s")
+      return_array = [address_text, group_text].reject { |a| a.blank? }
+      "#{field_name}: #{return_array.join(", \r\n\s")}\r\n"
+    end
+
+    def do_decode
+      return nil if value.blank?
+      address_array = tree.addresses.reject { |a| group_addresses.include?(a.decoded) }.map { |a| a.decoded }
+      address_text  = address_array.join(", ")
+      group_array = groups.map { |k,v| "#{k}: #{v.map { |a| a.decoded }.join(", ")};" }
+      group_text  = group_array.join(" ")
+      return_array = [address_text, group_text].reject { |a| a.blank? }
+      return_array.join(", ")
+    end
+
+    # Returns the syntax tree of the Addresses
+    def tree # :nodoc:
+      @tree ||= AddressList.new(value)
+    end
+  
+    def get_group_addresses(group_list)
+      if group_list.respond_to?(:addresses)
+        group_list.addresses.map do |address_tree|
+          Mail::Address.new(address_tree)
+        end
+      else
+        []
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# encoding: utf-8
+module Mail
+  module CommonDate # :nodoc:
+    # Returns a date time object of the parsed date
+    def date_time
+      ::DateTime.parse("#{element.date_string} #{element.time_string}")
+    end
+
+    def default
+      date_time
+    end
+    
+    def parse(val = value)
+      unless val.blank?
+        @element = Mail::DateTimeElement.new(val)
+        @tree = @element.tree
+      else
+        nil
+      end
+    end
+
+    private
+    
+    def do_encode(field_name)
+      "#{field_name}: #{value}\r\n"
+    end
+    
+    def do_decode
+      "#{value}"
+    end
+
+    def element
+      @element ||= Mail::DateTimeElement.new(value)
+    end
+    
+    # Returns the syntax tree of the Date
+    def tree
+      @tree ||= element.tree
+    end
+    
+  end
+end

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

@@ -0,0 +1,51 @@
+# encoding: utf-8
+module Mail
+  module CommonField # :nodoc:
+
+    def name=(value)
+      @name = value
+    end
+
+    def name
+      @name ||= nil
+    end
+
+    def value=(value)
+      @length = nil
+      @tree = nil
+      @element = nil
+      @value = value
+    end
+
+    def value
+      @value
+    end
+
+    def to_s
+      decoded
+    end
+
+    def default
+      decoded
+    end
+
+    def field_length
+      @length ||= "#{name}: #{encode(decoded)}".length
+    end
+
+    def responsible_for?( val )
+      name.to_s.downcase == val.to_s.downcase
+    end
+
+    private
+
+    def strip_field(field_name, value)
+      if value.is_a?(Array)
+        value
+      else
+        value.to_s.gsub(/#{field_name}:\s+/i, '')
+      end
+    end
+
+  end
+end