<!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>Reopen IMAP stream to new mailbox</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.imap-renamemailbox.html">imap_renamemailbox</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.imap-rfc822-parse-adrlist.html">imap_rfc822_parse_adrlist</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-reopen" class="refentry">
<div class="refnamediv">
<h1 class="refname">imap_reopen</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">imap_reopen</span> — <span class="dc-title">Reopen <acronym title="Internet Message Access Protocol">IMAP</acronym> stream to new mailbox</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.imap-reopen-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>imap_reopen</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">$mailbox</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$options</code><span class="initializer"> = 0</span></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$n_retries</code><span class="initializer"> = 0</span></span>
]] )</div>
<p class="para rdfs-comment">
Reopens the specified stream to a new <em><code class="parameter">mailbox</code></em> on an
<acronym title="Internet Message Access Protocol">IMAP</acronym> or <acronym title="Network News Transfer Protocol">NNTP</acronym> server.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.imap-reopen-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">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">
The <em><code class="parameter">options</code></em> are a bit mask with one or more of
the following:
<ul class="itemizedlist">
<li class="listitem">
<span class="simpara">
<strong><code>OP_READONLY</code></strong> - Open mailbox read-only
</span>
</li>
<li class="listitem">
<span class="simpara">
<strong><code>OP_ANONYMOUS</code></strong> - Don't use or update a
<var class="filename">.newsrc</var> for news (<acronym title="Network News Transfer Protocol">NNTP</acronym> only)
</span>
</li>
<li class="listitem">
<span class="simpara">
<strong><code>OP_HALFOPEN</code></strong> - For <acronym title="Internet Message Access Protocol">IMAP</acronym>
and <acronym title="Network News Transfer Protocol">NNTP</acronym> names, open a connection but
don't open a mailbox.
</span>
</li>
<li class="listitem">
<span class="simpara">
<strong><code>OP_EXPUNGE</code></strong> - Silently expunge recycle stream
</span>
</li>
<li class="listitem">
<span class="simpara">
<strong><code>CL_EXPUNGE</code></strong> - Expunge mailbox automatically upon mailbox close
(see also <span class="function"><a href="function.imap-delete.html" class="function">imap_delete()</a></span> and
<span class="function"><a href="function.imap-expunge.html" class="function">imap_expunge()</a></span>)
</span>
</li>
</ul>
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">n_retries</code></em></span>
<dd>
<p class="para">
Number of maximum connect attempts
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.imap-reopen-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> if the stream is reopened, <strong><code>FALSE</code></strong> otherwise.
</p>
</div>
<div class="refsect1 changelog" id="refsect1-function.imap-reopen-changelog">
<h3 class="title">Changelog</h3>
<p class="para">
<table class="doctable informaltable">
<thead>
<tr>
<th>Version</th>
<th>Description</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>5.2.0</td>
<td><em><code class="parameter">n_retries</code></em> added</td>
</tr>
</tbody>
</table>
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.imap-reopen-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-3370">
<p><strong>Example #1 <span class="function"><strong>imap_reopen()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$mbox </span><span style="color: #007700">= </span><span style="color: #0000BB">imap_open</span><span style="color: #007700">(</span><span style="color: #DD0000">"{imap.example.org:143}INBOX"</span><span style="color: #007700">, </span><span style="color: #DD0000">"username"</span><span style="color: #007700">, </span><span style="color: #DD0000">"password"</span><span style="color: #007700">) or die(</span><span style="color: #0000BB">implode</span><span style="color: #007700">(</span><span style="color: #DD0000">", "</span><span style="color: #007700">, </span><span style="color: #0000BB">imap_errors</span><span style="color: #007700">()));<br /></span><span style="color: #FF8000">// ...<br /></span><span style="color: #0000BB">imap_reopen</span><span style="color: #007700">(</span><span style="color: #0000BB">$mbox</span><span style="color: #007700">, </span><span style="color: #DD0000">"{imap.example.org:143}INBOX.Sent"</span><span style="color: #007700">) or die(</span><span style="color: #0000BB">implode</span><span style="color: #007700">(</span><span style="color: #DD0000">", "</span><span style="color: #007700">, </span><span style="color: #0000BB">imap_errors</span><span style="color: #007700">()));<br /></span><span style="color: #FF8000">// ..<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.imap-renamemailbox.html">imap_renamemailbox</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.imap-rfc822-parse-adrlist.html">imap_rfc822_parse_adrlist</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>
