<!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 flags on messages</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.imap-check.html">imap_check</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.imap-close.html">imap_close</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-clearflag-full" class="refentry">
<div class="refnamediv">
<h1 class="refname">imap_clearflag_full</h1>
<p class="verinfo">(PHP 4, PHP 5, PHP 7)</p><p class="refpurpose"><span class="refname">imap_clearflag_full</span> — <span class="dc-title">Clears flags on messages</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.imap-clearflag-full-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>imap_clearflag_full</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$imap_stream</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$sequence</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$flag</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$options</code><span class="initializer"> = 0</span></span>
] )</div>
<p class="para rdfs-comment">
This function causes a store to delete the specified
<code class="parameter">flag</code> to the flags set for the
messages in the specified <code class="parameter">sequence</code>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.imap-clearflag-full-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">
imap_stream</code></dt>
<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>
<code class="parameter">sequence</code></dt>
<dd>
<p class="para">
A sequence of message numbers. You can enumerate desired messages
with the <em>X,Y</em> syntax, or retrieve all messages
within an interval with the <em>X:Y</em> syntax
</p>
</dd>
<dt>
<code class="parameter">flag</code></dt>
<dd>
<p class="para">
The flags which you can unset are "\\Seen", "\\Answered", "\\Flagged",
"\\Deleted", and "\\Draft" (as defined by <a href="http://www.faqs.org/rfcs/rfc2060" class="link external">» RFC2060</a>)
</p>
</dd>
<dt>
<code class="parameter">options</code></dt>
<dd>
<p class="para">
<code class="parameter">options</code> are a bit mask and may contain
the single option:
<ul class="itemizedlist">
<li class="listitem">
<span class="simpara">
<strong><code>ST_UID</code></strong> - The sequence argument contains UIDs
instead of sequence numbers
</span>
</li>
</ul>
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.imap-clearflag-full-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 seealso" id="refsect1-function.imap-clearflag-full-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><span class="function"><a href="function.imap-setflag-full.html" class="function" rel="rdfs-seeAlso">imap_setflag_full()</a> - Sets flags on messages</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.imap-check.html">imap_check</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.imap-close.html">imap_close</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>
