Files
php-doc-ru/reference/imap/functions/imap-set-quota.xml
2023-12-26 10:20:38 +03:00

133 lines
3.8 KiB
XML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 34892f82742329af7e7b4b22be6ad21418fd9768 Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.imap-set-quota" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>imap_set_quota</refname>
<refpurpose>Устанавливает квоту для заданного почтового ящика</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>imap_set_quota</methodname>
<methodparam><type>IMAP\Connection</type><parameter>imap</parameter></methodparam>
<methodparam><type>string</type><parameter>quota_root</parameter></methodparam>
<methodparam><type>int</type><parameter>mailbox_size</parameter></methodparam>
</methodsynopsis>
<para>
Устанавливает верхний предел квоты для заданного почтового ящика.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&imap.imap-parameter.imap;
<varlistentry>
<term><parameter>quota_root</parameter></term>
<listitem>
<para>
Почтовый ящик, для которого будет установлена квота. Строка
в формате стандарта IMAP: <literal>user.name</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>mailbox_size</parameter></term>
<listitem>
<para>
Максимальный размер (в килобайтах) для <parameter>quota_root</parameter>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</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_set_quota</function></title>
<programlisting role="php">
<![CDATA[
<?php
$mbox = imap_open("{imap.example.org:143}", "mailadmin", "password");
if (!imap_set_quota($mbox, "user.kalowsky", 3000)) {
echo "Ошибка при установке квоты\n";
return;
}
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_get_quota</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
-->