<?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-listscan.php',
    1 => 'imap_listscan',
    2 => 'Lit la liste des bo&icirc;tes aux lettres, et y recherche une cha&icirc;ne',
  ),
  'up' => 
  array (
    0 => 'ref.imap.php',
    1 => 'Fonctions IMAP',
  ),
  'prev' => 
  array (
    0 => 'function.imap-listmailbox.php',
    1 => 'imap_listmailbox',
  ),
  'next' => 
  array (
    0 => 'function.imap-listsubscribed.php',
    1 => 'imap_listsubscribed',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'fr',
    'path' => 'reference/imap/functions/imap-listscan.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.imap-listscan" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">imap_listscan</h1>
  <p class="verinfo">(PHP 4, PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">imap_listscan</span> &mdash; <span class="dc-title">Lit la liste des boîtes aux lettres, et y recherche une chaîne</span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.imap-listscan-description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>imap_listscan</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.string.php" class="type string">string</a></span> <code class="parameter">$reference</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$pattern</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$content</code></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">
   Retourne un tableau contenant les noms des boîtes aux lettres
   qui contiennent la chaîne <code class="parameter">content</code>
   dans leur nom.
  </p>
  <p class="para">
   Cette fonction est similaire à <span class="function"><a href="function.imap-listmailbox.php" class="function">imap_listmailbox()</a></span>,
   mais va aussi vérifier la présence de la chaîne <code class="parameter">content</code>
   dans les messages de la boîte aux lettres.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.imap-listscan-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">reference</code></dt>
     <dd>
      <p class="para">
       <code class="parameter">reference</code> ne devrait être que le serveur
       sous la forme décrite dans <span class="function"><a href="function.imap-open.php" class="function">imap_open()</a></span>
      </p>
      <div class="warning"><strong class="warning">Avertissement</strong><p class="simpara">
    Passer des données qui ne sont pas digne de confiance à ce paramètre est <em>dangereux</em>, sauf si,
    <a href="imap.configuration.php#ini.imap.enable-insecure-rsh" class="link">imap.enable_insecure_rsh</a> est désactivé.
</p></div>
     </dd>
    
    
     <dt><code class="parameter">pattern</code></dt>
     <dd>
      <p class="para">Spécifie la position dans la hiérarchie des boîtes
aux lettres, où il faut commencer à chercher.</p><p class="para">Il y a deux caractères
spéciaux que vous pouvez utiliser dans <code class="parameter">pattern</code> :
&#039;<code class="literal">*</code>&#039; et &#039;<code class="literal">%</code>&#039;.
&#039;<code class="literal">*</code>&#039; signifie : toutes les boîtes aux lettres. Si vous passez
<code class="parameter">pattern</code> comme &#039;<code class="literal">*</code>&#039;, vous obtiendrez
la liste complète des boîtes aux lettres de la hiérarchie.
&#039;<code class="literal">%</code>&#039; signifie qu&#039;on ne s&#039;intéresse qu&#039;au niveau courant.
&#039;<code class="literal">%</code>&#039; passé à <code class="parameter">pattern</code> ne retournera
que les boîtes aux lettres de niveau supérieur; &#039;<code class="literal">~/mail/%</code>&#039;
sous <code class="literal">UW_IMAPD</code> retournera toutes les boîtes aux lettres du
dossier <var class="filename">~/mail</var> directory, mais pas leurs enfants.</p>
     </dd>
    
    
     <dt><code class="parameter">content</code></dt>
     <dd>
      <p class="para">
       La chaîne cherchée
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.imap-listscan-returnvalues">
  <h3 class="title">Valeurs de retour</h3>
  <p class="para">
   Retourne un tableau contenant les noms des boîtes aux lettres
   qui contiennent la chaîne <code class="parameter">content</code>
   dans le nom de la boîte aux lettres,  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-listscan-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>

    </tbody>
   
  </table>

 </div>


 <div class="refsect1 seealso" id="refsect1-function.imap-listscan-seealso">
  <h3 class="title">Voir aussi</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.imap-listmailbox.php" class="function" rel="rdfs-seeAlso">imap_listmailbox()</a> - Alias de imap_list</span></li>
    <li><span class="function"><a href="function.imap-search.php" class="function" rel="rdfs-seeAlso">imap_search()</a> - Retourne un tableau de messages apr&egrave;s recherche</span></li>
   </ul>
  </p>
 </div>


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