uTools-Manuals/docs/php/imap_mail_copy.html
2019-04-28 19:00:34 +08:00

117 lines
4.1 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>Copy specified messages to a mailbox</title>
</head>
<body class="docs"><div id="layout">
<div id="layout-content"><div id="function.imap-mail-copy" class="refentry">
<div class="refnamediv">
<h1 class="refname">imap_mail_copy</h1>
<p class="verinfo">(PHP 4, PHP 5, PHP 7)</p><p class="refpurpose"><span class="refname">imap_mail_copy</span> &mdash; <span class="dc-title">Copy specified messages to a mailbox</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.imap-mail-copy-description">
<h3 class="title">说明</h3>
<div class="methodsynopsis dc-description">
<span class="methodname"><strong>imap_mail_copy</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">
Copies mail messages specified by <code class="parameter">msglist</code>
to specified mailbox.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.imap-mail-copy-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 of one or more of
<ul class="itemizedlist">
<li class="listitem">
<span class="simpara">
<strong><code>CP_UID</code></strong> - the sequence numbers contain UIDS
</span>
</li>
<li class="listitem">
<span class="simpara">
<strong><code>CP_MOVE</code></strong> - Delete the messages from
the current mailbox after copying
</span>
</li>
</ul>
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.imap-mail-copy-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-mail-copy-seealso">
<h3 class="title">参见</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><span class="function"><a href="imap_mail_move.html" class="function" rel="rdfs-seeAlso">imap_mail_move()</a> - Move specified messages to a mailbox</span></li>
</ul>
</p>
</div>
</div></div></div></body></html>