iconv_mime_encode
PHP function
Edit on GitHub ✎
(PHP 5, PHP 7, PHP 8)
Composes a MIME header field
Description
iconv_mime_encode(string $field_name, string $field_value, array $options = []): string|false
Composes and returns a string that represents a valid MIME header field, which looks like the following:
output
Subject: =?ISO-8859-1?Q?Pr=FCfung_f=FCr?= Entwerfen von einer MIME kopfzeileIn the above example, "Subject" is the field name and the portion that begins with "=?ISO-8859-1?..." is the field value.
Parameters
field_nameThe field name.
field_valueThe field value.
optionsYou can control the behaviour of
iconv_mime_encode()by specifying an associative array that contains configuration items to the optional third parameteroptions. The items supported byiconv_mime_encode()are listed below. Note that item names are treated case-sensitive.Item Type Description Default value Example scheme stringSpecifies the method to encode a field value by. The value of this item may be either "B" or "Q", where "B" stands for base64encoding scheme and "Q" stands forquoted-printableencoding scheme.B B input-charset stringSpecifies the character set in which the first parameter field_nameand the second parameterfield_valueare presented. If not given,iconv_mime_encode()assumes those parameters are presented to it in the iconv.internal_encoding ini setting.iconv.internal_encoding ISO-8859-1 output-charset stringSpecifies the character set to use to compose the MIMEheader.iconv.internal_encoding UTF-8 line-length intSpecifies the maximum length of the header lines. The resulting header is "folded" to a set of multiple lines in case the resulting header field would be longer than the value of this parameter, according to RFC2822 - Internet Message Format. If not given, the length will be limited to 76 characters. 76 996 line-break-chars stringSpecifies the sequence of characters to append to each line as an end-of-line sign when "folding" is performed on a long header field. If not given, this defaults to "\r\n" ( CRLF). Note that this parameter is always treated as an ASCII string regardless of the value ofinput-charset.\r\n \n
Return Values
Returns an encoded MIME field on success, or false if an error occurs during the encoding.
Examples
iconv_mime_encode() example
php
<?php
$preferences = array(
"input-charset" => "ISO-8859-1",
"output-charset" => "UTF-8",
"line-length" => 76,
"line-break-chars" => "\n"
);
$preferences["scheme"] = "Q";
// This yields "Subject: =?UTF-8?Q?Pr=C3=BCfung=20Pr=C3=BCfung?="
echo iconv_mime_encode("Subject", "Prüfung Prüfung", $preferences);
$preferences["scheme"] = "B";
// This yields "Subject: =?UTF-8?B?UHLDvGZ1bmcgUHLDvGZ1bmc=?="
echo iconv_mime_encode("Subject", "Prüfung Prüfung", $preferences);
?>