imap-get-quotaroot.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 34892f82742329af7e7b4b22be6ad21418fd9768 Maintainer: hholzgra Status: ready -->
<!-- Reviewed: yes -->
<!-- Rev-Revision: 34892f82742329af7e7b4b22be6ad21418fd9768 Reviewer: samesch -->
<refentry xml:id="function.imap-get-quotaroot" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>imap_get_quotaroot</refname>
  <refpurpose>Liefert die Quota-Einstellungen für ein Benutzerpostfach</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>array</type><type>false</type></type><methodname>imap_get_quotaroot</methodname>
   <methodparam><type>IMAP\Connection</type><parameter>imap</parameter></methodparam>
   <methodparam><type>string</type><parameter>mailbox</parameter></methodparam>
  </methodsynopsis>
  <para>
   Gibt die Quota-Einstellungen für den aktuellen Benutzer zurück. Die
   ermittelten Quota-Einstellungen gelten über alle Postfächer des Benutzers,
   der Nutzungswert für die aktuell im angegebenen Postfach genutzte
   Kapazität.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &imap.imap-parameter.imap;
    <varlistentry>
     <term><parameter>mailbox</parameter></term>
     <listitem>
      <para>
       Der Name des zu untersuchenden Postfachs, &zb; INBOX.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Gibt ein Array zurück mit Ressourcennamen als Index und Arrays mit den
   Elementen limit und usage als Werte, die das aktuelle Limit sowie die
   tatsächliche Nutzung der jeweiligen Ressource für das angegebene Postfach
   angeben.
  </para>
  <para>
   Die Funktion gibt &false; zurück, wenn Fehler auftreten, und ein Array mit
   Verbindungsinformationen, falls die Antwort des Servers nicht verarbeitet
   werden konnte.
  </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_quotaroot</function>-Beispiel</title>
    <programlisting role="php">
<![CDATA[
<?php
$mbox = imap_open("{imap.example.org}", "kalowsky", "password", OP_HALFOPEN)
      or die("Kann keine Verbindung aufbauen: " . imap_last_error());

$quota = imap_get_quotaroot($mbox, "INBOX");
if (is_array($quota)) {
   $storage = $quota['STORAGE'];
   echo "Speicherplatz (aktuell genutzt): " .  $storage['usage'];
   echo "Speicherplatz (Limit): " .  $storage['limit'];

   $message = $quota['MESSAGE'];
   echo "Anzahl Nachrichten (aktuell): " .  $message['usage'];
   echo "Anzahl Nachrichten (Limit): " .  $message['limit'];

   /* ...  */

}

imap_close($mbox);
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <para>
   Diese Funktion ist aktuell erst ab der Bibliotheksversion c-client2000
   verfügbar.
  </para>
  <para>
   Das zu prüfende Postfach muss dem Benutzer gehören, für den
   <parameter>imap</parameter> geöffnet wurde.
  </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_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
-->