mail 1.0.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.name)
+      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,40 @@
+# 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    #=> '#<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'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::BccField:0x180e1c4
+# 
+#  mail.bcc.to_s  #=> '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']
+# 
+module Mail
+  class BccField < StructuredField
+    
+    include Mail::CommonAddress
+    
+    FIELD_NAME = 'bcc'
+    
+    def initialize(*args)
+      super(FIELD_NAME, strip_field(FIELD_NAME, args.last))
+    end
+    
+  end
+end

data/lib/mail/fields/cc_field.rb

@@ -0,0 +1,40 @@
+# 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    #=> '#<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'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::CcField:0x180e1c4
+# 
+#  mail.cc.to_s  #=> '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']
+# 
+module Mail
+  class CcField < StructuredField
+    
+    include Mail::CommonAddress
+    
+    FIELD_NAME = 'cc'
+    
+    def initialize(*args)
+      super(FIELD_NAME, strip_field(FIELD_NAME, args.last))
+    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    #=> '#<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'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::CommentsField:0x180e1c4
+# 
+#  mail.comments.to_s  #=> 'This is a comment'
+# 
+#  mail.comments = "This is another comment"
+#  mail.comments.map { |c| c.to_s } 
+#  #=> ['This is a comment', "This is another comment"]
+#  mail.comments.to_s # Probably not what you want to do in this case
+#  #=> "This is a commentThis is another comment" 
+# 
+module Mail
+  class CommentsField < UnstructuredField
+    
+    FIELD_NAME = 'comments'
+    
+    def initialize(*args)
+      super(FIELD_NAME, strip_field(FIELD_NAME, args.last))
+    end
+    
+  end
+end

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

@@ -0,0 +1,62 @@
+# encoding: utf-8
+module Mail
+  module CommonAddress # :nodoc:
+    
+    module ClassMethods # :nodoc:
+      
+    end
+  
+    module InstanceMethods # :doc:
+      
+      # Allows you to iterate through each address object in the syntax tree
+      def each
+        tree.addresses.each do |address|
+          yield
+        end
+      end
+
+      # Returns the address string of all the addresses in the address list
+      def addresses
+        tree.addresses.map { |a| a.address }
+      end
+
+      # Returns the formatted string of all the addresses in the address list
+      def formatted
+        tree.addresses.map { |a| a.format }
+      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] = get_group_addresses(group.group_list.addresses)
+        end
+        @groups
+      end
+
+      # Returns the name of all the groups in a string
+      def group_names # :nodoc:
+        tree.group_names
+      end
+
+      private
+      
+      # Returns the syntax tree of the Addresses
+      def tree # :nodoc:
+        @tree ||= AddressList.new(value)
+      end
+      
+      def get_group_addresses(group_addresses)
+        group_addresses.map do |address_tree|
+          Mail::Address.new(address_tree)
+        end
+      end
+
+    end
+    
+    def self.included(receiver) # :nodoc:
+      receiver.send :include, InstanceMethods
+    end
+    
+  end
+end

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

@@ -0,0 +1,35 @@
+# encoding: utf-8
+module Mail
+  module CommonDate # :nodoc:
+    
+    module ClassMethods # :nodoc:
+      
+    end
+    
+    module InstanceMethods # :doc:
+      
+      # Returns a date time object of the parsed date
+      def date_time
+        ::DateTime.parse("#{element.date_string} #{element.time_string}")
+      end
+
+      private
+
+      def element
+        @element ||= Mail::DateTimeElement.new(value)
+      end
+      
+      # Returns the syntax tree of the Date
+      def tree
+        @tree ||= element.tree
+      end
+      
+    end
+    
+    def self.included(receiver) # :nodoc:
+      receiver.extend         ClassMethods
+      receiver.send :include, InstanceMethods
+    end
+    
+  end
+end

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

