imap_getsubscribed
(PHP 4, PHP 5)
imap_getsubscribed — Liste toutes les bo�tes aux lettres souscrites
Description
Liste toutes les bo�tes aux lettres souscrites.
imap_getsubscribed() est identique � imap_getmailboxes(), mais ne retourne que les bo�tes aux lettres auxquelles l'utilisateur est inscrit.
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).
- 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. Utilis� uniquement avec UW-IMAPD.
- LATT_UNMARKED - Cette bo�te aux lettres n'est pas marqu�e. Utilis� uniquement avec UW-IMAPD.
Suivez l'auteur
