-
Notifications
You must be signed in to change notification settings - Fork 70
/
imap-fetch-overview.xml
220 lines (216 loc) · 6.94 KB
/
imap-fetch-overview.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
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 34892f82742329af7e7b4b22be6ad21418fd9768 Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.imap-fetch-overview" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>imap_fetch_overview</refname>
<refpurpose>Обозревает информацию из заголовков сообщений</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>array</type><type>false</type></type><methodname>imap_fetch_overview</methodname>
<methodparam><type>IMAP\Connection</type><parameter>imap</parameter></methodparam>
<methodparam><type>string</type><parameter>sequence</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
Эта функция читает заголовки сообщений, заданных в
параметре <parameter>sequence</parameter>, и возвращает обзорную информацию
об их содержании.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&imap.imap-parameter.imap;
<varlistentry>
<term><parameter>sequence</parameter></term>
<listitem>
<para>
Последовательность номеров сообщений.Вы можете перечислить несколько
сообщений, используя как разделитель запятую (<literal>X,Y</literal>), или
задать интервал сообщений с помощью двоеточия <literal>X:Y</literal>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
Параметр <parameter>sequence</parameter> должен содержать номера сообщений.
Если вы хотите задать в нем их UID, то этот параметр необходимо
задать значением <constant>FT_UID</constant>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Возвращает массив объектов, каждый из которых описывает заголовок одного сообщения.
Объекты содержат соответствующие свойства только если они присутствуют.
Возможные свойства:
<itemizedlist>
<listitem>
<simpara>
<literal>subject</literal> - тема письма
</simpara>
</listitem>
<listitem>
<simpara>
<literal>from</literal> - кто его послал
</simpara>
</listitem>
<listitem>
<simpara>
<literal>to</literal> - получатель
</simpara>
</listitem>
<listitem>
<simpara>
<literal>date</literal> - когда оно было послано
</simpara>
</listitem>
<listitem>
<simpara>
<literal>message_id</literal> - Идентификатор сообщения
</simpara>
</listitem>
<listitem>
<simpara>
<literal>references</literal> - является ссылкой на этот идентификатор сообщения
</simpara>
</listitem>
<listitem>
<simpara>
<literal>in_reply_to</literal> - является ответом на письмо с этим идентификатором
</simpara>
</listitem>
<listitem>
<simpara>
<literal>size</literal> - размер в байтах
</simpara>
</listitem>
<listitem>
<simpara>
<literal>uid</literal> - UID сообщения в ящике
</simpara>
</listitem>
<listitem>
<simpara>
<literal>msgno</literal> - номер сообщения в ящике
</simpara>
</listitem>
<listitem>
<simpara>
<literal>recent</literal> - письмо помечено как новое
</simpara>
</listitem>
<listitem>
<simpara>
<literal>flagged</literal> - это сообщение помечено (обычно является признаком
"важности")
</simpara>
</listitem>
<listitem>
<simpara>
<literal>answered</literal> - сообщение помечено как отвеченное
</simpara>
</listitem>
<listitem>
<simpara>
<literal>deleted</literal> - помечено для удаления
</simpara>
</listitem>
<listitem>
<simpara>
<literal>seen</literal> - помечено как прочитанное
</simpara>
</listitem>
<listitem>
<simpara>
<literal>draft</literal> - помечено как черновик
</simpara>
</listitem>
<listitem>
<simpara>
<literal>udate</literal> - временная метка UNIX даты получения
</simpara>
</listitem>
</itemizedlist>
Функция возвращает &false; в случае возникновения ошибки.
</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="examples">
&reftitle.examples;
<para>
<example>
<title>Пример использования <function>imap_fetch_overview</function></title>
<programlisting role="php">
<![CDATA[
<?php
$mbox = imap_open("{imap.example.org:143}INBOX", "username", "password")
or die("не удалось подключиться: " . imap_last_error());
$MC = imap_check($mbox);
// Получим обзор всех писем в INBOX
$result = imap_fetch_overview($mbox,"1:{$MC->Nmsgs}",0);
foreach ($result as $overview) {
echo "#{$overview->msgno} ({$overview->date}) - From: {$overview->from}
{$overview->subject}\n";
}
imap_close($mbox);
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>imap_fetchheader</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
-->