Class Mail::Field
In: lib/mail/field.rb
Parent: Object

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.

Methods

<=>   field   field=   method_missing   name   new   same   to_s   update   value   value=  

Included Modules

Patterns Comparable

Classes and Modules

Class Mail::Field::FieldError

Constants

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']
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 ]

Public Class methods

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'}])

Public Instance methods

[Validate]