php-doc-en/reference/imap/functions/imap-reopen.xml
Etienne Kneuss 6730f8ddb7 Avoid using aliases
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@214929 c90b9560-bf6c-de11-be94-00142212c4b1
2006-06-16 18:11:33 +00:00

89 lines
2.7 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.9 $ -->
<!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 -->
<refentry id="function.imap-reopen">
<refnamediv>
<refname>imap_reopen</refname>
<refpurpose>Reopen IMAP stream to new mailbox</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>imap_reopen</methodname>
<methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam>
<methodparam><type>string</type><parameter>mailbox</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam>
</methodsynopsis>
<para>
This function reopens the specified stream to a new
<parameter>mailbox</parameter> on an IMAP or NNTP server.
</para>
<para>
The <parameter>options</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 (NNTP only)
</simpara>
</listitem>
<listitem>
<simpara>
<constant>OP_HALFOPEN</constant> - For IMAP and NNTP names, open a connection but
don't open a mailbox.
</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>
<para>
&return.success;
</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>
</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:"../../../../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
-->