1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 297028 $ -->
<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>resource</type><parameter>imap_stream</parameter></methodparam>
<methodparam><type>string</type><parameter>mailbox</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>n_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-stream.description;
<varlistentry>
<term><parameter>mailbox</parameter></term>
<listitem>
<para>
The mailbox name, see <function>imap_open</function> for more
information
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
<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 (<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>n_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;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>5.2.0</entry>
<entry><parameter>n_retries</parameter> added</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</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
-->
|
