php-doc-en/reference/imap/functions/imap-get-quota.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ -->
<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>Retrieve the quota level settings, and usage statics per mailbox</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>imap_get_quota</methodname>
   <methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam>
   <methodparam><type>string</type><parameter>quota_root</parameter></methodparam>
  </methodsynopsis>
  <para>
   Retrieve the quota level settings, and usage statics per mailbox.
  </para>
  <para>
   For a non-admin user version of this function,
   please see the <function>imap_get_quotaroot</function> function of PHP.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &imap.imap-stream.description;
    <varlistentry>
     <term><parameter>quota_root</parameter></term>
     <listitem>
      <para>
       <parameter>quota_root</parameter> should normally be in the form of
       <literal>user.name</literal> where name is the mailbox you wish to
       retrieve information about.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns an array with integer values limit and usage for the given
   mailbox.  The value of limit represents the total amount of space
   allowed for this mailbox.  The usage value represents the mailboxes
   current level of capacity.  Will return &false; in the case of failure.
  </para>
  <para>
   As of PHP 4.3, the function more properly reflects the
   functionality as dictated by the <link xlink:href="&url.rfc;2087">RFC2087</link>.
   The array return value has changed to support an unlimited number of returned 
   resources (i.e.  messages, or sub-folders) with each named resource receiving
   an individual array key.  Each key value then contains an another array with
   the usage and limit values within it.
  </para>
  <para>
   For backwards compatibility reasons, the original access methods are
   still available for use, although it is suggested to update.
  </para>
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>imap_get_quota</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
$mbox = imap_open("{imap.example.org}", "mailadmin", "password", OP_HALFOPEN)
      or die("can't connect: " . imap_last_error());

$quota_value = imap_get_quota($mbox, "user.kalowsky");
if (is_array($quota_value)) {
    echo "Usage level is: " . $quota_value['usage'];
    echo "Limit level is: " . $quota_value['limit'];
}

imap_close($mbox);
?>
]]>
    </programlisting>
   </example>
  </para>
  <para>
   <example>
    <title><function>imap_get_quota</function> 4.3 or greater example</title>
    <programlisting role="php">
<![CDATA[
<?php
$mbox = imap_open("{imap.example.org}", "mailadmin", "password", OP_HALFOPEN)
      or die("can't connect: " . imap_last_error());

$quota_values = imap_get_quota($mbox, "user.kalowsky");
if (is_array($quota_values)) {
   $storage = $quota_values['STORAGE'];
   echo "STORAGE usage level is: " .  $storage['usage'];
   echo "STORAGE limit level is: " .  $storage['limit'];

   $message = $quota_values['MESSAGE'];
   echo "MESSAGE usage level is: " .  $message['usage'];
   echo "MESSAGE limit is: " .  $message['limit'];

   /* ...  */
}

imap_close($mbox);
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>
 <refsect1 role="notes">
  &reftitle.notes;
  <para>
   This function is currently only available to users of the c-client2000
   or greater library.
  </para>
  <para>
   The given <parameter>imap_stream</parameter> must be opened as the mail
   administrator, otherwise this function will fail.
  </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
-->