imap_get_quotaroot

(PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8)

imap_get_quotaroot — Liefert die Quota-Einstellungen für ein Benutzerpostfach

Beschreibung

imap_get_quotaroot(IMAP\Connection $imap, string $mailbox): array|false

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.

Parameter-Liste

imap: Eine IMAP\Connection-Instanz.
mailbox: Der Name des zu untersuchenden Postfachs, z. B. INBOX.

Rückgabewerte

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.

Die Funktion gibt false zurück, wenn Fehler auftreten, und ein Array mit Verbindungsinformationen, falls die Antwort des Servers nicht verarbeitet werden konnte.

Changelog

Version	Beschreibung
8.1.0	Der Parameter `imap` erwartet nun eine IMAP\Connection-Instanz; vorher wurde eine gültige `imap`-Ressource erwartet.

Beispiele

Beispiel #1 imap_get_quotaroot()-Beispiel

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

Anmerkungen

Diese Funktion ist aktuell erst ab der Bibliotheksversion c-client2000 verfügbar.

Das zu prüfende Postfach muss dem Benutzer gehören, für den imap geöffnet wurde.

Siehe auch

imap_open() - Öffnet einen IMAP-Stream zu einem Postfach
imap_set_quota() - Legt die Größenbeschränkung für ein Postfach fest
imap_get_quota() - Liefert Quota-Einstellungen und Nutzungsstatistik der Postfächer

＋add a note

User Contributed Notes 3 notes

down

thomas dot hebinck at digionline dot de ¶

20 years ago

['STORAGE']['usage'] and ['STORAGE']['limit'] are values in KB (1024 Bytes)

down

uphonesimon at gmail dot com ¶

18 years ago

just to make a note for all the people that are wondering the differences between $quota['STORAGE'] and $quot['MESSAGE']
the $quot['STORAGE'] is the size of the mailbox in KB
but $quota['MESSAGE'] is actually the number of messages stored in the mailbox and the up limit of the total messages allowed

down

-4

rodrigo dot tsuru at tsuru dot net ¶

19 years ago

The example above isn't right. Replace with this:



<?php

$mbox = imap_open("{your.imap.host}", "kalowsky", "password", OP_HALFOPEN)

     or die("can't connect: " . imap_last_error());

 

$quota = imap_get_quotaroot($mbox, "INBOX");

if (is_array($quota)) {

   $storage = $quota['STORAGE'];

   echo "STORAGE usage level is: " .  $storage['usage'];

   echo "STORAGE limit level is: " .  $storage['limit'];



   $message = $quota['MESSAGE']; 

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

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



   /* ...  */ 



} 

 

imap_close($mbox); 

?>

＋add a note