cakephp-1.3 > Multibyte :: mb_encode_mimeheader()
A AclBase AclBehavior AclComponent AclNode AclShell Aco AcoAction AjaxHelper ApcEngine ApiShell App AppController AppController AppHelper AppHelper AppModel AppModel Aro AuthComponent B BakeShell BakeTask BehaviorCollection C Cache CacheEngine CacheHelper CakeErrorController CakeLog CakeRoute CakeSchema CakeSession CakeSocket ClassRegistry Component Configure ConnectionManager ConsoleShell ContainableBehavior Controller ControllerTask CookieComponent D DataSource DbAcl DbAclSchema DbConfigTask DboMssql DboMysql DboMysqlBase DboMysqli DboOracle DboPostgres DboSource DboSqlite Debugger Dispatcher E EmailComponent ErrorHandler ErrorHandler ExtractTask F File FileEngine FileLog FixtureTask Folder FormHelper H Helper HtmlHelper HttpSocket I I18n I18nModel i18nSchema I18nShell Inflector IniAcl J JavascriptHelper JqueryEngineHelper JsBaseEngineHelper JsHelper L L10n M MagicDb MagicFileResource MediaView MemcacheEngine Model ModelBehavior ModelTask MootoolsEngineHelper Multibyte N NumberHelper O Object Overloadable Overloadable Overloadable2 Overloadable2 P PagesController PagesController PaginatorHelper Permission PluginShortRoute PluginTask ProjectTask PrototypeEngineHelper R RequestHandlerComponent Router RssHelper S Sanitize Scaffold ScaffoldView SchemaShell Security SecurityComponent SessionComponent SessionHelper SessionsSchema Set Shell ShellDispatcher String T TemplateTask TestSuiteShell TestTask TextHelper ThemeView TimeHelper TranslateBehavior TreeBehavior V Validation View ViewTask X XcacheEngine Xml XmlElement XmlHelper XmlManager XmlNode XmlTextNode

mb_encode_mimeheader

line:250 at /cake/libs/multibyte.php
Encode string for MIME header

Method

(string) mb_encode_mimeheader ($str, $charset = 'UTF-8', $transfer_encoding = 'B', $linefeed = "\r\n", $indent = 1)

Parameters

ParameterTypeCommentDefault
$str string required The string being encoded
$charset string optional 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). 'UTF-8'
$transfer_encoding string optional specifies the scheme of MIME encoding. It should be either "B" (Base64) or "Q" (Quoted-Printable). Falls back to "B" if not given. 'B'
$linefeed string optional 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. "\r\n"
$indent integer optional [definition unknown and appears to have no affect] 1

Return

string

Comment

Encode string for MIME header

@param string $str The string being encoded
@param string $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).
@param string $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.
@param string $linefeed 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.
@param integer $indent [definition unknown and appears to have no affect]
@return string A converted version of the string represented in ASCII.