uTools-Manuals/docs/php/imap_clearflag_full.html
2019-04-08 23:22:26 +08:00

111 lines
3.8 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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 class="docs"><div id="layout">
<div id="layout-content"><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> &mdash; <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">说明</h3>
<div class="methodsynopsis dc-description">
<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>
] ) : <span class="type">bool</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">参数</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">
imap_stream</code></dt>
<dd>
<p class="para"><span class="function"><a href="imap_open.html" class="function">imap_open()</a></span> 返回的 IMAP 流。</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 &quot;\\Seen&quot;, &quot;\\Answered&quot;, &quot;\\Flagged&quot;,
&quot;\\Deleted&quot;, and &quot;\\Draft&quot; (as defined by <a href="http://www.faqs.org/rfcs/rfc2060" class="link external">&raquo;&nbsp;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">返回值</h3>
<p class="para">
成功时返回 <strong><code>TRUE</code></strong> 或者在失败时返回 <strong><code>FALSE</code></strong>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.imap-clearflag-full-seealso">
<h3 class="title">参见</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><span class="function"><a href="imap_setflag_full.html" class="function" rel="rdfs-seeAlso">imap_setflag_full()</a> - Sets flags on messages</span></li>
</ul>
</p>
</div>
</div></div></div></body></html>