<?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-fetchstructure.php',
    1 => 'imap_fetchstructure',
    2 => 'Lit la structure d\'un message',
  ),
  'up' => 
  array (
    0 => 'ref.imap.php',
    1 => 'Fonctions IMAP',
  ),
  'prev' => 
  array (
    0 => 'function.imap-fetchmime.php',
    1 => 'imap_fetchmime',
  ),
  'next' => 
  array (
    0 => 'function.imap-fetchtext.php',
    1 => 'imap_fetchtext',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'fr',
    'path' => 'reference/imap/functions/imap-fetchstructure.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.imap-fetchstructure" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">imap_fetchstructure</h1>
  <p class="verinfo">(PHP 4, PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">imap_fetchstructure</span> &mdash; <span class="dc-title">Lit la structure d&#039;un message</span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.imap-fetchstructure-description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>imap_fetchstructure</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.integer.php" class="type int">int</a></span> <code class="parameter">$message_num</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="class.stdclass.php" class="type stdClass">stdClass</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>

  <p class="para rdfs-comment">
   <span class="function"><strong>imap_fetchstructure()</strong></span> lit la structure du message
   <code class="parameter">msg_number</code>.
  </p>
 </div>

 <div class="refsect1 parameters" id="refsect1-function.imap-fetchstructure-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">message_num</code></dt>
     <dd>
      <p class="para">
       Le numéro du message
      </p>
     </dd>
    
    
     <dt><code class="parameter">flags</code></dt>
     <dd>
      <p class="para">
       Ce paramètre optionnel n&#039;a qu&#039;une seule option,
       <strong><code><a href="imap.constants.php#constant.ft-uid">FT_UID</a></code></strong>, qui demande à la fonction de traiter
       l&#039;argument <code class="parameter">message_num</code> comme un
       <code class="literal">UID</code>.
      </p>
     </dd>
    
   </dl>
  </p>
 </div>

 <div class="refsect1 returnvalues" id="refsect1-function.imap-fetchstructure-returnvalues">
  <h3 class="title">Valeurs de retour</h3>
  <p class="para">
   Retourne un objet dont les propriétés sont listées dans la table
   ci-dessous,  ou <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> si une erreur survient.
  </p>
  <p class="para">
   <table class="doctable table">
    <caption><strong>
     Objet retourné par <span class="function"><strong>imap_fetchstructure()</strong></span>
    </strong></caption>
    
     <tbody class="tbody">
      <tr>
       <td>type</td>
       <td>Type primaire de corps</td>
      </tr>

      <tr>
       <td>encoding</td>
       <td>Codage de transfert du corps</td>
      </tr>

      <tr>
       <td>ifsubtype</td>
       <td><strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> s&#039;il y a une chaîne de sous type</td>
      </tr>

      <tr>
       <td>subtype</td>
       <td>sous type <abbr title="Multipurpose Internet Mail Extensions">MIME</abbr></td>
      </tr>

      <tr>
       <td>ifdescription</td>
       <td><strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> s&#039;il y a une chaîne de description</td>
      </tr>

      <tr>
       <td>description</td>
       <td>Chaîne de description du contenu</td>
      </tr>

      <tr>
       <td>ifid</td>
       <td><strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> s&#039;il y a une chaîne d&#039;identification</td>
      </tr>

      <tr>
       <td>id</td>
       <td>Chaîne d&#039;identification</td>
      </tr>

      <tr>
       <td>lines</td>
       <td>Nombre de lignes</td>
      </tr>

      <tr>
       <td>bytes</td>
       <td>Nombre d&#039;octets</td>
      </tr>

      <tr>
       <td>ifdisposition</td>
       <td><strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> s&#039;il y a une chaîne de disposition</td>
      </tr>

      <tr>
       <td>disposition</td>
       <td>Chaîne de disposition</td>
      </tr>

      <tr>
       <td>ifdparameters</td>
       <td><strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> s&#039;il y a un tableau de paramètres <var class="varname">dparameters</var></td>
      </tr>

      <tr>
       <td>dparameters</td>
       <td>tableau d&#039;objets où chaque objet a une propriété <code class="literal">&quot;attribute&quot;</code> et une 
        propriété <code class="literal">&quot;value&quot;</code> correspondant aux paramètres d&#039;en-têtes 
        <code class="literal">Content-disposition</code> <abbr title="Multipurpose Internet Mail Extensions">MIME</abbr>.</td>
      </tr>

      <tr>
       <td>ifparameters</td>
       <td><strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> si le tableau de paramètres existe</td>
      </tr>

      <tr>
       <td>parameters</td>
       <td>Tableau d&#039;objets où chacun a une propriété <code class="literal">&quot;attribute&quot;</code> et 
        une propriété <code class="literal">&quot;value&quot;</code>.</td>
      </tr>

      <tr>
       <td>parts</td>
       <td>Tableau d&#039;objets décrivant chaque partie
        <abbr title="Multipurpose Internet Mail Extensions">MIME</abbr> du message</td>
      </tr>

     </tbody>
    
   </table>

  </p>
  <p class="para">
   <table class="doctable table">
     <caption><strong>Type primaire de corps (peut varier suivant la bibliothèque utilisée)</strong></caption>
     
     <thead>
      <tr><th>Valeur</th><th>Type</th><th>Constante</th></tr>

     </thead>

      <tbody class="tbody">
      <tr><td>0</td><td>texte</td><td>TYPETEXT</td></tr>

      <tr><td>1</td><td>multipart</td><td>TYPEMULTIPART</td></tr>

      <tr><td>2</td><td>message</td><td>TYPEMESSAGE</td></tr>

      <tr><td>3</td><td>application</td><td>TYPEAPPLICATION</td></tr>

      <tr><td>4</td><td>audio</td><td>TYPEAUDIO</td></tr>

      <tr><td>5</td><td>image</td><td>TYPEIMAGE</td></tr>

      <tr><td>6</td><td>vidéo</td><td>TYPEVIDEO</td></tr>

      <tr><td>7</td><td>modèle</td><td>TYPEMODEL</td></tr>

      <tr><td>8</td><td>autre</td><td>TYPEOTHER</td></tr>

      </tbody>
     
   </table>

  </p>
  <p class="para">
   <table class="doctable table">
     <caption><strong>Codage de transfert (peut varier suivant la bibliothèque utilisée)</strong></caption>
     
     <thead>
      <tr><th>Valeur</th><th>Type</th><th>Constante</th></tr>

     </thead>

      <tbody class="tbody">
      <tr><td>0</td><td>7 bit</td><td>ENC7BIT</td></tr>

      <tr><td>1</td><td>8 bit</td><td>ENC8BIT</td></tr>

      <tr><td>2</td><td>Binaire</td><td>ENCBINARY</td></tr>

      <tr><td>3</td><td>Base 64</td><td>ENCBASE64</td></tr>

      <tr><td>4</td><td>Cité imprimable</td><td>ENCQUOTEDPRINTABLE</td></tr>

      <tr><td>5</td><td>Autre</td><td>ENCOTHER</td></tr>

     </tbody>
    
   </table>

  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.imap-fetchstructure-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-fetchstructure-seealso">
  <h3 class="title">Voir aussi</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.imap-fetchbody.php" class="function" rel="rdfs-seeAlso">imap_fetchbody()</a> - Retourne une section extraite du corps d'un message</span></li>
    <li><span class="function"><a href="function.imap-bodystruct.php" class="function" rel="rdfs-seeAlso">imap_bodystruct()</a> - Lit la structure d'une section du corps d'un mail</span></li>
   </ul>
  </p>
 </div>

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