<!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>Sets 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-setacl.html">imap_setacl</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.imap-sort.html">imap_sort</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-setflag-full" class="refentry">
<div class="refnamediv">
<h1 class="refname">imap_setflag_full</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">imap_setflag_full</span> — <span class="dc-title">Sets flags on messages</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.imap-setflag-full-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>imap_setflag_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"> = NIL</span></span>
] )</div>
<p class="para rdfs-comment">
Causes a store to add the specified <em><code class="parameter">flag</code></em> to the
flags set for the messages in the specified
<em><code class="parameter">sequence</code></em>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.imap-setflag-full-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">sequence</code></em></span>
<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>
<dt>
<span class="term"><em><code class="parameter">flag</code></em></span>
<dd>
<p class="para">
The flags which you can set are <em>\Seen</em>,
<em>\Answered</em>, <em>\Flagged</em>,
<em>\Deleted</em>, and <em>\Draft</em> as
defined by <a href="http://www.faqs.org/rfcs/rfc2060" class="link external">» RFC2060</a>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">options</code></em></span>
<dd>
<p class="para">
A bit mask that 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>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.imap-setflag-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 examples" id="refsect1-function.imap-setflag-full-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-3375">
<p><strong>Example #1 <span class="function"><strong>imap_setflag_full()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<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 /> or die(</span><span style="color: #DD0000">"can't connect: " </span><span style="color: #007700">. </span><span style="color: #0000BB">imap_last_error</span><span style="color: #007700">());<br /><br /></span><span style="color: #0000BB">$status </span><span style="color: #007700">= </span><span style="color: #0000BB">imap_setflag_full</span><span style="color: #007700">(</span><span style="color: #0000BB">$mbox</span><span style="color: #007700">, </span><span style="color: #DD0000">"2,5"</span><span style="color: #007700">, </span><span style="color: #DD0000">"\\Seen \\Flagged"</span><span style="color: #007700">);<br /><br />echo </span><span style="color: #0000BB">gettype</span><span style="color: #007700">(</span><span style="color: #0000BB">$status</span><span style="color: #007700">) . </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br />echo </span><span style="color: #0000BB">$status </span><span style="color: #007700">. </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">imap_close</span><span style="color: #007700">(</span><span style="color: #0000BB">$mbox</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.imap-setflag-full-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.imap-clearflag-full.html" class="function" rel="rdfs-seeAlso">imap_clearflag_full()</a> - Clears 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-setacl.html">imap_setacl</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.imap-sort.html">imap_sort</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>
