mb_encode_mimeheader
mb_encode_mimeheader
(PHP 4 >= 4.0.6, PHP 5, PHP 7)
mb_encode_mimeheader — Encode string for MIME header
Description
string mb_encode_mimeheader ( string $str [, string $charset = determined by mb_language() [, string $transfer_encoding = "B" [, string $linefeed = "\r\n" [, int $indent = 0 ]]]] )
Encodes a given string str by the MIME header encoding scheme.
Parameters
-
str -
The string being encoded. Its encoding should be same as mb_internal_encoding().
-
charset -
charsetspecifies the name of the character set in whichstris represented in. The default value is determined by the current NLS setting (mbstring.language). -
transfer_encoding -
transfer_encodingspecifies the scheme of MIME encoding. It should be either "B" (Base64) or "Q" (Quoted-Printable). Falls back to "B" if not given. -
linefeed -
linefeedspecifies the EOL (end-of-line) marker with which mb_encode_mimeheader() 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 "\r\n" (CRLF) if not given. -
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() 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() - Decode string in MIME header field
© 1997–2017 The PHP Documentation Group
Licensed under the Creative Commons Attribution License v3.0 or later.
https://secure.php.net/manual/en/function.mb-encode-mimeheader.php
