imap-set-quota.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 34892f82742329af7e7b4b22be6ad21418fd9768 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.imap-set-quota" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>imap_set_quota</refname>
  <refpurpose>Modifie le quota d'une boîte aux lettres</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>
   Modifie le quota de la boîte aux lettres <parameter>quota_root</parameter>.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &imap.imap-parameter.imap;
    <varlistentry>
     <term><parameter>quota_root</parameter></term>
     <listitem>
      <para>
       La boîte aux lettres dont on doit modifier le quota. Elle doit suivre
       le format standard IMAP pour une boîte aux lettres :
       <literal>user.name</literal>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>mailbox_size</parameter></term>
     <listitem>
      <para>
       La taille maximale (en Ko) pour la boîte <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>Exemple avec <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 "Échec lors de la définition du quota\n";
    return;
}

imap_close($mbox);
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>
 <refsect1 role="notes">
  &reftitle.notes;
  <para>
   <function>imap_get_quota</function> ne fonctionne actuellement qu'avec
   les bibliothèques c-client2000.
  </para>
  <para>
   <function>imap_set_quota</function>
   requiert que <parameter>imap</parameter> ait été
   ouvert avec un compte d'administrateur, pour avoir les droits
   nécessaires : elle ne fonctionnera avec aucun autre
   utilisateur.
  </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
-->