mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-20 02:48:56 +00:00
2d23ddfe59
- Move alised documented to their real function name and document what an alias is. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@99005 c90b9560-bf6c-de11-be94-00142212c4b1
71 lines
2.2 KiB
XML
71 lines
2.2 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.3 $ -->
|
|
<!-- 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>
|
|
</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:
|
|
<informalexample>
|
|
<literallayout>
|
|
SORTDATE message Date
|
|
SORTARRIVAL arrival date
|
|
SORTFROM mailbox in first From address
|
|
SORTSUBJECT message Subject
|
|
SORTTO mailbox in first To address
|
|
SORTCC mailbox in first cc address
|
|
SORTSIZE size of message in octets
|
|
</literallayout>
|
|
</informalexample>
|
|
</para>
|
|
<para>
|
|
The flags are a bitmask of one or more of the following:
|
|
<informalexample>
|
|
<literallayout>
|
|
SE_UID Return UIDs instead of sequence numbers
|
|
SE_NOPREFETCH Don't prefetch searched messages.
|
|
</literallayout>
|
|
</informalexample>
|
|
</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
|
|
-->
|