imap_get_quotaroot

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

imap_get_quotaroot — Lit les quotas de chaque utilisateur

Description

array imap_get_quotaroot ( resource $imap_stream , string $quota_root )

Récupère les quotas de chaque utilisateur. La valeur limite représente l'espace limite alloué pour cette utilisateur pour l'utilisation de sa boîte aux lettres. La valeur de l'utilisation représente la taille actuelle de la boîte aux lettres.

Liste de paramètres

imap_stream: Un flux IMAP retourné par la fonction imap_open().
quota_root: quota_root doit être un nom de boîte aux lettres (i.e. INBOX).

Valeurs de retour

Retourne un tableau d'entiers, contenant les quotas de la boîte aux lettres de l'utilisateur. Toutes les valeurs sont représentées par une clé basée sur le nom de la boîte, et par un tableau représentant le niveau d'utilisation et les limites.

Cette fonction retournera FALSE si une erreur est survenue, et un tableau de données si la réponse du serveur n'a pu être comprise.

Exemples

Exemple #1 Exemple avec imap_get_quotaroot()


<?php
$mbox = imap_open("{imap.example.org}", "kalowsky", "password", OP_HALFOPEN)
      or die("Connexion impossible : " . imap_last_error());

$quota = imap_get_quotaroot($mbox, "INBOX");
if (is_array($quota)) {
   $storage = $quota['STORAGE'];
   echo "STORAGE niveau d'utilisation : " .  $storage['usage'];
   echo "STORAGE taille limite : " .  $storage['limit'];

   $message = $quota['MESSAGE'];
   echo "MESSAGE niveau d'utilisation : " .  $message['usage'];
   echo "MESSAGE taille limite : " .  $message['limit'];

   /* ...  */

}

imap_close($mbox);
?>

Notes

Cette fonction est uniquement accessible aux utilisateurs de la bibliothèque c-client2000 ou plus récent.

imap_stream est une ressource de connexion, obtenue grâce à imap_open(). Cette connexion doit être ouverte avec l'identité de l'utilisateur que l'on étudie.

Voir aussi

imap_open() - Ouvre un flux IMAP vers une boîte aux lettres
imap_set_quota() - Modifie le quota d'une boîte aux lettres
imap_get_quota() - Lit les quotas des boîtes aux lettres ainsi que des statistiques sur chacune d'elles

add a note

User Contributed Notes 3 notes

down

thomas dot hebinck at digionline dot de ¶

13 years ago


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

down

uphonesimon at gmail dot com ¶

11 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

rodrigo dot tsuru at tsuru dot net ¶

12 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