iconv_mime_decode_headers

PHP 5, PHP 7, PHP 8
iconv_mime_decode_headers - Decodes multiple MIME header fields at once
Manual
Code Examples

iconv_mime_decode_headers( string$headers, [int$mode = 0], [string|null$encoding = null] ): array|false

Decodes multiple MIME header fields at once.

Parameters

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.

Bitmasks acceptable to iconv_mime_decode_headers
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 Values

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.

Changelog

Version Description
8.0.0 encoding is nullable now.

Related Functions

Example of iconv_mime_decode_headers

Show all examples for iconv_mime_decode_headers

PHP Version:


Function iconv_mime_decode_headers:

iconv Functions

Most used PHP functions