HomeMenu
Jesus · Bible · HTML · CSS · JS · PHP · SVG · Applications

mb_encode_mimeheader

Description

The mb_encode_mimeheader of Multibyte String for PHP encode string for MIME header.

Syntax

mb_encode_mimeheader(
    string $string,
    ?string $charset = null,
    ?string $transfer_encoding = null,
    string $newline = "\r\n",
    int $indent = 0
): string

Parameters

string

The string being encoded. Its encoding should be same as mb_internal_encoding().

charset

charset specifies the name of the character set in which string is represented in. The default value is determined by the current NLS setting (mbstring.language).

transfer_encoding

transfer_encoding specifies the scheme of MIME encoding. It should be either "B" (Base64) or "Q" (Quoted-Printable). Falls back to "B" if not given.

newline

newline specifies the EOL (end-of-line) marker with which mb_encode_mimeheader() performs line-folding (the act of breaking a line longer than a certain length into multiple lines. The length is currently hard-coded to 74 characters). Falls back to "\r\n" (CRLF) if not given.

indent

Indentation of the first line (number of characters in the header before string).

Return

A converted version of the string represented in ASCII.

Examples

1 · string

<?

$string = "页眉";

$return = mb_encode_mimeheader($string);

echo $return;
=?UTF-8?B?6aG155yJ?=

2 · charset

<?

$string = "页眉";
$charset = "UTF-16";

$return = mb_encode_mimeheader($string, $charset);

echo $return;
=?UTF-16?B?mHV3CQ==?=

3 · transfer_encoding

<?

$string = "页眉";
$charset = "UTF-16";
$transfer_encoding = "Q";

$return = mb_encode_mimeheader($string, $charset, $transfer_encoding);

echo $return;
=?UTF-16?Q?=98uw=09?=

4 · newline

<?

$string = "页眉";
$charset = "UTF-16";
$transfer_encoding = "Q";
$newline = "\n";

$return = mb_encode_mimeheader($string, $charset, $transfer_encoding, $newline);

echo $return;
=?UTF-16?Q?=98uw=09?=

5 · indent

<?

$string = "页眉";
$charset = "UTF-16";
$transfer_encoding = "Q";
$newline = "\n";
$indent = 8;

$return = mb_encode_mimeheader($string, $charset, $transfer_encoding, $newline, $indent);

echo $return;
=?UTF-16?Q?=98uw=09?=