imap_gc

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

imap_gcClears IMAP cache

Description

imap_gc ( resource $imap , int $flags ) : bool

Purges the cache of entries of a specific type.

Parameters

imap

An IMAP stream returned by imap_open().

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

Return Values

Returns true on success or false on failure.

Examples

Example #1 imap_gc() example

<?php

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

imap_gc($mboxIMAP_GC_ELT);

?>