imap_gc

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

imap_gcEfface le cache IMAP

Description

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

Supprime toutes les entrées d'un type donné dans le cache IMAP.

Liste de paramètres

imap

Une instance de IMAP\Connection.

flags

Indique le type de cache à purger. Cela peut être la combinaison des constantes suivantes : IMAP_GC_ELT (cache des éléments de message), IMAP_GC_ENV (enveloppe et corps), IMAP_GC_TEXTS (textes).

Valeurs de retour

Retourne toujours true.

Erreurs / Exceptions

Lance une exception ValueError si le paramètre flags est invalide.

Historique

VersionDescription
8.1.0 La paramètre imap attend désormais une instance de IMAP\Connection ; auparavant, une ressourceimap était attendue.
8.0.0 Une exception ValueError est désormais lancée pour des valeurs de paramètre flags invalides. Auparavant, un avertissement était émis et la fonction retournait false.

Exemples

Exemple #1 Exemple avecimap_gc()

<?php

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

imap_gc($mbox, IMAP_GC_ELT);

?>
To Top