Docs For Class IMP

Description

The IMP_Headers:: class contains all functions related to handling the headers of mail messages in IMP.

$Horde: imp/lib/MIME/Headers.php,v 1.92.2.41 2009/11/19 19:04:35 slusarz Exp $

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

author: Michael Slusarz <slusarz@horde.org>

Located in /lib/MIME/Headers.php (line 28)

MIME_Headers
   |
   --IMP_Headers

Variable Summary

string $_agent

array $_obCache

Method Summary

string addLocalTime (string $date)

void addSiteHeaders ()

string buildAddressLinks (string $field, integer $addURL, [boolean $set = false], [boolean $link = true])

array getAddressesFromObject (array $obs)

array getListInformation ()

mixed getOb (string $field)

string getXpriority ()

void parseAllListHeaders ()

string parseListHeaders (string $header, [boolean $raw = false])

void setUserAgent (string $useragent)

void _getStream ()

Variables

string $_agent = IMP_AGENT_HEADER (line 35)

The User-Agent string to use.

array $_obCache = array() (line 42)

The header object cache.

Methods

addLocalTime (line 352)

Adds the local time string to the date header.

return: The date string with the local time added on.

string addLocalTime (string $date)

string $date: The date string.

addSiteHeaders (line 132)

Adds any site-specific headers defined in config/header.php to the internal header array.

void addSiteHeaders ()

buildAddressLinks (line 168)

Builds a string containing a list of addresses.

return: String containing the formatted address list.

string buildAddressLinks (string $field, integer $addURL, [boolean $set = false], [boolean $link = true])

string $field: The address field to parse.
integer $addURL: The self URL.
boolean $set: Set the associated header with the return string?
boolean $link: Link each address to the compose screen?

getAddressesFromObject (line 294)

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
 'host'      -  Host name
 'inner'     -  Trimmed, bare address
 'personal'  -  Personal string

TODO: Merge back to Horde_Mime_Headers with the changes to support groups.

array getAddressesFromObject (array $obs)

array $obs: An array of header objects (See imap_headerinfo() for the object structure).

getListInformation (line 440)

Returns e-mail information for a mailing list.

return: An array with 2 elements: 'exists' and 'reply_list'.
since: IMP 4.2

array getListInformation ()

getOb (line 387)

Returns a header from the header object.

return: The field requested.
todo: Move to framework for Horde 4.0.

mixed getOb (string $field)

string $field: The header to return as an object.

getXpriority (line 419)

Determines the X-Priority of the message based on the headers.

return: 'high', 'low', or 'normal'.
since: IMP 4.2

string getXpriority ()

parseAllListHeaders (line 58)

Parses all of the available mailing list headers.

void parseAllListHeaders ()

parseListHeaders (line 74)

Parses the information in the mailing list headers.

return: The header value (if $raw == true).

string parseListHeaders (string $header, [boolean $raw = false])

string $header: The header to process.
boolean $raw: Should the raw email be returned instead of setting the header value?

setUserAgent (line 407)

Explicitly sets the User-Agent string.

todo: Move to framework for Horde 4.0.
since: IMP 4.2

void setUserAgent (string $useragent)

string $useragent: The User-Agent string to use.

_getStream (line 49)

Returns a reference to a currently open IMAP stream.

see: MIME_Headers::_getStream()

void _getStream ()