mirror of
https://github.com/fofolee/uTools-Manuals.git
synced 2025-06-18 05:26:57 +08:00
97 lines
3.8 KiB
HTML
97 lines
3.8 KiB
HTML
<!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>Rename an old mailbox to new mailbox</title>
|
||
</head>
|
||
<body class="docs"><div id="layout">
|
||
<div id="layout-content"><div id="function.imap-renamemailbox" class="refentry">
|
||
<div class="refnamediv">
|
||
<h1 class="refname">imap_renamemailbox</h1>
|
||
<p class="verinfo">(PHP 4, PHP 5, PHP 7)</p><p class="refpurpose"><span class="refname">imap_renamemailbox</span> — <span class="dc-title">Rename an old mailbox to new mailbox</span></p>
|
||
|
||
</div>
|
||
<div class="refsect1 description" id="refsect1-function.imap-renamemailbox-description">
|
||
<h3 class="title">说明</h3>
|
||
<div class="methodsynopsis dc-description">
|
||
<span class="methodname"><strong>imap_renamemailbox</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">$old_mbox</code></span>
|
||
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$new_mbox</code></span>
|
||
) : <span class="type">bool</span></div>
|
||
|
||
<p class="para rdfs-comment">
|
||
This function renames on old mailbox to new mailbox (see
|
||
<span class="function"><a href="imap_open.html" class="function">imap_open()</a></span> for the format of
|
||
<code class="parameter">mbox</code> names).
|
||
</p>
|
||
</div>
|
||
|
||
<div class="refsect1 parameters" id="refsect1-function.imap-renamemailbox-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">old_mbox</code></dt>
|
||
|
||
<dd>
|
||
|
||
<p class="para">
|
||
The old 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">new_mbox</code></dt>
|
||
|
||
<dd>
|
||
|
||
<p class="para">
|
||
The new 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>
|
||
|
||
|
||
</dl>
|
||
|
||
</p>
|
||
</div>
|
||
|
||
<div class="refsect1 returnvalues" id="refsect1-function.imap-renamemailbox-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-renamemailbox-seealso">
|
||
<h3 class="title">参见</h3>
|
||
<p class="para">
|
||
<ul class="simplelist">
|
||
<li class="member"><span class="function"><a href="imap_createmailbox.html" class="function" rel="rdfs-seeAlso">imap_createmailbox()</a> - Create a new mailbox</span></li>
|
||
<li class="member"><span class="function"><a href="imap_deletemailbox.html" class="function" rel="rdfs-seeAlso">imap_deletemailbox()</a> - Delete a mailbox</span></li>
|
||
</ul>
|
||
</p>
|
||
</div>
|
||
|
||
</div></div></div></body></html> |