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
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 -->
<refentry id="function.imap-sort">
<refnamediv>
<refname>imap_sort</refname>
<refpurpose>Sort an array of message headers</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>imap_sort</methodname>
<methodparam><type>resource</type><parameter>stream</parameter></methodparam>
<methodparam><type>int</type><parameter>criteria</parameter></methodparam>
<methodparam><type>int</type><parameter>reverse</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>search_criteria</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>charset</parameter></methodparam>
</methodsynopsis>
<para>
Returns an array of message numbers sorted by the given
parameters.
</para>
<para>
<parameter>Reverse</parameter> is 1 for reverse-sorting.
</para>
<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>
<para>
The flags 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>
<para>
Parameter <parameter>charset</parameter> was added in PHP 4.3.3.
</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:"../../../../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
-->
|
