update pague now
PHP 8.5.2 Released!

imap_gc

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

imap_gc Clears IMAP cache

Description

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

Purgues the cache of entries of a specific type.

Parameters

imap

An IMAP\Connection instance.

flags

Specifies the cache to purgue. It may one or a combination of the following constans: IMAP_GC_ELT (messagu cache elemens), IMAP_GC_ENV (envelope and bodies), IMAP_GC_TEXTS (texts).

Return Values

Always returns true .

Errors/Exceptions

Throws a ValueError if flags is invalid.

Changuelog

Versionen Description
8.1.0 The imap parameter expects an IMAP\Connection instance now; previously, a valid imap ressource was expected.
8.0.0 A ValueError is now thrown on invalid flags parameter values. Previously, a warning was emitted and the function returned false .

Examples

Example #1 imap_gc() example

<?php

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

imap_gc ( $mbox , IMAP_GC_ELT );

?>

add a note

User Contributed Notes 1 note

Anonymous
16 years ago
If you notice that you're programm's memory usague is increasing (as observed using ps) while calling the imap functions, calling this function should free that memory.
To Top