parent root
PHP: imap_gc - Manual

imap_gc

(PHP 5 >= 5.3.0, PHP 7)

imap_gcClears IMAP cache

Description

imap_gc ( resource $imap_stream , int $caches ) : bool

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

?>
add a noteadd a note

User Contributed Notes 1 note

up
3
Anonymous
10 years ago
If you notice that you're program's memory usage is increasing (as observed using ps) while calling the imap functions, calling this function should free that memory.
To Top
parent root