-
Notifications
You must be signed in to change notification settings - Fork 56
/
iconv-mime-decode-headers.xml
214 lines (204 loc) · 7.21 KB
/
iconv-mime-decode-headers.xml
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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 16a1bdfd1c36108534b5af08dc4b751c7ac0fdaf Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->
<refentry xml:id="function.iconv-mime-decode-headers" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>iconv_mime_decode_headers</refname>
<refpurpose>複数の <literal>MIME</literal> ヘッダフィールドを一度にデコードする</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>array</type><type>false</type></type><methodname>iconv_mime_decode_headers</methodname>
<methodparam><type>string</type><parameter>headers</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>mode</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
複数の <literal>MIME</literal> ヘッダフィールドを一度にデコードします。
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>headers</parameter></term>
<listitem>
<para>
エンコードされたヘッダを表す文字列。
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>mode</parameter></term>
<listitem>
<para>
<parameter>mode</parameter> は、<function>iconv_mime_decode_headers</function>
が不正な形式の <literal>MIME</literal> ヘッダフィールドに遭遇した場合の
振る舞いを定義します。以下のビットマスクの組み合わせで指定が可能です。
<table>
<title><function>iconv_mime_decode_headers</function> で指定できるビットマスク</title>
<tgroup cols="3">
<thead>
<row>
<entry>値</entry>
<entry>定数名</entry>
<entry>説明</entry>
</row>
</thead>
<tbody>
<row>
<entry>1</entry>
<entry>ICONV_MIME_DECODE_STRICT</entry>
<entry>
指定すると、ヘッダは <link xlink:href="&url.rfc;2047">RFC2047</link>
で定義されている標準に完全準拠する形式でデコードされます。
このオプションはデフォルトでは無効になっています。なぜなら、世の中には
おかしなメールソフトが多く存在し、それらは規格に従わずに間違った
<literal>MIME</literal> ヘッダを生成するからです。
</entry>
</row>
<row>
<entry>2</entry>
<entry>ICONV_MIME_DECODE_CONTINUE_ON_ERROR</entry>
<entry>
指定すると、<function>iconv_mime_decode_headers</function>
は文法的なエラーを無視し、デコード作業を継続します。
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>encoding</parameter></term>
<listitem>
<para>
オプションの <parameter>encoding</parameter> パラメータは、結果の
文字セットを指定します。指定されなかった場合、もしくは &null; の場合は
<link linkend="iconv.configuration">iconv.internal_encoding</link>
が用いられます。
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
成功した場合は連想配列を返します。その中身には
<parameter>headers</parameter> で指定した
<literal>MIME</literal> ヘッダフィールドがすべて含まれています。
デコード中にエラーが発生した場合は &false; を返します。
</para>
<para>
連想配列の個々のキーがフィールド名を表し、対応する要素がフィールドの
値を表します。同じ名前のフィールドが複数存在する場合は、
<function>iconv_mime_decode_headers</function> が自動的に連番つきの
配列をつくり、出現順にその配列に入れられます。
フィールド名は、<emphasis>大文字小文字を区別しない</emphasis> ことに注意して下さい。
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.0.0</entry>
<entry>
<parameter>encoding</parameter> は、nullable になりました。
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>iconv_mime_decode_headers</function> の例</title>
<programlisting role="php">
<![CDATA[
<?php
$headers_string = <<<EOF
Subject: =?UTF-8?B?UHLDvGZ1bmcgUHLDvGZ1bmc=?=
To: example@example.com
Date: Thu, 1 Jan 1970 00:00:00 +0000
Message-Id: <example@example.com>
Received: from localhost (localhost [127.0.0.1]) by localhost
with SMTP id example for <example@example.com>;
Thu, 1 Jan 1970 00:00:00 +0000 (UTC)
(envelope-from example-return-0000-example=example.com@example.com)
Received: (qmail 0 invoked by uid 65534); 1 Thu 2003 00:00:00 +0000
EOF;
$headers = iconv_mime_decode_headers($headers_string, 0, "ISO-8859-1");
print_r($headers);
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Array
(
[Subject] => Pr?ung Pr?ung
[To] => example@example.com
[Date] => Thu, 1 Jan 1970 00:00:00 +0000
[Message-Id] => <example@example.com>
[Received] => Array
(
[0] => from localhost (localhost [127.0.0.1]) by localhost with SMTP id example for <example@example.com>; Thu, 1 Jan 1970 00:00:00 +0000 (UTC) (envelope-from example-return-0000-example=example.com@example.com)
[1] => (qmail 0 invoked by uid 65534); 1 Thu 2003 00:00:00 +0000
)
)
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>iconv_mime_decode</function></member>
<member><function>mb_decode_mimeheader</function></member>
<member><function>imap_mime_header_decode</function></member>
<member><function>imap_base64</function></member>
<member><function>imap_qprint</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
-->