| [ Index ] |
PHP Cross Reference of Unnamed Project |
[Source view] [Print] [Project Stats]
(no description)
| File Size: | 753 lines (24 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Horde_Mime_Headers:: (24 methods):
toArray()
toString()
addReceivedHeader()
addMessageIdHeader()
addUserAgentHeader()
getUserAgent()
setUserAgent()
addHeader()
removeHeader()
replaceHeader()
getString()
getValue()
addressFields()
singleFields()
mimeParamFields()
listHeaders()
listHeadersExist()
setEOL()
getEOL()
getOb()
_sanityCheck()
parseHeaders()
serialize()
unserialize()
Class: Horde_Mime_Headers - X-Ref
This class contains functions related to handling the headers of MIME data.| toArray(array $opts = array() X-Ref |
| Returns the internal header array in array format. param: array $opts Optional parameters: return: array The headers in array format. |
| toString(array $opts = array() X-Ref |
| Returns the internal header array in string format. param: array $opts Optional parameters: return: string The headers in string format. |
| addReceivedHeader(array $opts = array() X-Ref |
| Generate the 'Received' header for the Web browser->Horde hop (attempts to conform to guidelines in RFC 5321 [4.4]). param: array $opts Additional opts: |
| addMessageIdHeader() X-Ref |
| Generate the 'Message-ID' header. |
| addUserAgentHeader() X-Ref |
| Generate the user agent description header. |
| getUserAgent() X-Ref |
| Returns the user agent description header. return: string The user agent header. |
| setUserAgent($agent) X-Ref |
| Explicitly sets the User-Agent string. param: string $agent The User-Agent string to use. |
| addHeader($header, $value, array $opts = array() X-Ref |
| Add a header to the header array. param: string $header The header name. param: string $value The header value (UTF-8). param: array $opts Additional options: |
| removeHeader($header) X-Ref |
| Remove a header from the header array. param: string $header The header name. |
| replaceHeader($header, $value, array $opts = array() X-Ref |
| Replace a value of a header. param: string $header The header name. param: string $value The header value. param: array $opts Additional options: |
| getString($header) X-Ref |
| Attempts to return the header in the correct case. param: string $header The header to search for. return: string The value for the given header. |
| getValue($header, $type = self::VALUE_STRING) X-Ref |
| 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]) The values are not MIME encoded. param: string $header The header to search for. param: integer $type The type of return: return: mixed The value for the given header. |
| addressFields() X-Ref |
| Returns the list of RFC defined header fields that contain address info. return: array The list of headers, in lowercase. |
| singleFields($list = true) X-Ref |
| Returns the list of RFC defined header fields that can only contain a single value. param: boolean $list Return list-related headers also? return: array The list of headers, in lowercase. |
| mimeParamFields() X-Ref |
| Returns the list of RFC defined MIME header fields that may contain parameter info. return: array The list of headers, in lowercase. |
| listHeaders() X-Ref |
| Returns the list of valid mailing list headers. return: array The list of valid mailing list headers. |
| listHeadersExist() X-Ref |
| Do any mailing list headers exist? return: boolean True if any mailing list headers exist. |
| setEOL($eol) X-Ref |
| Sets a new string to use for EOLs. param: string $eol The string to use for EOLs. |
| getEOL() X-Ref |
| Get the string to use for EOLs. return: string The string to use for EOLs. |
| getOb($field) X-Ref |
| Returns an address object for a header. param: string $field The header to return as an object. return: Horde_Mail_Rfc822_List The object for the requested field. |
| _sanityCheck($data) X-Ref |
| Perform sanity checking on a raw header (e.g. handle 8-bit characters). param: string $data The header data. return: string The cleaned header data. |
| parseHeaders($text) X-Ref |
| Builds a Horde_Mime_Headers object from header text. param: mixed $text A text string (or, as of 2.3.0, a Horde_Stream return: Horde_Mime_Headers A new Horde_Mime_Headers object. |
| serialize() X-Ref |
| Serialization. return: string Serialized data. |
| unserialize($data) X-Ref |
| Unserialization. param: string $data Serialized data. |
| Generated: Thu Aug 11 10:00:09 2016 | Cross-referenced by PHPXref 0.7.1 |