imap_gc

Clears IMAP cache

Description

bool imap_gc ( resource $imap_stream , int $caches )

Purges the cache of entries of a specific type.

Parameters

imap_stream

An IMAP stream returned by imap_open.

caches

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

?>