# imap_list

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

imap_list — Read the list of mailboxes

### Descripción

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

Read the list of mailboxes.

### 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 containing the names of the mailboxes or `false` in case of failure.

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

### Ejemplos

Ejemplo #1 imap_list() example

`<?php
$mbox = imap_open("{imap.example.org}", "username", "password", OP_HALFOPEN)
or die("can't connect: " . 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 failed: " . imap_last_error() . "\n";
}
imap_close($mbox);
?>`

### Ver también

- imap_getmailboxes() - Read the list of mailboxes, returning detailed information on each one
- imap_lsub() - List all the subscribed mailboxes