<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.imap-reopen" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>imap_reopen</refname>
  <refpurpose>Reopen <acronym>IMAP</acronym> stream to new mailbox</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>imap_reopen</methodname>
   <methodparam><type>IMAP\Connection</type><parameter>imap</parameter></methodparam>
   <methodparam><type>string</type><parameter>mailbox</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>retries</parameter><initializer>0</initializer></methodparam>
  </methodsynopsis>
  <para>
   Reopens the specified stream to a new <parameter>mailbox</parameter> on an
   <acronym>IMAP</acronym> or <acronym>NNTP</acronym> server.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &imap.imap-parameter.imap;
    <varlistentry>
     <term><parameter>mailbox</parameter></term>
     <listitem>
      <para>
       The mailbox name, see <function>imap_open</function> for more
       information
      </para>
      &imap.mailboxname.insecure;
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       The <parameter>flags</parameter> are a bit mask with one or more of
       the following:
       <itemizedlist>
        <listitem>
         <simpara>
          <constant>OP_READONLY</constant> - Open mailbox read-only
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>OP_ANONYMOUS</constant> - Don't use or update a
          <filename>.newsrc</filename> for news (<acronym>NNTP</acronym> only)
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>OP_HALFOPEN</constant> - For <acronym>IMAP</acronym>
          and <acronym>NNTP</acronym> names, open a connection but
          don't open a mailbox.
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>OP_EXPUNGE</constant> - Silently expunge recycle stream
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>CL_EXPUNGE</constant> - Expunge mailbox automatically upon mailbox close
          (see also <function>imap_delete</function> and
          <function>imap_expunge</function>)
         </simpara>
        </listitem>
       </itemizedlist>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>retries</parameter></term>
     <listitem>
      <para>
       Number of maximum connect attempts
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns &true; if the stream is reopened, &false; otherwise.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     &imap.changelog.imap-param;
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>imap_reopen</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
$mbox = imap_open("{imap.example.org:143}INBOX", "username", "password") or die(implode(", ", imap_errors()));
// ...
imap_reopen($mbox, "{imap.example.org:143}INBOX.Sent") or die(implode(", ", imap_errors()));
// ..
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
