imap-sort.xml

<?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
-->