imap_gc(3) php man page | unix.com

IMAP_GC(3)								 1								IMAP_GC(3)

imap_gc - Clears IMAP cache

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

DESCRIPTION
	Purges the cache of entries of a specific type.

PARAMETERS
	      o $
		imap_stream -An IMAP stream returned by imap_open(3).

	      o $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 (enveloppe and bodies), IMAP_GC_TEXTS (texts).

RETURN VALUES
	Returns TRUE on success or FALSE on failure.

EXAMPLES
       Example #1

	      imap_gc(3) example

	      <?php

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

	      imap_gc($mbox, IMAP_GC_ELT);

	      ?>

PHP Documentation Group 														IMAP_GC(3)