iconv_mime_decode

Function • Params and return types changed in PHP 8.0

Decodes a MIME header field.

PHP 5
PHP 7
PHP 8.0
Improved
PHP 8.1
PHP 8.2-8.3
PHP 8.4
PHP 8.5
PHP 8.6

iconv_mime_decode Function synopsis

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

Parameters

$string

Typestring

The encoded header, as a string.

$mode

OptionalTypeintDefault value0

$mode determines the behaviour in the event iconv_mime_decode encounters a malformed MIME header field. You can specify any combination of the following bitmasks.

$mode accepts one of the following constant values:

$encoding

OptionalType?stringDefault valuenull

The optional $encoding parameter specifies the character set to represent the result by. If omitted or null, iconv.internal_encoding will be used.

Return value

Typestring|false

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

Changes to the iconv_mime_decode Function

PHP 8.0

  • Return type added: string|false
  • Parameter name of parameter #1 changed: $encoded_string to $string
  • Parameter type added for parameter #1 ($string): string
  • Parameter type added for parameter #2 ($mode): int
  • Parameter default value added for position #2 ($mode): 0
  • Parameter name of parameter #3 changed: $charset to $encoding
  • Parameter type added for parameter #3 ($encoding): ?string
  • Parameter default value added for position #3 ($encoding): null
  iconv_mime_decode(
-     $encoded_string,
+     string $string,
-     $mode,
+     int $mode = 0,
-     $charset
+     ?string $encoding = null
-   )
+   ): string|false

iconv_mime_decode Function Availability

PHP VersionAvailability
PHP 8.6Upcoming Release Yes
PHP 8.5Supported (Latest) Yes
PHP 8.4Supported Yes
PHP 8.3Security-Fixes Only Yes
PHP 8.2Security-Fixes Only Yes
PHP 8.1Unsupported Yes
PHP 8.0Unsupported Yes
PHP 7.4Unsupported Yes
PHP 7.3Unsupported Yes
PHP 7.2Unsupported Yes
PHP 7.1Unsupported Yes
PHP 7.0Unsupported Yes
PHP 5.6Unsupported Yes
PHP 5.5Unsupported Yes
PHP 5.4Unsupported Yes
PHP 5.3Unsupported Yes