<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.imap.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'fr',
  ),
  'this' => 
  array (
    0 => 'function.imap-sort.php',
    1 => 'imap_sort',
    2 => 'Trie des messages',
  ),
  'up' => 
  array (
    0 => 'ref.imap.php',
    1 => 'Fonctions IMAP',
  ),
  'prev' => 
  array (
    0 => 'function.imap-setflag-full.php',
    1 => 'imap_setflag_full',
  ),
  'next' => 
  array (
    0 => 'function.imap-status.php',
    1 => 'imap_status',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'fr',
    'path' => 'reference/imap/functions/imap-sort.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.imap-sort" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">imap_sort</h1>
  <p class="verinfo">(PHP 4, PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">imap_sort</span> &mdash; <span class="dc-title">Trie des messages</span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.imap-sort-description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>imap_sort</strong></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="class.imap-connection.php" class="type IMAP\Connection">IMAP\Connection</a></span> <code class="parameter">$imap</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$criteria</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span> <code class="parameter">$reverse</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$flags</code><span class="initializer"> = 0</span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.string.php" class="type string">string</a></span></span> <code class="parameter">$search_criteria</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.string.php" class="type string">string</a></span></span> <code class="parameter">$charset</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span><br>): <span class="type"><span class="type"><a href="language.types.array.php" class="type array">array</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>

  <p class="para rdfs-comment">
   Récupère et trie les numéros de messages en fonction des paramètres donnés.
  </p>
 </div>

 <div class="refsect1 parameters" id="refsect1-function.imap-sort-parameters">
  <h3 class="title">Liste de paramètres</h3>
  <p class="para">
   <dl>
    
<dt><code class="parameter">imap</code></dt><dd><p class="para">
 Une instance de <span class="classname"><a href="class.imap-connection.php" class="classname">IMAP\Connection</a></span>.
</p></dd>
    
     <dt><code class="parameter">criteria</code></dt>
     <dd>
      <p class="para">
       Les critères <code class="parameter">criteria</code> peuvent être
       un (et un seul) parmi les suivants :
       <ul class="itemizedlist">
        <li class="listitem">
         <span class="simpara">
          <strong><code><a href="imap.constants.php#constant.sortdate">SORTDATE</a></code></strong> : date du message
         </span>
        </li>
        <li class="listitem">
         <span class="simpara">
          <strong><code><a href="imap.constants.php#constant.sortarrival">SORTARRIVAL</a></code></strong> : date d&#039;arrivée
         </span>
        </li>
        <li class="listitem">
         <span class="simpara">
          <strong><code><a href="imap.constants.php#constant.sortfrom">SORTFROM</a></code></strong> : nom de la première boîte
          aux lettres de l&#039;adresse d&#039;origine (From address)
         </span>
        </li>
        <li class="listitem">
         <span class="simpara">
          <strong><code><a href="imap.constants.php#constant.sortsubject">SORTSUBJECT</a></code></strong> : sujet du message
         </span>
        </li>
        <li class="listitem">
         <span class="simpara">
          <strong><code><a href="imap.constants.php#constant.sortto">SORTTO</a></code></strong> : nom de la première boîte aux
          lettres de destination (To address)
         </span>
        </li>
        <li class="listitem">
         <span class="simpara">
          <strong><code><a href="imap.constants.php#constant.sortcc">SORTCC</a></code></strong> : nom de la boîte aux lettres de 
          copie cachée (cc address)
         </span>
        </li>
        <li class="listitem">
         <span class="simpara">
          <strong><code><a href="imap.constants.php#constant.sortsize">SORTSIZE</a></code></strong> : taille du message en octets
         </span>
        </li>
       </ul>
      </p>
     </dd>
    
    
     <dt><code class="parameter">reverse</code></dt>
     <dd>
      <p class="para">
       S&#039;il faut trier en ordre inverse.
      </p>
     </dd>
    
    
     <dt><code class="parameter">flags</code></dt>
     <dd>
      <p class="para">
       Les <code class="parameter">flags</code> sont des masques de bits,
       d&#039;un ou plusieurs des éléments suivants :
       <ul class="itemizedlist">
        <li class="listitem">
         <span class="simpara">
          <strong><code><a href="imap.constants.php#constant.se-uid">SE_UID</a></code></strong> : retourne des UID à la place de numéros
         </span>
        </li>
        <li class="listitem">
         <span class="simpara">
          <strong><code><a href="imap.constants.php#constant.se-noprefetch">SE_NOPREFETCH</a></code></strong> : ne pas prétélécharger les messages trouvés
         </span>
        </li>
       </ul>
      </p>
     </dd>
    
    
     <dt><code class="parameter">search_criteria</code></dt>
     <dd>
      <p class="para">
       Critères de recherche IMAP2-format. Pour plus de détails voir
       <span class="function"><a href="function.imap-search.php" class="function">imap_search()</a></span>.
      </p>
     </dd>
    
    
     <dt><code class="parameter">charset</code></dt>
     <dd>
      <p class="para">
       Jeu de caractères MIME à utiliser lors de la recherche de <a href="language.types.string.php" class="link">chaîne de caractères</a>.
      </p>
     </dd>
    
   </dl>
  </p>
 </div>

 <div class="refsect1 returnvalues" id="refsect1-function.imap-sort-returnvalues">
  <h3 class="title">Valeurs de retour</h3>
  <p class="para">
   Retourne un tableau de numéros de messages triés en fonction
   des paramètres fournis,  ou <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> si une erreur survient.
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.imap-sort-changelog">
  <h3 class="title">Historique</h3>
  <table class="doctable informaltable">
   
    <thead>
     <tr>
      <th>Version</th>
      <th>Description</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
 <td>8.1.0</td>
 <td>
  La paramètre <code class="parameter">imap</code> attend désormais une instance de
  <span class="classname"><a href="class.imap-connection.php" class="classname">IMAP\Connection</a></span> ; auparavant, une <span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span> <code class="literal">imap</code> était attendue.
 </td>
</tr>

     <tr>
      <td>8.0.0</td>
      <td>
       <code class="parameter">reverse</code> est un <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span> au lieu de <span class="type"><a href="language.types.integer.php" class="type int">int</a></span>.
      </td>
     </tr>

     <tr>
      <td>8.0.0</td>
      <td>
       <code class="parameter">search_criteria</code> et <code class="parameter">charset</code> sont désormais <span class="type">nullable</span>.
      </td>
     </tr>

    </tbody>
   
  </table>

 </div>

</div><?php manual_footer($setup); ?>