imap-sort.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 34892f82742329af7e7b4b22be6ad21418fd9768 Maintainer: hholzgra Status: ready -->
<!-- Reviewed: yes -->
<!-- Rev-Revision: 34892f82742329af7e7b4b22be6ad21418fd9768 Reviewer: samesch -->
<refentry xml:id="function.imap-sort" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>imap_sort</refname>
  <refpurpose>Liefert und sortiert Nachrichten eines Postfachs</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>
   Gibt eine gemäß den angegebenen Sortierkriterien sortierte Liste von
   Nachrichtennummern zurück.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &imap.imap-parameter.imap;
    <varlistentry>
     <term><parameter>criteria</parameter></term>
     <listitem>
      <para>
       Nur eines der folgenden Sortierkriterien:
       <itemizedlist>
        <listitem>
         <simpara>
          <constant>SORTDATE</constant> - das Sendedatum
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>SORTARRIVAL</constant> - das Eingangsdatum
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>SORTFROM</constant> - die erste Absenderadresse
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>SORTSUBJECT</constant> - der Betreff
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>SORTTO</constant> - die erste Empfängeradresse
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>SORTCC</constant> - die erste CC-Empfängeradresse
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>SORTSIZE</constant> - die Größe der Nachricht in Bytes
         </simpara>
        </listitem>
       </itemizedlist>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>reverse</parameter></term>
     <listitem>
      <para>
       Sortierung in umgekehrter Reihenfolge, wenn &true;
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       Der Parameter <parameter>flags</parameter> enthält eine Bitmaske mit
       einem oder mehreren der folgenden Werte:
       <itemizedlist>
        <listitem>
         <simpara>
          <constant>SE_UID</constant> - es werden UIDs anstelle von
          Nachrichtennummern zurückgegeben
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>SE_NOPREFETCH</constant> - Nachrichten werden nicht auf
          Vorrat abgerufen
         </simpara>
        </listitem>
       </itemizedlist>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>search_criteria</parameter></term>
     <listitem>
      <para>
       Ein String mit Suchkriterien im IMAP2-Format. Details können
       <function>imap_search</function> entnommen werden.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>charset</parameter></term>
     <listitem>
      <para>
       Der zum Sortieren von Strings zu verwendende MIME-Zeichensatz.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Gibt ein Array mit Nachrichtennummern zurück, die nach den angegebenen
   Sortierkriterien sortiert sind. &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> ist nun vom Typ <type>bool</type> statt
       <type>int</type>.
      </entry>
     </row>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>search_criteria</parameter> und
       <parameter>charset</parameter> sind nun nullable (akzeptieren den
       (&null;-Wert).
      </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
-->