dball-mail 2.2.9.1

data/lib/mail/field.rb

@@ -0,0 +1,223 @@
+require 'mail/fields'
+
+# encoding: utf-8
+module Mail
+  # Provides a single class to call to create a new structured or unstructured
+  # field.  Works out per RFC what field of field it is being given and returns
+  # the correct field of class back on new.
+  # 
+  # ===Per RFC 2822
+  #  
+  #  2.2. Header Fields
+  #  
+  #     Header fields are lines composed of a field name, followed by a colon
+  #     (":"), followed by a field body, and terminated by CRLF.  A field
+  #     name MUST be composed of printable US-ASCII characters (i.e.,
+  #     characters that have values between 33 and 126, inclusive), except
+  #     colon.  A field body may be composed of any US-ASCII characters,
+  #     except for CR and LF.  However, a field body may contain CRLF when
+  #     used in header "folding" and  "unfolding" as described in section
+  #     2.2.3.  All field bodies MUST conform to the syntax described in
+  #     sections 3 and 4 of this standard.
+  #  
+  class Field
+    
+    include Patterns
+    include Comparable
+    
+    STRUCTURED_FIELDS = %w[ bcc cc content-description content-disposition
+                            content-id content-location content-transfer-encoding
+                            content-type date from in-reply-to keywords message-id
+                            mime-version received references reply-to
+                            resent-bcc resent-cc resent-date resent-from
+                            resent-message-id resent-sender resent-to
+                            return-path sender to ]
+
+    KNOWN_FIELDS = STRUCTURED_FIELDS + ['comments', 'subject']
+    
+    # Generic Field Exception
+    class FieldError < StandardError
+    end
+
+    # Raised when a parsing error has occurred (ie, a StructuredField has tried
+    # to parse a field that is invalid or improperly written)
+    class ParseError < FieldError #:nodoc:
+    end
+
+    # Raised when attempting to set a structured field's contents to an invalid syntax
+    class SyntaxError < FieldError #:nodoc:
+    end
+    
+    # Accepts a string:
+    # 
+    #  Field.new("field-name: field data")
+    # 
+    # Or name, value pair:
+    # 
+    #  Field.new("field-name", "value")
+    # 
+    # Or a name by itself:
+    # 
+    #  Field.new("field-name")
+    # 
+    # Note, does not want a terminating carriage return.  Returns
+    # self appropriately parsed.  If value is not a string, then
+    # it will be passed through as is, for example, content-type
+    # field can accept an array with the type and a hash of 
+    # parameters:
+    # 
+    #  Field.new('content-type', ['text', 'plain', {:charset => 'UTF-8'}])
+    def initialize(name, value = nil, charset = 'utf-8')
+      case
+      when name =~ /:/ && value.blank?   # Field.new("field-name: field data")
+        name, value = split(name)
+        create_field(name, value, charset)
+      when name !~ /:/ && value.blank?  # Field.new("field-name")
+        create_field(name, nil, charset)
+      else                              # Field.new("field-name", "value")
+        create_field(name, value, charset)
+      end
+      return self
+    end
+
+    def field=(value)
+      @field = value
+    end
+    
+    def field
+      @field
+    end
+    
+    def name
+      field.name
+    end
+    
+    def value
+      field.value
+    end
+    
+    def value=(val)
+      create_field(name, val, charset)
+    end
+    
+    def to_s
+      field.to_s
+    end
+    
+    def update(name, value)
+      create_field(name, value, charset)
+    end
+    
+    def same( other )
+      match_to_s(other.name, field.name)
+    end
+    
+    def <=>( other )
+      self_order = FIELD_ORDER.rindex(self.name.to_s.downcase) || 100
+      other_order = FIELD_ORDER.rindex(other.name.to_s.downcase) || 100
+      self_order <=> other_order
+    end
+    
+    def method_missing(name, *args, &block)
+      field.send(name, *args, &block)
+    end
+    
+    FIELD_ORDER = %w[ return-path received
+                      resent-date resent-from resent-sender resent-to
+                      resent-cc resent-bcc resent-message-id
+                      date from sender reply-to to cc bcc
+                      message-id in-reply-to references
+                      subject comments keywords
+                      mime-version content-type content-transfer-encoding
+                      content-location content-disposition content-description ]
+    
+    private
+    
+    def split(raw_field)
+      match_data = raw_field.mb_chars.match(/^(#{FIELD_NAME})\s*:\s*(#{FIELD_BODY})?$/)
+      [match_data[1].to_s.mb_chars.strip, match_data[2].to_s.mb_chars.strip]
+    rescue
+      STDERR.puts "WARNING: Could not parse (and so ignorning) '#{raw_field}'"
+    end
+    
+    def create_field(name, value, charset)
+      begin
+        self.field = new_field(name, value, charset)
+      rescue Mail::Field::ParseError => e
+        self.field = Mail::UnstructuredField.new(name, value)
+        self.field.errors << [name, value, e]
+        self.field
+      end
+    end
+
+    def new_field(name, value, charset)
+      # Could do this with constantize and make it "as DRY as", but a simple case 
+      # statement is, well, simpler... 
+      case name.to_s.downcase
+      when /^to$/i
+        ToField.new(value, charset)
+      when /^cc$/i
+        CcField.new(value, charset)
+      when /^bcc$/i
+        BccField.new(value, charset)
+      when /^message-id$/i
+        MessageIdField.new(value, charset)
+      when /^in-reply-to$/i
+        InReplyToField.new(value, charset)
+      when /^references$/i
+        ReferencesField.new(value, charset)
+      when /^subject$/i
+        SubjectField.new(value, charset)
+      when /^comments$/i
+        CommentsField.new(value, charset)
+      when /^keywords$/i
+        KeywordsField.new(value, charset)
+      when /^date$/i
+        DateField.new(value, charset)
+      when /^from$/i
+        FromField.new(value, charset)
+      when /^sender$/i
+        SenderField.new(value, charset)
+      when /^reply-to$/i
+        ReplyToField.new(value, charset)
+      when /^resent-date$/i
+        ResentDateField.new(value, charset)
+      when /^resent-from$/i
+        ResentFromField.new(value, charset)
+      when /^resent-sender$/i 
+        ResentSenderField.new(value, charset)
+      when /^resent-to$/i
+        ResentToField.new(value, charset)
+      when /^resent-cc$/i
+        ResentCcField.new(value, charset)
+      when /^resent-bcc$/i
+        ResentBccField.new(value, charset)
+      when /^resent-message-id$/i
+        ResentMessageIdField.new(value, charset)
+      when /^return-path$/i
+        ReturnPathField.new(value, charset)
+      when /^received$/i
+        ReceivedField.new(value, charset)
+      when /^mime-version$/i
+        MimeVersionField.new(value, charset)
+      when /^content-transfer-encoding$/i
+        ContentTransferEncodingField.new(value, charset)
+      when /^content-description$/i
+        ContentDescriptionField.new(value, charset)
+      when /^content-disposition$/i
+        ContentDispositionField.new(value, charset)
+      when /^content-type$/i
+        ContentTypeField.new(value, charset)
+      when /^content-id$/i
+        ContentIdField.new(value, charset)
+      when /^content-location$/i
+        ContentLocationField.new(value, charset)
+      else 
+        OptionalField.new(name, value, charset)
+      end
+      
+    end
+
+  end
+  
+end

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/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,50 @@
+# encoding: utf-8
+module Mail
+  module CommonField # :nodoc:
+    def name=(value)
+      @name = value
+    end
+    
+    def name
+      @name
+    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

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

@@ -0,0 +1,44 @@
+# 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}: #{do_decode}\r\n}
+    end
+    
+    def do_decode
+      "#{message_ids.map { |m| "<#{m}>" }.join(' ')}"
+    end
+    
+  end
+end