<?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-fetch-overview.php',
    1 => 'imap_fetch_overview',
    2 => 'Lit le sommaire des en-t&ecirc;tes de messages',
  ),
  'up' => 
  array (
    0 => 'ref.imap.php',
    1 => 'Fonctions IMAP',
  ),
  'prev' => 
  array (
    0 => 'function.imap-expunge.php',
    1 => 'imap_expunge',
  ),
  'next' => 
  array (
    0 => 'function.imap-fetchbody.php',
    1 => 'imap_fetchbody',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'fr',
    'path' => 'reference/imap/functions/imap-fetch-overview.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.imap-fetch-overview" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">imap_fetch_overview</h1>
  <p class="verinfo">(PHP 4, PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">imap_fetch_overview</span> &mdash; <span class="dc-title">Lit le sommaire des en-têtes de messages</span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.imap-fetch-overview-description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>imap_fetch_overview</strong></span>(<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>, <span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$sequence</code></span>, <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>): <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">
   Lit les en-têtes des courriers électroniques de la séquence
   <code class="parameter">sequence</code> et retourne un sommaire de leur contenu.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.imap-fetch-overview-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">sequence</code></dt>
     <dd>
      <p class="para">
       Une description de la séquence du message. Il est possible d&#039;énumérer les
       messages désirés avec la syntaxe <code class="literal">X,Y</code>, ou récupérer
       tous les messages d&#039;un intervalle, avec la syntaxe <code class="literal">X:Y</code>
      </p>
     </dd>
    
    
     <dt><code class="parameter">flags</code></dt>
     <dd>
      <p class="para">
       <code class="parameter">sequence</code> va contenir une séquence
       d&#039;indice de message ou d&#039;UID, si <code class="parameter">flags</code>
       contient <strong><code><a href="imap.constants.php#constant.ft-uid">FT_UID</a></code></strong>.
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.imap-fetch-overview-returnvalues">
  <h3 class="title">Valeurs de retour</h3>
  <p class="para">
   Retourne un tableau d&#039;objets décrivant l&#039;en-tête de chaque message.
   L&#039;objet ne définira une propriété que si elle existe. Les propriétés
   possibles sont :
   <ul class="itemizedlist">
    <li class="listitem">
     <span class="simpara">
      <code class="literal">subject</code> : le sujet du message
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <code class="literal">from</code> : l&#039;expéditeur
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <code class="literal">to</code> : le destinataire
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <code class="literal">date</code> : la date d&#039;expédition
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <code class="literal">message_id</code> : l&#039;identification du message
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <code class="literal">references</code> : la référence sur l&#039;id de ce message
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <code class="literal">in_reply_to</code> : la réponse à cet identifiant de message
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <code class="literal">size</code> : la taille en octets
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <code class="literal">uid</code> : UID du message dans la boîte aux lettres
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <code class="literal">msgno</code> : le numéro de séquence du message dans la boîte
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <code class="literal">recent</code> : ce message est récent
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <code class="literal">flagged</code> : ce message est marqué
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <code class="literal">answered</code> : ce message a donné lieu à une réponse
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <code class="literal">deleted</code> : ce message est marqué pour l&#039;effacement
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <code class="literal">seen</code> : ce message est déjà lu
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <code class="literal">draft</code> : ce message est un brouillon
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <code class="literal">udate</code> : l&#039;horodatage UNIX de l&#039;heure d&#039;arrivée
     </span>
    </li>
   </ul>
   La fonction retourne <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> en cas d&#039;échec.
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.imap-fetch-overview-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 examples" id="refsect1-function.imap-fetch-overview-examples">
  <h3 class="title">Exemples</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>Exemple #1 Exemple avec <span class="function"><strong>imap_fetch_overview()</strong></span></strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$mbox </span><span style="color: #007700">= </span><span style="color: #0000BB">imap_open</span><span style="color: #007700">(</span><span style="color: #DD0000">"{imap.example.org:143}INBOX"</span><span style="color: #007700">, </span><span style="color: #DD0000">"username"</span><span style="color: #007700">, </span><span style="color: #DD0000">"password"</span><span style="color: #007700">)<br />     or die(</span><span style="color: #DD0000">"Connexion impossible : " </span><span style="color: #007700">. </span><span style="color: #0000BB">imap_last_error</span><span style="color: #007700">());<br /><br /></span><span style="color: #0000BB">$MC </span><span style="color: #007700">= </span><span style="color: #0000BB">imap_check</span><span style="color: #007700">(</span><span style="color: #0000BB">$mbox</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Récupère le sommaire pour tous les messages contenus dans INBOX<br /></span><span style="color: #0000BB">$result </span><span style="color: #007700">= </span><span style="color: #0000BB">imap_fetch_overview</span><span style="color: #007700">(</span><span style="color: #0000BB">$mbox</span><span style="color: #007700">,</span><span style="color: #DD0000">"1:</span><span style="color: #007700">{</span><span style="color: #0000BB">$MC</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">Nmsgs</span><span style="color: #007700">}</span><span style="color: #DD0000">"</span><span style="color: #007700">,</span><span style="color: #0000BB">0</span><span style="color: #007700">);<br />foreach (</span><span style="color: #0000BB">$result </span><span style="color: #007700">as </span><span style="color: #0000BB">$overview</span><span style="color: #007700">) {<br />    echo </span><span style="color: #DD0000">"#</span><span style="color: #007700">{</span><span style="color: #0000BB">$overview</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">msgno</span><span style="color: #007700">}</span><span style="color: #DD0000"> (</span><span style="color: #007700">{</span><span style="color: #0000BB">$overview</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">date</span><span style="color: #007700">}</span><span style="color: #DD0000">) - From: </span><span style="color: #007700">{</span><span style="color: #0000BB">$overview</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">from</span><span style="color: #007700">}</span><span style="color: #DD0000"><br />    </span><span style="color: #007700">{</span><span style="color: #0000BB">$overview</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">subject</span><span style="color: #007700">}</span><span style="color: #DD0000">\n"</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">imap_close</span><span style="color: #007700">(</span><span style="color: #0000BB">$mbox</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

   </div>
  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.imap-fetch-overview-seealso">
  <h3 class="title">Voir aussi</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.imap-fetchheader.php" class="function" rel="rdfs-seeAlso">imap_fetchheader()</a> - Retourne l'en-t&ecirc;te d'un message</span></li>
   </ul>
  </p>
 </div>


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