-
Notifications
You must be signed in to change notification settings - Fork 70
/
imap-get-quota.xml
173 lines (165 loc) · 6.34 KB
/
imap-get-quota.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
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 34892f82742329af7e7b4b22be6ad21418fd9768 Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.imap-get-quota" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>imap_get_quota</refname>
<refpurpose>Получает настройку уровня квоты и статистику использования почтовых ящиков</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>array</type><type>false</type></type><methodname>imap_get_quota</methodname>
<methodparam><type>IMAP\Connection</type><parameter>imap</parameter></methodparam>
<methodparam><type>string</type><parameter>quota_root</parameter></methodparam>
</methodsynopsis>
<para>
Возвращает настройку уровня квоты и статистику использования почтовых ящиков.
</para>
<para>
Версия данной функции для обычных пользователей,
не администраторов, для которых в PHP существует функция <function>imap_get_quotaroot</function>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&imap.imap-parameter.imap;
<varlistentry>
<term><parameter>quota_root</parameter></term>
<listitem>
<para>
<parameter>quota_root</parameter> должно соответствовать формату
<literal>user.name</literal>, где name - имя ящика, информация по которому нужна.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Возвращает ассоциативный массив целых чисел с ключами "limit" и "usage".
Число с ключом "limit" определяет максимальный допустимый размер ящика.
Число с ключом "usage" определяет текущий уровень использования.
В случае возникновения ошибки вернёт &false;.
</para>
<para>
Начиная с PHP 4.3 и выше, функция более точно соответствует стандарту,
описанному в <link xlink:href="&url.rfc;2087">RFC2087</link>.
Значение возвращаемого массива изменилось для поддержки неограниченного
количества возвращаемых ресурсов (т.е. сообщений или подпапок), где каждый
именованный ресурс будет представлен индивидуальным массивом. Каждый элемент
массива будет содержать другой массив к ключами "limit" и "usage".
</para>
<para>
Для обеспечения обратной совместимости, оригинальный метод доступа всё ещё
доступен, хотя предполагается это поправить.
</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_get_quota</function></title>
<programlisting role="php">
<![CDATA[
<?php
$mbox = imap_open("{imap.example.org}", "mailadmin", "password", OP_HALFOPEN)
or die("не удалось подключиться: " . imap_last_error());
$quota_value = imap_get_quota($mbox, "user.kalowsky");
if (is_array($quota_value)) {
echo "Уровень использования: " . $quota_value['usage'];
echo "Размер ящика: " . $quota_value['limit'];
}
imap_close($mbox);
?>
]]>
</programlisting>
</example>
</para>
<para>
<example>
<title>Пример использования <function>imap_get_quota</function> в PHP 4.3 и выше</title>
<programlisting role="php">
<![CDATA[
<?php
$mbox = imap_open("{imap.example.org}", "mailadmin", "password", OP_HALFOPEN)
or die("не удалось подключиться: " . imap_last_error());
$quota_values = imap_get_quota($mbox, "user.kalowsky");
if (is_array($quota_values)) {
$storage = $quota_values['STORAGE'];
echo "Уровень использования STORAGE: " . $storage['usage'];
echo "Максимальный размер STORAGE: " . $storage['limit'];
$message = $quota_values['MESSAGE'];
echo "Уровень использования MESSAGE: " . $message['usage'];
echo "Максимальный размер MESSAGE: " . $message['limit'];
/* ... */
}
imap_close($mbox);
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<para>
Эта функция доступна только при использовании библиотеки c-client2000
или новее.
</para>
<para>
Заданный поток <parameter>imap</parameter> должен быть открыт
под административным пользователем.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>imap_open</function></member>
<member><function>imap_set_quota</function></member>
<member><function>imap_get_quotaroot</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
-->