imap_getmailboxes

(PHP 4, PHP 5)

imap_getmailboxes — Liste les boîtes aux lettres, et retourne les détails de chacune

Description

array imap_getmailboxes ( resource $imap_stream, string $ref, string $pattern )

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'interesse 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 :

Exemples

Exemple 1203. 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 );
?>

Voir aussi

imap_getsubscribed()