mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-20 19:08:54 +00:00
5b9fc29465
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@78496 c90b9560-bf6c-de11-be94-00142212c4b1
76 lines
2.4 KiB
XML
76 lines
2.4 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.2 $ -->
|
|
<!-- splitted from ./en/functions/mbstring.xml, last change in rev 1.1 -->
|
|
<refentry id="function.mb-encode-mimeheader">
|
|
<refnamediv>
|
|
<refname>mb_encode_mimeheader</refname>
|
|
<refpurpose>Encode string for MIME header</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>mb_encode_mimeheader</methodname>
|
|
<methodparam><type>string</type><parameter>str</parameter></methodparam>
|
|
<methodparam choice="opt"><type>string</type><parameter>charset</parameter></methodparam>
|
|
<methodparam choice="opt"><type>string</type><parameter>transfer-encoding</parameter></methodparam>
|
|
<methodparam choice="opt"><type>string</type><parameter>linefeed</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
<function>mb_encode_mimeheader</function> converts string
|
|
<parameter>str</parameter> to encoded-word for header field.
|
|
It returns converted string in ASCII encoding.
|
|
</para>
|
|
<para>
|
|
<parameter>charset</parameter> is character encoding
|
|
name. Default is <literal>ISO-2022-JP</literal>.
|
|
</para>
|
|
<para>
|
|
<parameter>transfer-encoding</parameter> is transfer encoding. It
|
|
should be one of <literal>"B"</literal> (Base64) or
|
|
<literal>"Q"</literal> (Quoted-Printable). Default is
|
|
<literal>"B"</literal>.
|
|
</para>
|
|
<para>
|
|
<parameter>linefeed</parameter> is end of line marker. Default is
|
|
<literal>"\r\n"</literal> (CRLF).
|
|
</para>
|
|
<para>
|
|
<example>
|
|
<title><function>mb_convert_kana</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
$name = ""; // kanji
|
|
$mbox = "kru";
|
|
$doma = "gtinn.mon";
|
|
$addr = mb_encode_mimeheader($name, "UTF-7", "Q") . " <" . $mbox . "@" . $doma . ">";
|
|
echo $addr;
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
<para>
|
|
See also <function>mb_decode_mimeheader</function>.
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:1
|
|
sgml-indent-data:t
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"../../../../manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|