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
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.imap-sort" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>imap_sort</refname>
<refpurpose>Gets and sort messages</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>array</type><type>false</type></type><methodname>imap_sort</methodname>
<methodparam><type>IMAP\Connection</type><parameter>imap</parameter></methodparam>
<methodparam><type>int</type><parameter>criteria</parameter></methodparam>
<methodparam><type>bool</type><parameter>reverse</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>search_criteria</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>charset</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Gets and sorts message numbers by the given parameters.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&imap.imap-parameter.imap;
<varlistentry>
<term><parameter>criteria</parameter></term>
<listitem>
<para>
Criteria can be one (and only one) of the following:
<itemizedlist>
<listitem>
<simpara>
<constant>SORTDATE</constant> - message Date
</simpara>
</listitem>
<listitem>
<simpara>
<constant>SORTARRIVAL</constant> - arrival date
</simpara>
</listitem>
<listitem>
<simpara>
<constant>SORTFROM</constant> - mailbox in first From address
</simpara>
</listitem>
<listitem>
<simpara>
<constant>SORTSUBJECT</constant> - message subject
</simpara>
</listitem>
<listitem>
<simpara>
<constant>SORTTO</constant> - mailbox in first To address
</simpara>
</listitem>
<listitem>
<simpara>
<constant>SORTCC</constant> - mailbox in first cc address
</simpara>
</listitem>
<listitem>
<simpara>
<constant>SORTSIZE</constant> - size of message in octets
</simpara>
</listitem>
</itemizedlist>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>reverse</parameter></term>
<listitem>
<para>
Whether to sort in reverse order.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
The <parameter>flags</parameter> are a bitmask of one or more of the
following:
<itemizedlist>
<listitem>
<simpara>
<constant>SE_UID</constant> - Return UIDs instead of sequence numbers
</simpara>
</listitem>
<listitem>
<simpara>
<constant>SE_NOPREFETCH</constant> - Don't prefetch searched messages
</simpara>
</listitem>
</itemizedlist>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>search_criteria</parameter></term>
<listitem>
<para>
IMAP2-format search criteria string. For details see
<function>imap_search</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>charset</parameter></term>
<listitem>
<para>
MIME character set to use when sorting strings.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an array of message numbers sorted by the given
parameters, &return.falseforfailure;.
</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;
<row>
<entry>8.0.0</entry>
<entry>
<parameter>reverse</parameter> is now <type>bool</type> instead of <type>int</type>.
</entry>
</row>
<row>
<entry>8.0.0</entry>
<entry>
<parameter>search_criteria</parameter> and <parameter>charset</parameter> are now <type>nullable</type>.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</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
-->
|
