iconv_mime_encode
(PHP 5, PHP 7, PHP 8)
iconv_mime_encode — Composes a MIME
header field
Description
$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:
Subject: =?ISO-8859-1?Q?Pr=FCfung_f=FCr?= Entwerfen von einer MIME kopfzeile
Parameters
-
field_name
-
The field name.
-
field_value
-
The field value.
-
options
-
You can control the behaviour of iconv_mime_encode() by specifying an associative array that contains configuration items to the optional third parameter
options
. The items supported by iconv_mime_encode() are listed below. Note that item names are treated case-sensitive.Configuration items supported by iconv_mime_encode() Item Type Description Default value Example scheme string Specifies the method to encode a field value by. The value of this item may be either "B" or "Q", where "B" stands for base64
encoding scheme and "Q" stands forquoted-printable
encoding scheme.B B input-charset string Specifies the character set in which the first parameter field_name
and the second parameterfield_value
are 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 string Specifies the character set to use to compose the MIME
header.iconv.internal_encoding UTF-8 line-length int Specifies 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 string Specifies 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" ( CR
LF
). 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
Example #1 iconv_mime_encode() example
<?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);
?>
See Also
- imap_binary() - Convert an 8bit string to a base64 string
- mb_encode_mimeheader() - Encode string for MIME header
- imap_8bit() - Convert an 8bit string to a quoted-printable string
- quoted_printable_encode() - Convert a 8 bit string to a quoted-printable string