Lit la liste des boîtes aux lettres

# imap_list

(PHP 4, PHP 5, PHP 7, PHP 8)

imap_list — Lit la liste des boîtes aux lettres

### Description

function imap_list(IMAP\Connection `$imap`, string `$reference`, string `$pattern`): array|false

Lit la liste des boîtes aux lettres.

### Liste de paramètres

`imap`
  Une instance de IMAP\Connection.
`reference`

  `reference` 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.

### Historique

Version | Description
--- | ---
8.1.0 | La paramètre `imap` attend désormais une instance de IMAP\Connection ; auparavant, une resource `imap` était attendue.

### 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

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open