# imap_lsub

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

imap_lsub — Liste toutes les boîtes aux lettres enregistrées

### Description

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

Récupère un tableau contenant toutes les boîtes aux lettres auxquelles vous avez souscrit.

### 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 toutes les boîtes aux lettres souscrites, 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.

### Voir aussi

- imap_list() - Lit la liste des boîtes aux lettres
- imap_getmailboxes() - Liste les boîtes aux lettres, et retourne les détails de chacune