Function.imap-get-quota

Aus PHP-Wiki

imap_get_quota — Liefert Quota-Beschränkungen und Nutzungsstatistik der Postfächer

Beschreibung

array imap_get_quota ( resource $imap_stream , string $quota_root )

imap_get_quoat() ermittelt die aktuellen Quota- Beschränkunten und tatsächlich genutzten Resourcen für Postfächer. Für die Ausführung dieser Funktion ist ein IMAP-Benutzer mit Administrationsrechten erforderlich, eine nichtadminstrative Variante der Funktion ist imap_get_quotaroot().

Parameter-Liste

imap_stream

• Eine von imap_open() zurückgegebene IMAP-Verbindung.

quota_root

• quota_root sollte normalerweise in der Form user.name angegeben werden. name ist dabei der Name des Postfachs für das Informationen geliefert werden sollen.

Rückgabewerte

Liefert ein Array mit zwei Integer-Elementen limit und useage die den insgesamt verfügbaren und den zur Zeit vom Postfach genutzten Speicherplatz angeben. Im Fehlerfall wird FALSE zurückgegeben. Ab PHP 4.3 hält sich die Funktion genauer an die Vorgaben aus [RFC2087]. 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 limit und useage Angaben. Aus Gründen der Rückwärtskompatibilität werden außerdem weiter die beiden ursrünglichen Arrayelemente limit und useage zurückgegeben, ihre weitere Nutzung wird allerdings nicht empfohlen.

Beispiele

Beispiel #1 imap_get_quota() Beispiel

<?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);
?>

Beispiel #2 imap_get_quota() 4.3 und aufwärts Beispiel

<?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);
?>

Anmerkungen

This function is currently only available to users of the c-client2000 or greater library. The given imap_stream must be opened as the mail administrator, other wise this function will fail.

Siehe auch

• imap_open()
• imap_set_quota()
• imap_get_quotaroot()