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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 331340 $ -->
<refentry xml:id="function.mb-encode-mimeheader" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>mb_encode_mimeheader</refname>
<refpurpose>Encode string for MIME header</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<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><initializer>mb_internal_encoding()</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>transfer_encoding</parameter><initializer>"B"</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>linefeed</parameter><initializer>"\r\n"</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>indent</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
Encodes a given <type>string</type>
<parameter>str</parameter> by the MIME header encoding scheme.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>str</parameter></term>
<listitem>
<para>
The <type>string</type> being encoded.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>charset</parameter></term>
<listitem>
<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>).
<function>mb_internal_encoding</function> should be set to same encoding.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>transfer_encoding</parameter></term>
<listitem>
<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>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>linefeed</parameter></term>
<listitem>
<para>
<parameter>linefeed</parameter> specifies the EOL (end-of-line) marker
with which <function>mb_encode_mimeheader</function> performs
line-folding (a <link xlink:href="&url.rfc;2822">RFC</link> 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>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>indent</parameter></term>
<listitem>
<para>
Indentation of the first line (number of characters in the header
before <parameter>str</parameter>).
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A converted version of the <type>string</type> represented in ASCII.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>5.0.0</entry>
<entry>
The <parameter>indent</parameter> parameter was added.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<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>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<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>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>mb_decode_mimeheader</function></member>
</simplelist>
</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:"~/.phpdoc/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
-->
|
