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

125 lines
4.4 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>Move specified messages to a mailbox</title>
</head>
<body class="docs"><div id="layout">
<div id="layout-content"><div id="function.imap-mail-move" class="refentry">
<div class="refnamediv">
<h1 class="refname">imap_mail_move</h1>
<p class="verinfo">(PHP 4, PHP 5, PHP 7)</p><p class="refpurpose"><span class="refname">imap_mail_move</span> &mdash; <span class="dc-title">Move specified messages to a mailbox</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.imap-mail-move-description">
<h3 class="title">说明</h3>
<div class="methodsynopsis dc-description">
<span class="methodname"><strong>imap_mail_move</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">$msglist</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$mailbox</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">
Moves mail messages specified by <code class="parameter">msglist</code> to the
specified <code class="parameter">mailbox</code>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.imap-mail-move-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">msglist</code></dt>
<dd>
<p class="para">
<code class="parameter">msglist</code> is a range not just message numbers
(as described in <a href="http://www.faqs.org/rfcs/rfc2060" class="link external">&raquo;&nbsp;RFC2060</a>).
</p>
</dd>
<dt>
<code class="parameter">mailbox</code></dt>
<dd>
<p class="para">
The mailbox name, see <span class="function"><a href="imap_open.html" class="function">imap_open()</a></span> for more
information
</p>
<div class="warning"><strong class="warning">Warning</strong><p class="simpara">
Passing untrusted data to this parameter is <em class="emphasis">insecure</em>, unless
<a href="imap.configuration.html#ini.imap.enable-insecure-rsh" class="link">imap.enable_insecure_rsh</a> is disabled.
</p></div>
</dd>
<dt>
<code class="parameter">options</code></dt>
<dd>
<p class="para">
<code class="parameter">options</code> is a bitmask and may contain the single option:
<ul class="itemizedlist">
<li class="listitem">
<span class="simpara">
<strong><code>CP_UID</code></strong> - the sequence numbers contain UIDS
</span>
</li>
</ul>
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.imap-mail-move-returnvalues">
<h3 class="title">返回值</h3>
<p class="para">
成功时返回 <strong><code>TRUE</code></strong> 或者在失败时返回 <strong><code>FALSE</code></strong>
</p>
</div>
<div class="refsect1 notes" id="refsect1-function.imap-mail-move-notes">
<h3 class="title">注释</h3>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
<span class="function"><strong>imap_mail_move()</strong></span> will flag the original
mail with a delete flag, to successfully delete it a call to
the <span class="function"><a href="imap_expunge.html" class="function">imap_expunge()</a></span> function must be made.
</p>
</p></blockquote>
</div>
<div class="refsect1 seealso" id="refsect1-function.imap-mail-move-seealso">
<h3 class="title">参见</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><span class="function"><a href="imap_mail_copy.html" class="function" rel="rdfs-seeAlso">imap_mail_copy()</a> - Copy specified messages to a mailbox</span></li>
</ul>
</p>
</div>
</div></div></div></body></html>