iconv_mime_decode()

iconv_mime_decode() — Decodes a MIME header field.

Built-in function of PHP 8.5. The manual lists it as available in PHP 5, PHP 7, PHP 8. This page is the reference card: signature, parameters and return value, plus the changelog and the example the manual provides.

Signature

iconv_mime_decode(string $string, int $mode = 0, ?string $encoding = null): string|false

Parameters

ParameterTypeWhat it takes
$stringstringThe encoded header, as a string.
$modeintmode determines the behaviour in the event iconv_mime_decode() encounters a malformed MIME header field. You can specify any combination of the following bitmasks. Bitmasks acceptable to iconv_mime_decode() 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 ...
$encoding?stringThe optional encoding parameter specifies the character set to represent the result by. If omitted or null, iconv.internal_encoding will be used.

Return value

Returns a decoded MIME field on success, or false if an error occurs during the decoding.

Example

A runnable snippet:

// This yields "Subject: Prüfung Prüfung" echo iconv_mime_decode("Subject: =?UTF-8?B?UHLDvGZ1bmcgUHLDvGZ1bmc=?=", 0, "ISO-8859-1");

Changelog

VersionChange
8.0.0encoding is nullable now.

See also

iconv_mime_decode_headers(), mb_decode_mimeheader()

All PHP 8.5 built-in functions

Reference card built from the PHP manual page iconv_mime_decode() (PHP documentation, CC BY 3.0). The page is generated from the manual, so the wording of the parameter and return value text follows php.net.