archived-doc-es/reference/imap/functions/imap-sort.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: d91919d0373a999db35a212104a7f29fe3019407 Maintainer: seros Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.imap-sort" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>imap_sort</refname>
  <refpurpose>Obtiene y ordena mensajes</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>imap_sort</methodname>
   <methodparam><type>resource</type><parameter>imap_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><initializer>0</initializer></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>search_criteria</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>charset</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   Obtiene y ordena números de mensajes según los parámetros dados.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &imap.imap-stream.description;
    <varlistentry>
     <term><parameter>criteria</parameter></term>
     <listitem>
      <para>
       El criterio puede ser un (y sólo uno) de los siguientes:
       <itemizedlist>
        <listitem>
         <simpara>
          <constant>SORTDATE</constant> - Date (fecha) del mensaje
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>SORTARRIVAL</constant> - fecha de llegada
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>SORTFROM</constant> - buzón en la primera dirección From (De)
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>SORTSUBJECT</constant> - asunto del mensaje
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>SORTTO</constant> - buzón en la primera dirección To (Para)
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>SORTCC</constant> - buzón en la primera dirección cc
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>SORTSIZE</constant> - tamaño del mensaje en octetos
         </simpara>
        </listitem>
       </itemizedlist>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>reverse</parameter></term>
     <listitem>
      <para>
       Establezca esto a 1 para ordenación inversa
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>options</parameter></term>
     <listitem>
      <para>
       <parameter>options</parameter> es una máscara de bits de uno o más de lo
       siguiente:
       <itemizedlist>
        <listitem>
         <simpara>
          <constant>SE_UID</constant> - Devolver UIDs en vez de números de secuencia
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>SE_NOPREFETCH</constant> - No preobtener mensajes buscados
         </simpara>
        </listitem>
       </itemizedlist>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>search_criteria</parameter></term>
     <listitem>
      <para>
       Cadena de criterios de búsqueda en formato IMAP2. Véase
       <function>imap_search</function> para más detalles.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>charset</parameter></term>
     <listitem>
      <para>
       Conjunto de caracteres MIME a utilizar cuando se ordenan cadenas.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Devuelve un array de números de mensajes ordenados según los parámetros
   dados.
  </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:"~/.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
-->