imap_gc

    (PHP 5 >= 5.3.0, PHP 7, PHP 8)

    imap_gc — Clears IMAP cache

    Descripción

    imap_gc(IMAP\Connection$imap, int$flags): true

    Purges the cache of entries of a specific type.

    Parámetros

    imap

    An IMAP\Connection instance.

    flags

    Specifies the cache to purge. It may one or a combination of the following constants: IMAP_GC_ELT (message cache elements), IMAP_GC_ENV (envelope and bodies), IMAP_GC_TEXTS (texts).

    Valores devueltos

    Siempre devuelve true.

    Errores/Excepciones

    Throws a ValueError if flags is invalid.

    Historial de cambios

    VersiónDescripción
    8.1.0 The imap parameter expects an IMAP\Connection instance now; previously, a valid imaprecurso was expected.
    8.0.0 A ValueError is now thrown on invalid flags parameter values. Previously, a warning was emitted and the function returned false.

    Ejemplos

    Ejemplo #1 imap_gc() example

    <?php

    $mbox     = imap_open("{imap.example.org:143}", "username", "password");

    imap_gc($mbox, IMAP_GC_ELT);

    ?>
    To Top