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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 297028 $ -->
<refentry xml:id="function.imap-fetch-overview" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>imap_fetch_overview</refname>
<refpurpose>Read an overview of the information in the headers of the given message</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>imap_fetch_overview</methodname>
<methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam>
<methodparam><type>string</type><parameter>sequence</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
This function fetches mail headers for the given
<parameter>sequence</parameter> and returns an overview of their
contents.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&imap.imap-stream.description;
<varlistentry>
<term><parameter>sequence</parameter></term>
<listitem>
<para>
A message sequence description. You can enumerate desired messages
with the <literal>X,Y</literal> syntax, or retrieve all messages
within an interval with the <literal>X:Y</literal> syntax
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
<para>
<parameter>sequence</parameter> will contain a sequence of message
indices or UIDs, if this parameter is set to
<constant>FT_UID</constant>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an array of objects describing one message header each.
The object will only define a property if it exists. The possible
properties are:
<itemizedlist>
<listitem>
<simpara>
<literal>subject</literal> - the messages subject
</simpara>
</listitem>
<listitem>
<simpara>
<literal>from</literal> - who sent it
</simpara>
</listitem>
<listitem>
<simpara>
<literal>to</literal> - recipient
</simpara>
</listitem>
<listitem>
<simpara>
<literal>date</literal> - when was it sent
</simpara>
</listitem>
<listitem>
<simpara>
<literal>message_id</literal> - Message-ID
</simpara>
</listitem>
<listitem>
<simpara>
<literal>references</literal> - is a reference to this message id
</simpara>
</listitem>
<listitem>
<simpara>
<literal>in_reply_to</literal> - is a reply to this message id
</simpara>
</listitem>
<listitem>
<simpara>
<literal>size</literal> - size in bytes
</simpara>
</listitem>
<listitem>
<simpara>
<literal>uid</literal> - UID the message has in the mailbox
</simpara>
</listitem>
<listitem>
<simpara>
<literal>msgno</literal> - message sequence number in the mailbox
</simpara>
</listitem>
<listitem>
<simpara>
<literal>recent</literal> - this message is flagged as recent
</simpara>
</listitem>
<listitem>
<simpara>
<literal>flagged</literal> - this message is flagged
</simpara>
</listitem>
<listitem>
<simpara>
<literal>answered</literal> - this message is flagged as answered
</simpara>
</listitem>
<listitem>
<simpara>
<literal>deleted</literal> - this message is flagged for deletion
</simpara>
</listitem>
<listitem>
<simpara>
<literal>seen</literal> - this message is flagged as already read
</simpara>
</listitem>
<listitem>
<simpara>
<literal>draft</literal> - this message is flagged as being a draft
</simpara>
</listitem>
</itemizedlist>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>imap_fetch_overview</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$mbox = imap_open("{imap.example.org:143}INBOX", "username", "password")
or die("can't connect: " . imap_last_error());
$MC = imap_check($mbox);
// Fetch an overview for all messages in INBOX
$result = imap_fetch_overview($mbox,"1:{$MC->Nmsgs}",0);
foreach ($result as $overview) {
echo "#{$overview->msgno} ({$overview->date}) - From: {$overview->from}
{$overview->subject}\n";
}
imap_close($mbox);
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>imap_fetchheader</function></member>
</simplelist>
</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
-->
|
