Class MIME_Headers

Description

The MIME_Headers:: class contains generic functions related to handling the headers of mail messages.

The default character set to use for headers should be defined in the variable $GLOBALS['mime_headers']['default_charset'] (defaults to US-ASCII per RFC 2045).

$Horde: framework/MIME/MIME/Headers.php,v 1.29.10.30 2009/04/08 16:26:35 jan Exp $

Copyright 2002-2009 The Horde Project (http://www.horde.org/)

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.fsf.org/copyleft/lgpl.html.

Located in /MIME/MIME/Headers.php (line 25)


	
			
Variable Summary
 string $_agent
 array $_allHeaders
 string $_eol
 array $_flags
 stdClass $_headerObject
 array $_headers
 string $_headerText
 integer $_index
Method Summary
 MIME_Headers MIME_Headers ([integer $index = null])
 void addAgentHeader ()
 void addDeliveryReceiptHeaders (string $to)
 void addHeader (string $header, string $value)
 void addMIMEHeaders (MIME_Part &$mime_part)
 void addResentHeaders (string $from, string $to)
 boolean alteredHeader (string $header)
 void buildFlags ()
 void buildHeaders ([boolean $decode = true])
 array getAddressesFromObject (array $obs)
 string getAgentHeader ()
 array getAllHeaders ([boolean $decode = true])
 string getEOL ()
 boolean getFlag (string $flag)
 string getFromAddress ()
 stdClass getHeaderObject ()
 string getHeaderText ()
 mixed getOb (string $field, [boolean $decode = false])
 string getString (string $header)
 mixed getValue (string $header)
 array listHeaders ()
 boolean listHeadersExist ()
 void removeHeader (string $header)
 void setEOL (string $eol)
 boolean setValue (string $header, string $value)
 void setValueByFunction (string $header, mixed $funcs)
 array toArray ()
 string toString ()
 resource &_getStream ()
Variables
string $_agent = HORDE_AGENT_HEADER (line 61)

The User-Agent string to use.

THIS VALUE SHOULD BE OVERRIDEN BY ALL SUBCLASSES.

array $_allHeaders (line 39)

Cached output of the MIME_Structure::parseMIMEHeaders() command.

string $_eol = "\n" (line 72)

The sequence to use as EOL for the headers.

The default is currently to output the EOL sequence internally as just "\n" instead of the canonical "\r\n" required in RFC 822 & 2045. To be RFC complaint, the full <CR><LF> EOL combination should be used when sending a message.

array $_flags = array() (line 623)

The internal flags array.

  • deprecated: since Horde 3.2
stdClass $_headerObject (line 53)

The header object returned from imap_headerinfo().

array $_headers = array() (line 32)

The internal headers array.

string $_headerText (line 46)

Cached output of the imap_fetchheader() command.

integer $_index (line 79)

The index of the message.

Methods
Constructor MIME_Headers (line 86)

Constructor.

MIME_Headers MIME_Headers ([integer $index = null])
  • integer $index: The message index to parse headers (DEPRECATED).
addAgentHeader (line 288)

Generate the user agent description header.

void addAgentHeader ()
addDeliveryReceiptHeaders (line 717)

Generate delivery receipt headers.

  • deprecated: since Horde 3.2
void addDeliveryReceiptHeaders (string $to)
  • string $to: The address the receipt should be mailed to.
addHeader (line 309)

Add a header to the header array.

void addHeader (string $header, string $value)
  • string $header: The header name.
  • string $value: The header value.
addMessageIdHeader (line 261)

Generate the 'Message-ID' header.

void addMessageIdHeader ()
addMIMEHeaders (line 449)

Add any MIME headers required for the MIME_Part.

void addMIMEHeaders (MIME_Part &$mime_part)
  • MIME_Part &$mime_part: The MIME_Part object.
addReceivedHeader (line 201)

Generate the 'Received' header for the Web browser->Horde hop (attempts to conform to guidelines in RFC 2821).

void addReceivedHeader ()
addResentHeaders (line 274)

Generate the 'Resent' headers (conforms to guidelines in RFC 2822 [3.6.6]).

void addResentHeaders (string $from, string $to)
  • string $from: The address to use for 'Resent-From'.
  • string $to: The address to use for 'Resent-To'.
alteredHeader (line 408)

Has the header been altered from the original?

  • return: True if the header has been altered.
boolean alteredHeader (string $header)
  • string $header: The header to analyze.
buildFlags (line 630)

Build the flags array.

  • deprecated: since Horde 3.2
void buildFlags ()
buildHeaders (line 142)

Build the header array.

void buildHeaders ([boolean $decode = true])
  • boolean $decode: MIME decode the headers?
getAddressesFromObject (line 472)

Return the list of addresses for a header object.

  • return: An array of objects.
     Object elements:
     'address'   -  Full address
     'display'   -  A displayable version of the address (Horde 3.2.1+)
     'host'      -  Host name
     'inner'     -  Trimmed, bare address
     'personal'  -  Personal string
array getAddressesFromObject (array $obs)
  • array $obs: An array of header objects (See imap_headerinfo() for the object structure).
getAgentHeader (line 298)

Returns the user agent description header.

  • return: The user agent header.
string getAgentHeader ()
getAllHeaders (line 127)

Return the full list of headers.

  • return: See MIME_Structure::parseMIMEHeaders().
array getAllHeaders ([boolean $decode = true])
  • boolean $decode: Decode the headers?
getEOL (line 559)

Get the string to use for EOLs.

  • return: The string to use for EOLs.
string getEOL ()
getFlag (line 684)

Returns the flag status.

  • return: True if the flag has been set, false if not.
  • deprecated: since Horde 3.2
boolean getFlag (string $flag)
  • string $flag: Is this flag set? Flags: recent, unseen, answered, draft, important, deleted
getFromAddress (line 569)

Get the primary from address (first address in the From: header).

  • return: The from address (user@host).
string getFromAddress ()
getHeaderObject (line 700)

Return the header object from imap_headerinfo().

  • return: See imap_headerinfo().
  • deprecated: since Horde 3.2
stdClass getHeaderObject ()
getHeaderText (line 107)

Return the full list of headers from the imap_fetchheader() function.

  • return: See imap_fetchheader().
string getHeaderText ()
getOb (line 592)

Get a header from the header object.

  • return: The field requested.
  • todo: Replace with getOb() from IMP's IMP_Headers for Horde 4.0.
mixed getOb (string $field, [boolean $decode = false])
  • string $field: The object field to retrieve (see imap_headerinfo() for the list of fields).
  • boolean $decode: Should the return value be MIME decoded? It will only be decoded if it is not an object itself.
getString (line 362)

Attempts to return the header in the correct case.

  • return: The value for the given header. If the header is not found, returns null.
string getString (string $header)
  • string $header: The header to search for.
getValue (line 381)

Attempt to return the value for a given header.

The following header fields can only have 1 entry, so if duplicate entries exist, the first value will be used: * To, From, Cc, Bcc, Date, Sender, Reply-to, Message-ID, In-Reply-To, References, Subject (RFC 2822 [3.6]) * All List Headers (RFC 2369 [3])

  • return: The value for the given header. If the header is not found, returns null.
mixed getValue (string $header)
  • string $header: The header to search for.
listHeaders (line 519)

Returns the list of valid mailing list headers.

  • return: The list of valid mailing list headers.
array listHeaders ()
listHeadersExist (line 539)

Do any mailing list headers exist?

  • return: True if any mailing list headers exist.
boolean listHeadersExist ()
removeHeader (line 327)

Remove a header from the header array.

void removeHeader (string $header)
  • string $header: The header name.
setEOL (line 549)

Sets a new string to use for EOLs.

void setEOL (string $eol)
  • string $eol: The string to use for EOLs.
setValue (line 342)

Set a value for a particular header ONLY if that header is set.

  • return: True if value was set, false if not.
boolean setValue (string $header, string $value)
  • string $header: The header name.
  • string $value: The header value.
setValueByFunction (line 422)

Transforms a Header value using the list of functions provided.

void setValueByFunction (string $header, mixed $funcs)
  • string $header: The header to alter.
  • mixed $funcs: A function, or an array of functions. The functions will be performed from right to left.
toArray (line 156)

Returns the internal header array in array format.

  • return: The headers in array format.
array toArray ()
toString (line 181)

Returns the internal header array in string format.

  • return: The headers in string format.
string toString ()
_getStream (line 97)

Returns a reference to a currently open IMAP stream.

THIS VALUE SHOULD BE OVERRIDEN BY ALL SUBCLASSES.

  • return: An IMAP resource stream.
resource &_getStream ()

Documentation generated on Sun, 30 Jan 2011 05:17:56 +0000 by phpDocumentor 1.4.3