MB_ENCODE_MIMEHEADER(3) 1 MB_ENCODE_MIMEHEADER(3)
mb_encode_mimeheader - Encode string for MIME header
SYNOPSIS
string m0],n[int_m$indent]) (string $str, [string $charset = mb_internal_encoding()], [string $transfer_encoding = "B"], [string $line-
feed = "
DESCRIPTION
Encodes a given string$str by the MIME header encoding scheme.
PARAMETERS
o $str
- The string being encoded.
o $charset
-$charset specifies the name of the character set in which $str is represented in. The default value is determined by the current
NLS setting ( mbstring.language). mb_internal_encoding(3) should be set to same encoding.
o $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.
o $linefeed
-$linefeed specifies the EOL (end-of-line) marker with which mb_encode_mimeheader(3) performs line-folding (a RFC term, 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 "
" (CRLF) if not given.
o $indent
- Indentation of the first line (number of characters in the header before $str).
RETURN VALUES
A converted version of the string represented in ASCII.
EXAMPLES
Example #1
mb_encode_mimeheader(3) example
<?php
$name = ""; // kanji
$mbox = "kru";
$doma = "gtinn.mon";
$addr = mb_encode_mimeheader($name, "UTF-7", "Q") . " <" . $mbox . "@" . $doma . ">";
echo $addr;
?>
NOTES
Note
This function isn't designed to break lines at higher-level contextual break points (word boundaries, etc.). This behaviour may
clutter up the original string with unexpected spaces.
SEE ALSO
mb_decode_mimeheader(3).
PHP Documentation Group MB_ENCODE_MIMEHEADER(3)
