-
Notifications
You must be signed in to change notification settings - Fork 79
/
Copy pathimap-fetchstructure.xml
228 lines (226 loc) · 7.51 KB
/
imap-fetchstructure.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
215
216
217
218
219
220
221
222
223
224
225
226
227
228
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 34892f82742329af7e7b4b22be6ad21418fd9768 Maintainer: hirokawa Status: ready -->
<!-- Credits: mumumu -->
<refentry xml:id="function.imap-fetchstructure" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>imap_fetchstructure</refname>
<refpurpose>特定のメッセージの構造を読み込む</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>stdClass</type><type>false</type></type><methodname>imap_fetchstructure</methodname>
<methodparam><type>IMAP\Connection</type><parameter>imap</parameter></methodparam>
<methodparam><type>int</type><parameter>message_num</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
この関数は、指定したメッセージに関するすべての構造化された情報を取り出します。
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&imap.imap-parameter.imap;
<varlistentry>
<term><parameter>message_num</parameter></term>
<listitem>
<para>
メッセージ番号。
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
オプションのパラメータで、<parameter>FT_UID</parameter> のみが指定可能です。
これは、<parameter>message_num</parameter> を <parameter>UID</parameter>
として処理することを関数に指定するためのものです。
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
以下の表に示すプロパティを持つオブジェクトを返します。
&return.falseforfailure;
</para>
<para>
<table>
<title>
<function>imap_fetchstructure</function> が返すオブジェクト
</title>
<tgroup cols="2">
<tbody>
<row>
<entry>type</entry>
<entry>最初の body 部の型</entry>
</row>
<row>
<entry>encoding</entry>
<entry>body 部を転送する際のエンコード法</entry>
</row>
<row>
<entry>ifsubtype</entry>
<entry>subtype 文字列がある場合に &true;</entry>
</row>
<row>
<entry>subtype</entry>
<entry><acronym>MIME</acronym> の subtype</entry>
</row>
<row>
<entry>ifdescription</entry>
<entry>description 文字列がある場合に &true;</entry>
</row>
<row>
<entry>description</entry>
<entry>内容を記述する文字列</entry>
</row>
<row>
<entry>ifid</entry>
<entry>identification 文字列がある場合に &true;</entry>
</row>
<row>
<entry>id</entry>
<entry>Identification 文字列</entry>
</row>
<row>
<entry>lines</entry>
<entry>行数</entry>
</row>
<row>
<entry>bytes</entry>
<entry>バイト数</entry>
</row>
<row>
<entry>ifdisposition</entry>
<entry>disposition 文字列がある場合に &true;</entry>
</row>
<row>
<entry>disposition</entry>
<entry>Disposition 文字列</entry>
</row>
<row>
<entry>ifdparameters</entry>
<entry><varname>dparameters</varname> 配列が存在する場合に &true;</entry>
</row>
<row>
<entry>dparameters</entry>
<entry>オブジェクトの配列。各オブジェクトは <literal>"attribute"</literal>
および <literal>"value"</literal>
というプロパティを保持し、それぞれ
<literal>Content-disposition</literal> <acronym>MIME</acronym> ヘッダの
対応するパラメータを表す。</entry>
</row>
<row>
<entry>ifparameters</entry>
<entry>配列 parameters が存在する場合に &true;</entry>
</row>
<row>
<entry>parameters</entry>
<entry>オブジェクトの配列。各オブジェクトは <literal>"attribute"</literal>
および <literal>"value"</literal>
というプロパティを保持する。</entry>
</row>
<row>
<entry>parts</entry>
<entry>オブジェクトの配列であり、その構造はトップレベルオブジェクトと
同じです。それぞれが <acronym>MIME</acronym> body 部に対応しています。
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
<para>
<table>
<title>最初の body 部の型 (使用するライブラリによって異なるため、定数を使うことを推奨します)</title>
<tgroup cols="3">
<thead>
<row><entry>値</entry><entry>型</entry><entry>定数</entry></row>
</thead>
<tbody>
<row><entry>0</entry><entry>text</entry><entry>TYPETEXT</entry></row>
<row><entry>1</entry><entry>multipart</entry><entry>TYPEMULTIPART</entry></row>
<row><entry>2</entry><entry>message</entry><entry>TYPEMESSAGE</entry></row>
<row><entry>3</entry><entry>application</entry><entry>TYPEAPPLICATION</entry></row>
<row><entry>4</entry><entry>audio</entry><entry>TYPEAUDIO</entry></row>
<row><entry>5</entry><entry>image</entry><entry>TYPEIMAGE</entry></row>
<row><entry>6</entry><entry>video</entry><entry>TYPEVIDEO</entry></row>
<row><entry>7</entry><entry>model</entry><entry>TYPEMODEL</entry></row>
<row><entry>8</entry><entry>other</entry><entry>TYPEOTHER</entry></row>
</tbody>
</tgroup>
</table>
</para>
<para>
<table>
<title>転送時のエンコーディング (使用するライブラリによって異なるため、定数を使うことを推奨します)</title>
<tgroup cols="3">
<thead>
<row><entry>値</entry><entry>型</entry><entry>定数</entry></row>
</thead>
<tbody>
<row><entry>0</entry><entry>7bit</entry><entry>ENC7BIT</entry></row>
<row><entry>1</entry><entry>8bit</entry><entry>ENC8BIT</entry></row>
<row><entry>2</entry><entry>Binary</entry><entry>ENCBINARY</entry></row>
<row><entry>3</entry><entry>Base64</entry><entry>ENCBASE64</entry></row>
<row><entry>4</entry><entry>Quoted-Printable</entry><entry>ENCQUOTEDPRINTABLE</entry></row>
<row><entry>5</entry><entry>other</entry><entry>ENCOTHER</entry></row>
</tbody>
</tgroup>
</table>
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&imap.changelog.imap-param;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>imap_fetchbody</function></member>
<member><function>imap_bodystruct</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
-->