Lit la liste des boîtes aux lettres

# imap_list

(PHP 4, PHP 5, PHP 7)

imap_list — Lit la liste des boîtes aux lettres

### Description

imap_list ( resource `$imap_stream` , string `$ref` , string `$pattern` ) : array

Lit la liste des boîtes aux lettres.

### Liste de paramètres

`imap_stream`

  Un flux IMAP retourné par la fonction imap_open().

`ref`

  `ref` ne devrait être que le serveur sous la forme décrite dans imap_open()

  Avertissement

  Passer des données qui ne sont pas digne de confiance à ce paramètre est dangereux, sauf si, imap.enable_insecure_rsh est désactivé.

`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 contenant les noms des boîtes aux lettres ou `FALSE` si une erreur survient.

### Exemples

Exemple #1 Exemple avec imap_list()

`<?php
$mbox = imap_open("{imap.example.org}", "username", "password", OP_HALFOPEN)
or die("Connexion impossible : " . imap_last_error());
$list = imap_list($mbox, "{imap.example.org}", "*");
if (is_array($list)) {
foreach ($list as $val) {
echo imap_utf7_decode($val) . "\n";
}
} else {
echo "imap_list a échoué : " . imap_last_error() . "\n";
}
imap_close($mbox);
?>`

### Voir aussi

- imap_getmailboxes() - Liste les boîtes aux lettres, et retourne les détails de chacune
- imap_lsub() - Liste toutes les boîtes aux lettres enregistrées