cvs: phpdoc-de /reference/imap/functions imap-get-quota.xml

From: Date: Tue, 13 Mar 2007 12:10:10 +0000
Subject: cvs: phpdoc-de /reference/imap/functions imap-get-quota.xml
Groups: php.doc.de 
Request: Send a blank email to doc-de+get-2064@lists.php.net to get a copy of this message
hholzgra Tue Mar 13 12:10:10 2007 UTC Added files: /phpdoc-de/reference/imap/functions imap-get-quota.xml Log: translations added http://cvs.php.net/viewvc.cgi/phpdoc-de/reference/imap/functions/imap-get-quota.xml?view=markup&rev=1.1 Index: phpdoc-de/reference/imap/functions/imap-get-quota.xml +++ phpdoc-de/reference/imap/functions/imap-get-quota.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- EN-Revision: 1.17 Maintainer: hholzgra Status: ready --> <refentry id="function.imap-get-quota"> <refnamediv> <refname>imap_get_quota</refname> <refpurpose>Liefert Quota-Beschränkungen und Nutzungsstatistik der Postfächer</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> <function>imap_get_quoat</function> ermittelt die aktuellen Quota- Beschränkunten und tatsächlich genutzten Resourcen für Postfächer. </para> <para> Für die Ausführung dieser Funktion ist ein IMAP-Benutzer mit Administrationsrechten erforderlich, eine nichtadminstrative Variante der Funktion ist <function>imap_get_quotaroot</function>. </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> sollte normalerweise in der Form <literal>user.name</litaral> angegeben werden. <literal>name</literal> ist dabei der Name des Postfachs für das Informationen geliefert werden sollen. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Liefert ein Array mit zwei Integer-Elementen <literal>limit</literal> und <literal>useage</literal> die den insgesamt verfügbaren und den zur Zeit vom Postfach genutzten Speicherplatz angeben. Im Fehlerfall wird &false; zurückgegeben. </para> <para> Ab PHP 4.3 hält sich die Funktion genauer an die Vorgaben aus <ulink url="&url.rfc;2087">RFC2087</ulink>. Das Ergebnissarray unterstützt nun eine unbegrenzte Anzahl von Resourcewerten (z.B. Anzahl der Nachrichten oder Unterordner). Für jede Resource wird ein Arrayelement mit dem Namen der Resource als Key angelegt, die einzelnen Arrayelemente sind wiedrum Arrays mit <literal>limit</literal> und <literal>useage</literal> Angaben. </para> <para> Aus Gründen der Rückwärtskompatibilität werden außerdem weiter die beiden ursrünglichen Arrayelemente <literal>limit</literal> und <literal>useage</literal> zurückgegeben, ihre weitere Nutzung wird allerdings nicht empfohlen. </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title><function>imap_get_quota</function> Beispiel</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 und aufwärts Beispiel</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, other wise 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:"../../../../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 -->

« previous php.doc.de (#2064) next »