Function mb_encode_mimeheader
Encode string for MIME header
Copyright: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
License: MIT License
Located at Cake/bootstrap.php
mb_encode_mimeheader( string $str , string $charset = 'UTF-8' , string $transferEncoding = 'B' , string $linefeed = "\r\n" , integer $indent = 1 )
Parameters summary
string |
$str |
The string being encoded |
string |
$charset = 'UTF-8' |
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). |
string |
$transferEncoding = 'B' |
$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. |
string |
$linefeed = "\r\n" |
specifies 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. |
integer |
$indent = 1 |
[definition unknown and appears to have no affect] |
Returns
-
string
A converted version of the string represented in ASCII.