imap_get_quota
(PHP 4 >= 4.0.5, PHP 5)
imap_get_quota — Lit les quotas des bo�tes aux lettres ainsi que des statistiques sur chacune d'elles
Description
Lit les quotas des bo�tes aux lettres ainsi que des statistiques sur chacune d'elles.
Pour une version utilisateur, non administrateur, de cette fonction, reportez-vous � la fonction imap_get_quotaroot().
Liste de param�tres
- imap_stream
-
Un flux IMPA retourn� par la fonction imap_open().
- quota_root
-
quota_root doit �tre de la forme : "user.nom", o� "nom" est le nom de la bo�te aux lettres que vous souhaitez analyser.
Valeurs de retour
Retourne un tableau contenant les valeurs de quota et courante de la bo�te aux lettres quota_root . Le quota repr�sente la taille maximale de votre bo�te aux lettres. La valeur courante est l'espace actuellement utilis� par votre bo�te aux lettres. imap_get_quota() retournera FALSE en cas d'�chec.
Depuis PHP 4.3, la fonction refl�te plus fid�lement les fonctionnalit�s �dict�e par la » RFC2087. Le tableau retourn� a chang� pour supporter un nombre illimit� de ressources retourn�es (i.e. messages ou sous-dossiers) avec chaque ressource nomm�e qui est identifi�e par une cl�. Chaque cl� contient alors un autre tableau avec l'utilisation et le quota. L'exemple ci-dessous montre comment l'utiliser.
Pour des raisons de compatibilit�, la m�thode d'acc�s originale est toujours disponible, mais il est recommand� de l'abandonner.
Exemples
Exemple #1 Exemple avec imap_get_quota()
<?php
$mbox = imap_open("{imap.example.org}", "mailadmin", "password", OP_HALFOPEN)
or die("Impossible de se connecter : " . imap_last_error());
$quota_value = imap_get_quota($mbox, "user.kalowsky");
if (is_array($quota_value)) {
echo "Niveau d'utilisation : " . $quota_value['usage'];
echo "Quota : " . $quota_value['limit'];
}
imap_close($mbox);
?>
Exemple #2 Exemple avec imap_get_quota() 4.3 ou sup�rieur
<?php
$mbox = imap_open("{imap.example.org}", "mailadmin", "password", OP_HALFOPEN)
or die("Impossible de se connecter : " . imap_last_error());
$quota_values = imap_get_quota($mbox, "user.kalowsky");
if (is_array($quota_values)) {
$storage = $quota_values['STORAGE'];
echo "Utilisation actuelle de la capacit� de stockage : " . $storage['usage'];
echo "Quota actuel de stockage : " . $storage['limit'];
$message = $quota_values['MESSAGE'];
echo "Niveau d'utilisation de MESSAGE : " . $message['usage'];
echo "Quota de MESSAGE : " . $message['limit'];
/* ... */
}
imap_close($mbox);
?>
Notes
imap_get_quota() ne fonctionne actuellement qu'avec les biblioth�ques c-client2000.
imap_stream doit avoir �t� cr�� avec la fonction imap_open(). Ce flux est n�cessairement ouvert en tant qu'administrateur du serveur, pour que les droits n�cessaires lui soient allou�s.
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_quotaroot() - Lit les quotas de chaque utilisateur