iconv_mime_decode_headers
Description
The iconv_mime_decode_headers of iconv for PHP decodes multiple MIME header fields at once.
Syntax
iconv_mime_decode_headers(
string $headers,
int $mode = 0,
?string $encoding = null
): array|falseParameters
headers
The encoded headers, as a string.
mode
mode determines the behaviour in the event iconv_mime_decode_headers() encounters a malformed MIME header field. You can specify any combination of the following bitmasks:
| Value | Constant | Description |
|---|---|---|
| 1 | ICONV_MIME_DECODE_STRICT | If set, the given header is decoded in full conformance with the standards defined in RFC2047. This option is disabled by default because there are a lot of broken mail user agents that don't follow the specification and don't produce correct MIME headers. |
| 2 | ICONV_MIME_DECODE_CONTINUE_ON_ERROR | If set, iconv_mime_decode_headers() attempts to ignore any grammatical errors and continue to process a given header. |
encoding
The optional encoding parameter specifies the character set to represent the result by. If omitted or null, iconv.internal_encoding will be used.
Return
Returns an associative array that holds a whole set of MIME header fields specified by headers on success, or false if an error occurs during the decoding.
Each key of the return value represents an individual field name and the corresponding element represents a field value. If more than one field of the same name are present, iconv_mime_decode_headers() automatically incorporates them into a numerically indexed array in the order of occurrence. Note that header names are not case-insensitive.
Examples
1 · headers
<? $headers = <<<MYHEADERS subject: =?UTF-8?B?bXnCt3N1YmplY3Q=?= to: user@domain.com date: Thu, 1 Jan 1970 00:00:00 +0000 message-id: <user@domain.com> received: from localhost (localhost [127.0.0.1]) by localhost with SMTP id example for <user@domain.com>; Thu, 1 Jan 1970 00:00:00 +0000 (UTC) received: (qmail 0 invoked by uid 12345); 1 Thu 2003 00:00:00 +0000 MYHEADERS; $return = iconv_mime_decode_headers($headers); print_r($return); ?>
Array
(
[subject] => my·subject
[to] => user@domain.com
[date] => Thu, 1 Jan 1970 00:00:00 +0000
[message-id] => <user@domain.com>
[received] => Array
(
[0] => from localhost (localhost [127.0.0.1]) by localhost with SMTP id example for <user@domain.com>; Thu, 1 Jan 1970 00:00:00 +0000 (UTC)
[1] => (qmail 0 invoked by uid 12345); 1 Thu 2003 00:00:00 +0000
)
)
2 · mode · 0
<? $headers = <<<MYHEADERS subject: =?UTF-8?B?bXnCt3N1YmplY3Q=?= to: user@domain.com date: Thu, 1 Jan 1970 00:00:00 +0000 message-id: <user@domain.com> received: from localhost (localhost [127.0.0.1]) by localhost with SMTP id example for <user@domain.com>; Thu, 1 Jan 1970 00:00:00 +0000 (UTC) received: (qmail 0 invoked by uid 12345); 1 Thu 2003 00:00:00 +0000 MYHEADERS; $mode = 0; $return = iconv_mime_decode_headers($headers, $mode); print_r($return); ?>
Array
(
[subject] => my·subject
[to] => user@domain.com
[date] => Thu, 1 Jan 1970 00:00:00 +0000
[message-id] => <user@domain.com>
[received] => Array
(
[0] => from localhost (localhost [127.0.0.1]) by localhost with SMTP id example for <user@domain.com>; Thu, 1 Jan 1970 00:00:00 +0000 (UTC)
[1] => (qmail 0 invoked by uid 12345); 1 Thu 2003 00:00:00 +0000
)
)
3 · mode · 1
<? $headers = <<<MYHEADERS subject: =?UTF-8?B?bXnCt3N1YmplY3Q=?= to: user@domain.com date: Thu, 1 Jan 1970 00:00:00 +0000 message-id: <user@domain.com> received: from localhost (localhost [127.0.0.1]) by localhost with SMTP id example for <user@domain.com>; Thu, 1 Jan 1970 00:00:00 +0000 (UTC) received: (qmail 0 invoked by uid 12345); 1 Thu 2003 00:00:00 +0000 MYHEADERS; $mode = 1; $return = iconv_mime_decode_headers($headers, $mode); print_r($return); ?>
Array
(
[subject] => my·subject
[to] => user@domain.com
[date] => Thu, 1 Jan 1970 00:00:00 +0000
[message-id] => <user@domain.com>
[received] => Array
(
[0] => from localhost (localhost [127.0.0.1]) by localhost with SMTP id example for <user@domain.com>; Thu, 1 Jan 1970 00:00:00 +0000 (UTC)
[1] => (qmail 0 invoked by uid 12345); 1 Thu 2003 00:00:00 +0000
)
)
4 · mode · 2
<? $headers = <<<MYHEADERS subject: =?UTF-8?B?bXnCt3N1YmplY3Q=?= to: user@domain.com date: Thu, 1 Jan 1970 00:00:00 +0000 message-id: <user@domain.com> received: from localhost (localhost [127.0.0.1]) by localhost with SMTP id example for <user@domain.com>; Thu, 1 Jan 1970 00:00:00 +0000 (UTC) received: (qmail 0 invoked by uid 12345); 1 Thu 2003 00:00:00 +0000 MYHEADERS; $mode = 2; $return = iconv_mime_decode_headers($headers, $mode); print_r($return); ?>
Array
(
[subject] => my·subject
[to] => user@domain.com
[date] => Thu, 1 Jan 1970 00:00:00 +0000
[message-id] => <user@domain.com>
[received] => Array
(
[0] => from localhost (localhost [127.0.0.1]) by localhost with SMTP id example for <user@domain.com>; Thu, 1 Jan 1970 00:00:00 +0000 (UTC)
[1] => (qmail 0 invoked by uid 12345); 1 Thu 2003 00:00:00 +0000
)
)
5 · encoding
<? $headers = <<<MYHEADERS subject: =?UTF-8?B?bXnCt3N1YmplY3Q=?= to: user@domain.com date: Thu, 1 Jan 1970 00:00:00 +0000 message-id: <user@domain.com> received: from localhost (localhost [127.0.0.1]) by localhost with SMTP id example for <user@domain.com>; Thu, 1 Jan 1970 00:00:00 +0000 (UTC) received: (qmail 0 invoked by uid 12345); 1 Thu 2003 00:00:00 +0000 MYHEADERS; $mode = 0; $encoding = "ISO-8859-1"; $return = iconv_mime_decode_headers($headers, $mode, $encoding); print_r($return); ?>
Array
(
[subject] => my�subject
[to] => user@domain.com
[date] => Thu, 1 Jan 1970 00:00:00 +0000
[message-id] => <user@domain.com>
[received] => Array
(
[0] => from localhost (localhost [127.0.0.1]) by localhost with SMTP id example for <user@domain.com>; Thu, 1 Jan 1970 00:00:00 +0000 (UTC)
[1] => (qmail 0 invoked by uid 12345); 1 Thu 2003 00:00:00 +0000
)
)