@@ -0,0 +1,128 @@
+# encoding: utf-8
+module Mail
+  module CommonField # :nodoc:
+    
+    module ClassMethods # :nodoc:
+      
+    end
+    
+    module InstanceMethods # :doc:
+      
+      def name=(value)
+        @name = capitalize_field(value)
+      end
+      
+      def name
+        @name
+      end
+      
+      def value=(value)
+        @length = nil
+        @tree = nil
+        @element = nil
+        @value = value
+      end
+      
+      def value
+        @value
+      end
+      
+      def encoded
+        value.blank? ? nil : "#{wrapped_value}\r\n"
+      end
+      
+      def decoded
+        value.blank? ? nil : "#{name}: #{value}\r\n"
+      end
+      
+      def to_s
+        decoded.to_s
+      end
+      
+      def field_length
+        @length ||= name.length + value.length + ': '.length
+      end
+      
+      def responsible_for?( val )
+        name.to_s.downcase == val.to_s.downcase
+      end
+
+      private
+
+      def strip_field(field_name, string) 
+        string.to_s.gsub(/#{field_name}:\s+/i, '')
+      end
+
+
+      # 2.2.3. Long Header Fields
+      # 
+      #  Each header field is logically a single line of characters comprising
+      #  the field name, the colon, and the field body.  For convenience
+      #  however, and to deal with the 998/78 character limitations per line,
+      #  the field body portion of a header field can be split into a multiple
+      #  line representation; this is called "folding".  The general rule is
+      #  that wherever this standard allows for folding white space (not
+      #  simply WSP characters), a CRLF may be inserted before any WSP.  For
+      #  example, the header field:
+      #  
+      #          Subject: This is a test
+      #  
+      #  can be represented as:
+      #  
+      #          Subject: This
+      #           is a test
+      #  
+      #  Note: Though structured field bodies are defined in such a way that
+      #  folding can take place between many of the lexical tokens (and even
+      #  within some of the lexical tokens), folding SHOULD be limited to
+      #  placing the CRLF at higher-level syntactic breaks.  For instance, if
+      #  a field body is defined as comma-separated values, it is recommended
+      #  that folding occur after the comma separating the structured items in
+      #  preference to other places where the field could be folded, even if
+      #  it is allowed elsewhere.
+      def wrapped_value # :nodoc:
+        case
+        when decoded.ascii_only? && field_length <= 78
+          "#{name}: #{value}"
+        when field_length <= 40 # Allow for =?ISO-8859-1?B?=...=
+          "#{name}: #{encode(value)}"
+        else
+          @folded_line = []
+          @unfolded_line = value.clone
+          fold("#{name}: ".length)
+          folded = @folded_line.compact.join("\r\n\t")
+          "#{name}: #{folded}"
+        end
+      end
+
+      def fold(prepend = 0) # :nodoc:
+        # Get the last whitespace character, OR we'll just choose 
+        # 78 if there is no whitespace
+        @unfolded_line.ascii_only? ? (limit = 78 - prepend) : (limit = 40 - prepend)
+        wspp = @unfolded_line.slice(0..limit) =~ /[ \t][^ \T]*$/ || limit
+        wspp = limit if wspp == 0
+        @folded_line << encode(@unfolded_line.slice!(0...wspp))
+        if @unfolded_line.length > limit
+          fold
+        else
+          @folded_line << encode(@unfolded_line)
+        end
+      end
+
+      def encode(value)
+        if RUBY_VERSION < '1.9'
+          Encodings.b_encode(value, $KCODE)
+        else
+          Encodings.b_encode(value, @value.encoding)
+        end
+      end
+
+    end
+    
+    def self.included(receiver) # :nodoc:
+      receiver.extend         ClassMethods
+      receiver.send :include, InstanceMethods
+    end
+    
+  end
+end

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

@@ -0,0 +1,35 @@
+# encoding: utf-8
+module Mail
+  module CommonMessageId # :nodoc:
+    
+    module ClassMethods # :nodoc:
+      
+    end
+    
+    module InstanceMethods # :doc:
+      
+      def tree
+        @tree ||= element.tree
+      end
+      
+      def element
+        @element ||= Mail::MessageIdsElement.new(value)
+      end
+      
+      def message_id
+        element.message_id
+      end
+      
+      def message_ids
+        element.message_ids
+      end
+      
+    end
+    
+    def self.included(receiver) # :nodoc:
+      receiver.extend         ClassMethods
+      receiver.send :include, InstanceMethods
+    end
+    
+  end
+end

data/lib/mail/fields/content_description_field.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+# 
+# 
+# 
+module Mail
+  class ContentDescriptionField < UnstructuredField
+    
+    FIELD_NAME = 'content-description'
+
+    def initialize(*args)
+      super(FIELD_NAME, strip_field(FIELD_NAME, args.last))
+    end
+    
+  end
+end

data/lib/mail/fields/content_disposition_field.rb

@@ -0,0 +1,34 @@
+# encoding: utf-8
+# 
+# 
+# 
+module Mail
+  class ContentDispositionField < StructuredField
+    
+    FIELD_NAME = 'content-disposition'
+
+    def initialize(*args)
+      super(FIELD_NAME, strip_field(FIELD_NAME, args.last))
+    end
+    
+    def tree
+      @element ||= Mail::ContentDispositionElement.new(value)
+      @tree ||= @element.tree
+    end
+    
+    def element
+      @element ||= Mail::ContentDispositionElement.new(value)
+    end
+
+    def disposition_type
+      element.disposition_type
+    end
+    
+    def parameters
+      @parameters = Hash.new
+      element.parameters.each { |p| @parameters.merge!(p) }
+      @parameters
+    end
+
+  end
+end