<!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><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.imap-mail-copy.html">imap_mail_copy</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.imap-mail.html">imap_mail</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-mail-move" class="refentry"> <div class="refnamediv"> <h1 class="refname">imap_mail_move</h1> <p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">imap_mail_move</span> — <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">Description</h3> <div class="methodsynopsis dc-description"> <span class="type">bool</span> <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> ] )</div> <p class="para rdfs-comment"> Moves mail messages specified by <em><code class="parameter">msglist</code></em> to the specified <em><code class="parameter">mailbox</code></em>. </p> </div> <div class="refsect1 parameters" id="refsect1-function.imap-mail-move-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">msglist</code></em></span> <dd> <p class="para"> <em><code class="parameter">msglist</code></em> is a range not just message numbers (as described in <a href="http://www.faqs.org/rfcs/rfc2060" class="link external">» RFC2060</a>). </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">mailbox</code></em></span> <dd> <p class="para"> The mailbox name, see <span class="function"><a href="function.imap-open.html" class="function">imap_open()</a></span> for more information </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">options</code></em></span> <dd> <p class="para"> <em><code class="parameter">options</code></em> 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> </dt> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-function.imap-mail-move-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 notes" id="refsect1-function.imap-mail-move-notes"> <h3 class="title">Notes</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="function.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">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"> <span class="function"><a href="function.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><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.imap-mail-copy.html">imap_mail_copy</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.imap-mail.html">imap_mail</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>