imap_getmailboxes

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

    imap_getmailboxes — Read the list of mailboxes, returning detailed information on each one

    Descripción

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

    Gets information on the 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 of objects containing mailbox information. Each object has the attributes name, specifying the full name of the mailbox; delimiter, which is the hierarchy delimiter for the part of the hierarchy this mailbox is in; and attributes. Attributes is a bitmask that can be tested against:

    • LATT_NOINFERIORS - This mailbox not contains, and may not contain any "children" (there are no mailboxes below this one). Calling imap_createmailbox() will not work on this mailbox.

    • LATT_NOSELECT - This is only a container, not a mailbox - you cannot open it.

    • LATT_MARKED - This mailbox is marked. This means that it may contain new messages since the last time it was checked. Not provided by all IMAP servers.

    • LATT_UNMARKED - This mailbox is not marked, does not contain new messages. If either MARKED or UNMARKED is provided, you can assume the IMAP server supports this feature for this mailbox.

    • LATT_REFERRAL - This container has a referral to a remote mailbox.

    • LATT_HASCHILDREN - This mailbox has selectable inferiors.

    • LATT_HASNOCHILDREN - This mailbox has no selectable inferiors.

    The function returns false on failure.

    Historial de cambios

    VersiónDescripción
    8.1.0 The imap parameter expects an IMAP\Connection instance now; previously, a valid imaprecurso was expected.

    Ejemplos

    Ejemplo #1 imap_getmailboxes() example

    <?php
    $mbox     = imap_open("{imap.example.org}", "username", "password", OP_HALFOPEN)
    or die(    "can't connect: " . imap_last_error());

    $list = imap_getmailboxes($mbox, "{imap.example.org}", "*");
    if (    is_array($list)) {
    foreach (    $list as $key => $val) {
    echo     "($key) ";
    echo     imap_utf7_decode($val->name) . ",";
    echo     "'" . $val->delimiter . "',";
    echo     $val->attributes . "<br />\n";
    }
    } else {
    echo     "imap_getmailboxes failed: " . imap_last_error() . "\n";
    }

    imap_close($mbox);
    ?>

    Ver también

    To Top