1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- 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> encodes a given string
<parameter>str</parameter> by the MIME header encoding scheme.
Returns a converted version of the string represented in ASCII.
</para>
<para>
<parameter>charset</parameter> specifies the name of the character set
in which <parameter>str</parameter> is represented in. The default value
is determined by the current NLS setting (<literal>mbstring.language</literal>).
</para>
<para>
<parameter>transfer_encoding</parameter> specifies the scheme of MIME
encoding. It should be either <literal>"B"</literal> (Base64) or
<literal>"Q"</literal> (Quoted-Printable). Falls back to
<literal>"B"</literal> if not given.
</para>
<para>
<parameter>linefeed</parameter> specifies the EOL (end-of-line) marker
with which <function>mb_encode_mimeheader</function> performs
line-folding (a <ulink url="&url.rfc;2822">RFC</ulink> 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 <literal>"\r\n"</literal> (CRLF) if not given.
</para>
<para>
<example>
<title><function>mb_encode_mimeheader</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$name = ""; // kanji
$mbox = "kru";
$doma = "gtinn.mon";
$addr = mb_encode_mimeheader($name, "UTF-7", "Q") . " <" . $mbox . "@" . $doma . ">";
echo $addr;
?>
]]>
</programlisting>
</example>
</para>
<note>
<para>
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.
</para>
</note>
<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
-->
|
