-
Notifications
You must be signed in to change notification settings - Fork 70
/
imap-status.xml
166 lines (162 loc) · 5.7 KB
/
imap-status.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
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 34892f82742329af7e7b4b22be6ad21418fd9768 Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.imap-status" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>imap_status</refname>
<refpurpose>Получает информацию по статусу почтового ящика</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>stdClass</type><type>false</type></type><methodname>imap_status</methodname>
<methodparam><type>IMAP\Connection</type><parameter>imap</parameter></methodparam>
<methodparam><type>string</type><parameter>mailbox</parameter></methodparam>
<methodparam><type>int</type><parameter>flags</parameter></methodparam>
</methodsynopsis>
<para>
Возвращает информацию по статусу заданного в параметре <parameter>mailbox</parameter> ящика.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&imap.imap-parameter.imap;
<varlistentry>
<term><parameter>mailbox</parameter></term>
<listitem>
<para>
Имя почтового ящика, более подробно смотрите в описании
<function>imap_open</function>
</para>
&imap.mailboxname.insecure;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
Допустимые опции:
<itemizedlist>
<listitem>
<simpara>
<constant>SA_MESSAGES</constant> - установить
<varname>$status->messages</varname>, равным количеству писем в ящике
</simpara>
</listitem>
<listitem>
<simpara>
<constant>SA_RECENT</constant> - установить
<varname>$status->recent</varname>, равным количеству новых писем
</simpara>
</listitem>
<listitem>
<simpara>
<constant>SA_UNSEEN</constant> - установить
<varname>$status->unseen</varname>, равным количеству непрочитанных писем
</simpara>
</listitem>
<listitem>
<simpara>
<constant>SA_UIDNEXT</constant> - установить
<varname>$status->uidnext</varname> равным следующему uid, который будет
использован в ящике
</simpara>
</listitem>
<listitem>
<simpara>
<constant>SA_UIDVALIDITY</constant> - установить
<varname>$status->uidvalidity</varname> в значение константы, которая меняется,
когда UID для почтового ящика больше не могут быть действительным
</simpara>
</listitem>
<listitem>
<simpara>
<constant>SA_ALL</constant> - использовать все перечисленные опции
</simpara>
</listitem>
</itemizedlist>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Функция возвращает объект, содержащий информацию по статусу&return.falseforfailure;.
Объект имеет следующие свойства: <literal>messages</literal>,
<literal>recent</literal>, <literal>unseen</literal>,
<literal>uidnext</literal> и <literal>uidvalidity</literal>.
</para>
<para>
<literal>flags</literal> также установлен, он содержит битовую маску которая может
быть проверена с помощью перечисленных выше констант.
</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_status</function></title>
<programlisting role="php">
<![CDATA[
<?php
$mbox = imap_open("{imap.example.com}", "username", "password", OP_HALFOPEN)
or die("не удалось подключиться: " . imap_last_error());
$status = imap_status($mbox, "{imap.example.org}INBOX", SA_ALL);
if ($status) {
echo "Сообщения: " . $status->messages . "<br />\n";
echo "Последние: " . $status->recent . "<br />\n";
echo "Непросмотренные: " . $status->unseen . "<br />\n";
echo "UIDnext: " . $status->uidnext . "<br />\n";
echo "UIDvalidity:" . $status->uidvalidity . "<br />\n";
} else {
echo "imap_status failed: " . imap_last_error() . "\n";
}
imap_close($mbox);
?>
]]>
</programlisting>
</example>
</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
-->