Home/ Manual/ imap / functions/ imap_gc

imap_gc

PHP function Edit on GitHub ✎

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

Clears IMAP cache

Description

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

Purges the cache of entries of a specific type.

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

Always

Throws a ValueError if flags is invalid.

Version	Description
8.0.0	A `ValueError` is now thrown on invalid `flags` parameter values. Previously, a warning was emitted and the function returned false.

imap_gc() example

php

<?php

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

imap_gc($mbox, IMAP_GC_ELT);

?>

Source: reference/imap/functions/imap-gc.xml · from the official PHP manual (php/doc-en)