-
Notifications
You must be signed in to change notification settings - Fork 70
/
imap-search.xml
299 lines (294 loc) · 9.57 KB
/
imap-search.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
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 34892f82742329af7e7b4b22be6ad21418fd9768 Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.imap-search" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>imap_search</refname>
<refpurpose>Получает сообщения, удовлетворяющие заданным критериям</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>array</type><type>false</type></type><methodname>imap_search</methodname>
<methodparam><type>IMAP\Connection</type><parameter>imap</parameter></methodparam>
<methodparam><type>string</type><parameter>criteria</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer><constant>SE_FREE</constant></initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>charset</parameter><initializer>""</initializer></methodparam>
</methodsynopsis>
<para>
Эта функция производит поиск в текущем почтовом ящике
открытом в потоке <acronym>IMAP</acronym>.
</para>
<para>
К примеру, чтобы найти все неотвеченные сообщения посланные
от мамы (Mom), нужно будет использовать "UNANSWERED FROM mom".
Поиск регистронезависимый. Приведённый список критериев извлечён
из исходных кодов UW c-client и может быть неполным или не совсем
точным (дополнительно смотрите <link xlink:href="&url.rfc;1176">RFC1176</link>,
секция "tag SEARCH search_criteria").
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&imap.imap-parameter.imap;
<varlistentry>
<term><parameter>criteria</parameter></term>
<listitem>
<para>
Строка, разделённая пробелами, в которой допустимо использовать следующие
ключевые слова. Любые аргументы, состоящие из нескольких слов, должны
быть заключены в двойные кавычки (например
<literal>FROM "joey smith"</literal>). Результат будет совпадать со всеми
заданными в параметре <parameter>criteria</parameter> критериями.
<itemizedlist>
<listitem>
<simpara>
ALL - возвращать все сообщения, соответствующие остальным критериям
</simpara>
</listitem>
<listitem>
<simpara>
ANSWERED - сообщения с выставленным флагом \\ANSWERED
</simpara>
</listitem>
<listitem>
<simpara>
BCC "string" - сообщения в поле Bcc: которых присутствует "string"
</simpara>
</listitem>
<listitem>
<simpara>
BEFORE "date" - сообщения с Date: до "date"
</simpara>
</listitem>
<listitem>
<simpara>
BODY "string" - сообщения содержащие "string" в теле
</simpara>
</listitem>
<listitem>
<simpara>
CC "string" - сообщения в поле Cc: которых присутствует "string"
</simpara>
</listitem>
<listitem>
<simpara>
DELETED - удалённые сообщения
</simpara>
</listitem>
<listitem>
<simpara>
FLAGGED - сообщения с установленным флагом \\FLAGGED (иногда называют
"Срочное" или "Важное")
</simpara>
</listitem>
<listitem>
<simpara>
FROM "string" - сообщения в поле From: которых присутствует "string"
</simpara>
</listitem>
<listitem>
<simpara>
KEYWORD "string" - сообщения с ключевым словом "string"
</simpara>
</listitem>
<listitem>
<simpara>
NEW - новые сообщения
</simpara>
</listitem>
<listitem>
<simpara>
OLD - старые сообщения
</simpara>
</listitem>
<listitem>
<simpara>
ON "date" - сообщения с Date: равным "date"
</simpara>
</listitem>
<listitem>
<simpara>
RECENT - означает сообщения с выставленным флагом \\RECENT
</simpara>
</listitem>
<listitem>
<simpara>
SEEN - прочтённые сообщения (установлен флаг \\SEEN)
</simpara>
</listitem>
<listitem>
<simpara>
SINCE "date" - сообщения с Date: после "date"
</simpara>
</listitem>
<listitem>
<simpara>
SUBJECT "string" - сообщения в поле Subject: которых присутствует "string"
</simpara>
</listitem>
<listitem>
<simpara>
TEXT "string" - сообщения с текстом "string"
</simpara>
</listitem>
<listitem>
<simpara>
TO "string" - сообщения в поле To: которых присутствует "string"
</simpara>
</listitem>
<listitem>
<simpara>
UNANSWERED - неотвеченные сообщения
</simpara>
</listitem>
<listitem>
<simpara>
UNDELETED - не удалённые сообщения
</simpara>
</listitem>
<listitem>
<simpara>
UNFLAGGED - сообщения без установленных флагов
</simpara>
</listitem>
<listitem>
<simpara>
UNKEYWORD "string" - сообщения, не имеющие ключевого слова "string"
</simpara>
</listitem>
<listitem>
<simpara>
UNSEEN - непрочитанные сообщения
</simpara>
</listitem>
</itemizedlist>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
Корректные значения <parameter>flags</parameter> - это
<constant>SE_UID</constant>, что приведёт к тому, что в возвращённом
массиве вместо номеров сообщений будут содержаться их UID.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>charset</parameter></term>
<listitem>
<para>
Кодировка MIME, в которой будет происходить поиск.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Возвращает номера сообщений или их UID.
</para>
<para>
Возвращает &false;, если сообщения не найдены, либо критерии указанные
в <parameter>criteria</parameter> некорректны.
</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;
<example xml:id="imap-search.examples">
<title>Пример использования <function>imap_search</function></title>
<programlisting role="php">
<![CDATA[
<?php
$imap = imap_open('{imap.example.com:993/imap/ssl}INBOX', 'foo@example.com', 'pass123', OP_READONLY);
$some = imap_search($imap, 'SUBJECT "HOWTO be Awesome" SINCE "8 August 2008"', SE_UID);
$msgnos = imap_search($imap, 'ALL');
$uids = imap_search($imap, 'ALL', SE_UID);
print_r($some);
print_r($msgnos);
print_r($uids);
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
Array
(
[0] => 4
[1] => 6
[2] => 11
)
Array
(
[0] => 1
[1] => 2
[2] => 3
[3] => 4
[4] => 5
[5] => 6
)
Array
(
[0] => 1
[1] => 4
[2] => 6
[3] => 8
[4] => 11
[5] => 12
)
]]>
</screen>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>imap_listscan</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
-->