mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-26 13:58:55 +00:00
2d23ddfe59
- Move alised documented to their real function name and document what an alias is. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@99005 c90b9560-bf6c-de11-be94-00142212c4b1
81 lines
2.6 KiB
XML
81 lines
2.6 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.4 $ -->
|
|
<!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 -->
|
|
<refentry id="function.imap-set-quota">
|
|
<refnamediv>
|
|
<refname>imap_set_quota</refname>
|
|
<refpurpose>Sets a quota for a given mailbox</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>imap_set_quota</methodname>
|
|
<methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>quota_root</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>quota_limit</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Sets an upper limit quota on a per mailbox basis. This function
|
|
requires the <parameter>imap_stream</parameter> to have been opened
|
|
as the mail administrator account. It will not work if opened as
|
|
any other user.
|
|
</para>
|
|
<para>
|
|
This function is currently only available to users of the c-client2000
|
|
or greater library.
|
|
</para>
|
|
<para>
|
|
<parameter>imap_stream</parameter> is the stream pointer returned from
|
|
a <function>imap_open</function> call. This stream must be opened as
|
|
the mail administrator, other wise this function will fail.
|
|
<parameter>quota_root</parameter> is the mailbox to have a quota set. This
|
|
should follow the IMAP standard format for a mailbox, 'user.name'.
|
|
<parameter>quota_limit</parameter> is the maximum size (in KB) for
|
|
the <parameter>quota_root</parameter>.
|
|
</para>
|
|
<para>
|
|
Returns &true; on success and &false; on error.
|
|
</para>
|
|
<para>
|
|
<example>
|
|
<title><function>imap_set_quota</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
$mbox = imap_open ("{your.imap.host:143}", "mailadmin", "password");
|
|
|
|
if(!imap_set_quota($mbox, "user.kalowsky", 3000)) {
|
|
print "Error in setting quota\n";
|
|
return;
|
|
}
|
|
|
|
imap_close($mbox);
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
<para>
|
|
See also <function>imap_open</function>, <function>imap_set_quota</function>.
|
|
</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:"../../../../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
|
|
-->
|