<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Clears IMAP cache</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.imap-fetchtext.html">imap_fetchtext</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.imap-get-quota.html">imap_get_quota</a></div>
<div class="up"><a href="ref.imap.html">IMAP Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.imap-gc" class="refentry">
<div class="refnamediv">
<h1 class="refname">imap_gc</h1>
<p class="verinfo">(PHP 5 >= 5.3.0)</p><p class="refpurpose"><span class="refname">imap_gc</span> — <span class="dc-title">Clears IMAP cache</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.imap-gc-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>imap_gc</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$imap_stream</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$caches</code></span>
)</div>
<p class="para rdfs-comment">
Purges the cache of entries of a specific type.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.imap-gc-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">
imap_stream</code></em></span><dd>
<p class="para">An IMAP stream returned by
<span class="function"><a href="function.imap-open.html" class="function">imap_open()</a></span>.</p></dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">caches</code></em></span>
<dd>
<p class="para">
Specifies the cache to purge. It may one or a combination
of the following constants:
<strong><code>IMAP_GC_ELT</code></strong> (message cache elements),
<strong><code>IMAP_GC_ENV</code></strong> (enveloppe and bodies),
<strong><code>IMAP_GC_TEXTS</code></strong> (texts).
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.imap-gc-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.imap-gc-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-3357">
<p><strong>Example #1 <span class="function"><strong>imap_gc()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br />$mbox </span><span style="color: #007700">= </span><span style="color: #0000BB">imap_open</span><span style="color: #007700">(</span><span style="color: #DD0000">"{imap.example.org:143}"</span><span style="color: #007700">, </span><span style="color: #DD0000">"username"</span><span style="color: #007700">, </span><span style="color: #DD0000">"password"</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">imap_gc</span><span style="color: #007700">(</span><span style="color: #0000BB">$mbox</span><span style="color: #007700">, </span><span style="color: #0000BB">IMAP_GC_ELT</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.imap-fetchtext.html">imap_fetchtext</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.imap-get-quota.html">imap_get_quota</a></div>
<div class="up"><a href="ref.imap.html">IMAP Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
