imap_getmailboxes
(PHP 4, PHP 5)
imap_getmailboxes — Liste les bo�tes aux lettres, et retourne les d�tails de chacune
Description
Liste les bo�tes aux lettres.
Liste de param�tres
- imap_stream
-
Un flux IMPA retourn� par la fonction imap_open().
- ref
-
ref ne devrait �tre que le serveur sous la forme d�crite dans imap_open()
- pattern
-
Sp�cifie la position dans la hi�rarchie des bo�tes aux lettres, o� il faut commencer � chercher.
Il y a deux caract�res sp�ciaux que vous pouvez utiliser dans pattern : '*' et '%'. '*' signifie : toutes les bo�tes aux lettres. Si vous passez pattern comme '*', vous obtiendrez la liste compl�te des bo�tes aux lettres de la hi�rarchie. '%' signifie qu'on ne s'int�resse qu'au niveau courant. '%' pass� � pattern ne retournera que les bo�tes aux lettres de niveau sup�rieur; '~/mail/%' sous UW_IMAPD retournera toutes les bo�tes aux lettres du dossier ~/mail directory, mais pas leurs enfants.
Valeurs de retour
Retourne un tableau d'objets contenant les informations sur les bo�tes aux lettres. Chaque objet poss�de un attribut de name , qui contient le nom complet de la bo�te aux lettres, delimiter qui est le d�limiteur hi�rarchique et attributes . attributes est un masque de bits, qui contient :
-
LATT_NOINFERIORS - Cette bo�te aux lettres n'a pas d'"enfants" (il n'y a plus de bo�tes aux lettres en dessous de celle-ci) et ne peut en contenir aucun. Un appel � la fonction imap_createmailbox() ne fonctionnera pas sur cette bo�te.
-
LATT_NOSELECT - Ceci est juste un container, pas une bo�te aux lettres (vous ne pouvez pas l'ouvrir).
-
LATT_MARKED - Cette bo�te aux lettres est marqu�e. Ceci signifie qu'elle peut contenir des nouveaux messages depuis la derni�re fois qu'elle a �t� v�rifi�e. Ce marqueur n'est pas fourni avec tous les serveurs IMPA.
-
LATT_UNMARKED - Cette bo�te aux lettres n'est pas marqu�e et ne contient pas de nouveaux messages. Si MARKED ou UNMARKED est fourni, vous pouvez supposer que le serveur IMAP supporte cette fonctionnalit� pour cette bo�te aux lettres.
Exemples
Exemple #1 Exemple avec imap_getmailboxes()
<?php
$mbox = imap_open("{imap.example.org}", "username", "password", OP_HALFOPEN)
or die("Connexion impossible : " . imap_last_error());
$list = imap_getmailboxes($mbox, "{imap.example.org}", "*");
if (is_array($list)) {
foreach ($list as $key => $val) {
echo "($key) ";
echo imap_utf7_decode($val->name) . ",";
echo "'" . $val->delimiter . "',";
echo $val->attributes . "<br />\n";
}
} else {
echo "imap_getmailboxes a �chou� : " . imap_last_error() . "\n";
}
imap_close($mbox);
?>
Suivez l'auteur
