# imap_lsub

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

imap_lsub — List all the subscribed mailboxes

### Descripción

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

Gets an array of all the mailboxes that you have subscribed.

### Parámetros

`imap`

  An IMAP\Connection instance.

`reference`

  `reference` should normally be just the server specification as described in imap_open()

  Advertencia

  El paso de datos no confiables a este parámetro es inseguro, a menos que imap.enable_insecure_rsh esté inhabilitado.

`pattern`

  Especifica donde en la jerarquía del buzón para empezar a buscar.

  Hay dos caracteres especiales que se pueden pasar como parte del `pattern`: '`*`' y '`%`'. '`*`' significa devolver todos los buzones. Si se pasa el `pattern` como '`*`', se obtendrá una lista de toda la jerarquía del buzón. '`%`' significa devolver sólo el nivel actual. '`%`' como el parámetro `pattern` devolverá solamente el nivel superior de los buzones; '`~/mail/%`' en `UW_IMAPD` devolverá cada buzón en el directorio ~/mail, pero no en los subdirectorios de ese directorio.

### Valores devueltos

Returns an array of all the subscribed mailboxes, o `false` en caso de error.

### Historial de cambios

Versión | Descripción
--- | ---
8.1.0 | The `imap` parameter expects an IMAP\Connection instance now; previously, a valid `imap` recurso was expected.

### Ver también

- imap_list() - Read the list of mailboxes
- imap_getmailboxes() - Read the list of mailboxes, returning detailed information on each one