ICONV_MIME_ENCODE(3) 1 ICONV_MIME_ENCODE(3)
iconv_mime_encode - Composes a MIMEheader field
SYNOPSIS
string iconv_mime_encode NULL (string $field_name, string $field_value, [array $preferences])
DESCRIPTION
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
o $field_name
- The field name.
o $field_value
- The field value.
o $preferences
- You can control the behaviour of iconv_mime_encode(3) by specifying an associative array that contains configuration items to
the optional third parameter $preferences. The items supported by iconv_mime_encode(3) are listed below. Note that item names are
treated case-sensitive.
Configuration items supported by iconv_mime_encode(3)
+-----------------+--------------------------+---+---+---+
| 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 | | | |
| | for quoted-printable | | | |
| | encoding scheme. | | | |
| | | | | |
| | B | | | |
| | | | | |
| | B | | | |
| | | | | |
| input-charset | | | | |
| | | | | |
| | | | | |
| | string | | | |
| | | | | |
| | Specifies the character | | | |
| | set in which the first | | | |
| | parameter $field_name | | | |
| | and the second parameter | | | |
| | $field_value are pre- | | | |
| | sented. If not given, | | | |
| | iconv_mime_encode(3) | | | |
| | assumes those parameters | | | |
| | are presented to it in | | | |
| | the iconv.inter- | | | |
| | nal_encoding ini set- | | | |
| | ting. | | | |
| | | | | |
| | 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 | | | | |
| | | | | |
| | | | | |
| | integer | | | |
| | | | | |
| | 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, accord- | | | |
| | ing to RFC2822 - Inter- | | | |
| | net 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 "fold- | | | |
| | ing" is performed on a | | | |
| | long header field. If | | | |
| | not given, this defaults | | | |
| | to "
" ( CR LF). Note | | | |
| | that this parameter is | | | |
| | always treated as an | | | |
| | ASCII string regardless | | | |
| | of the value of input- | | | |
| | charset. | | | |
| | | | | |
| |
| | | |
| | | | | |
| |
| | | |
| | | | | |
+-----------------+--------------------------+---+---+---+
RETURN VALUES
Returns an encoded MIME field on success, or FALSE if an error occurs during the encoding.
EXAMPLES
Example #1
iconv_mime_encode(3) example
<?php
$preferences = array(
"input-charset" => "ISO-8859-1",
"output-charset" => "UTF-8",
"line-length" => 76,
"line-break-chars" => "
"
);
$preferences["scheme"] = "Q";
// This yields "Subject: =?UTF-8?Q?Pr=C3=BCfung=20Pr=C3=BCfung?="
echo iconv_mime_encode("Subject", "Prufung Prufung", $preferences);
$preferences["scheme"] = "B";
// This yields "Subject: =?UTF-8?B?UHLDvGZ1bmcgUHLDvGZ1bmc=?="
echo iconv_mime_encode("Subject", "Prufung Prufung", $preferences);
?>
SEE ALSO
imap_binary(3), mb_encode_mimeheader(3), imap_8bit(3), quoted_printable_encode(3).
PHP Documentation Group ICONV_MIME_ENCODE(3)