PHP Unconference Europe 2015

imap_get_quotaroot

(PHP 4 >= 4.3.0, PHP 5)

imap_get_quotarootLiefert die Quota-Beschränkungen für ein Benutzerpostfach

Beschreibung

array imap_get_quotaroot ( resource $imap_stream , string $quota_root )

Liefert die Quota-Beschränkungen für den aktuellen Benutzer. Die ermittelten Quota-Beschränkungen gelten über alle Postfächer des Benutzers, die Ausnutungswerte der im angegebenen Postfach genutzten Kapazität.

Parameter-Liste

imap_stream

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

quota_root

Name des zu untersuchenden Postfachs, z.B. INBOX.

Rückgabewerte

Liefert ein Array mit Ressourcenamen als Index und Arrays mit den Elementen limit und usage als Werten 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.

Beispiele

Beispiel #1 imap_get_quotaroot()-Beispiel

<?php
$mbox 
imap_open("{imap.example.org}""kalowsky""password"OP_HALFOPEN)
      or die(
"can't connect: " imap_last_error());

$quota imap_get_quotaroot($mbox"INBOX");
if (
is_array($quota)) {
   
$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 level is: " .  $message['limit'];

   
/* ...  */

}

imap_close($mbox);
?>

Anmerkungen

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

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

Siehe auch

  • imap_open() - Öffnet eine Verbindung zu einem Mailserver-Postfach
  • imap_set_quota() - Setzt die Mengenbeschrenkung für ein Postfach
  • imap_get_quota() - Liefert Quota-Beschränkungen und Nutzungsstatistik der Postfächer

add a note add a note

User Contributed Notes 3 notes

up
2
thomas dot hebinck at digionline dot de
11 years ago
['STORAGE']['usage'] and ['STORAGE']['limit'] are values in KB (1024 Bytes)
up
1
uphonesimon at gmail dot com
9 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
up
0
rodrigo dot tsuru at tsuru dot net
10 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);
?>
To Top