Lee la lista de buzones de correo

# imap_list

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

imap_list — Lee la lista de buzones de correo

### Descripción

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

Lee la lista de buzones de correo.

### Parámetros

`imap`
  Una instancia de IMAP\Connection.
`reference`

  `reference` debería ser solo el servidor en la forma descrita en imap_open()

  Advertencia

  Pasar datos no confiables a este parámetro es inseguro, a menos que imap.enable_insecure_rsh esté desactivado.

`pattern`
  Especifica en qué parte de la jerarquía del buzón comenzar la búsqueda.Hay dos caracteres especiales que se pueden pasar como parte del `pattern`: '`*`' y '`%`'. '`*`' significa devolver todos los buzones. Si se pasa `pattern` como '`*`', se obtendrá una lista de toda la jerarquía del buzón. '`%`' significa devolver solo el nivel actual. '`%`' como parámetro `pattern` devolverá solo los buzones de nivel superior; '`~/mail/%`' en `UW_IMAPD` devolverá cada buzón en el directorio ~/mail, pero ninguno en las subcarpetas de ese directorio.

### Valores devueltos

Devuelve un array que contiene los nombres de los buzones de correo, o `false` si ocurre un error.

### Historial de cambios

Versión | Descripción
--- | ---
8.1.0 | El parámetro `imap` ahora espera una instancia de IMAP\Connection; anteriormente, se esperaba un resource `imap` válido.

### Ejemplos

Ejemplo #1 Ejemplo con imap_list()

    <?php
    $mbox = imap_open("{imap.example.org}", "username", "password", OP_HALFOPEN)
          or die("Conexión imposible: " . 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 ha fallado: " . imap_last_error() . "\n";
    }

    imap_close($mbox);
    ?>

### Ver también

- imap_getmailboxes() - Lista los buzones de correo y devuelve los detalles de cada uno
- imap_lsub() - Lista todas las carpetas de correo registradas

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