<?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 => 'es',
  ),
  'this' => 
  array (
    0 => 'function.imap-fetchstructure.php',
    1 => 'imap_fetchstructure',
    2 => 'Lee la estructura de un mensaje',
  ),
  'up' => 
  array (
    0 => 'ref.imap.php',
    1 => 'Funciones 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' => 'es',
    '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">Lee la estructura de un mensaje</span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.imap-fetchstructure-description">
  <h3 class="title">Descripción</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> lee la estructura del mensaje
   <code class="parameter">msg_number</code>.
  </p>
 </div>

 <div class="refsect1 parameters" id="refsect1-function.imap-fetchstructure-parameters">
  <h3 class="title">Parámetros</h3>
  <p class="para">
   <dl>
    <dt>
<code class="parameter">imap</code></dt><dd><p class="para">Una instancia 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">
       El número del mensaje
      </p>
     </dd>
    
    
     <dt><code class="parameter">flags</code></dt>
     <dd>
      <p class="para">
       Este parámetro opcional tiene una sola opción,
       <strong><code><a href="imap.constants.php#constant.ft-uid">FT_UID</a></code></strong>, que solicita a la función tratar
       el argumento <code class="parameter">message_num</code> como un
       <code class="literal">UID</code>.
      </p>
     </dd>
    
   </dl>
  </p>
 </div>

 <div class="refsect1 returnvalues" id="refsect1-function.imap-fetchstructure-returnvalues">
  <h3 class="title">Valores devueltos</h3>
  <p class="para">
   Devuelve un objeto cuyas propiedades se listan en la tabla
   siguiente,  o <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> si ocurre un error.
  </p>
  <p class="para">
   <table class="doctable table">
    <caption><strong>
     Objeto devuelto por <span class="function"><strong>imap_fetchstructure()</strong></span>
    </strong></caption>
    
     <tbody class="tbody">
      <tr>
       <td>type</td>
       <td>Tipo primario de cuerpo</td>
      </tr>

      <tr>
       <td>encoding</td>
       <td>Codificación de transferencia del cuerpo</td>
      </tr>

      <tr>
       <td>ifsubtype</td>
       <td><strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> si hay una cadena de subtipo</td>
      </tr>

      <tr>
       <td>subtype</td>
       <td>subtipo <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> si hay una cadena de descripción</td>
      </tr>

      <tr>
       <td>description</td>
       <td>Cadena de descripción del contenido</td>
      </tr>

      <tr>
       <td>ifid</td>
       <td><strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> si hay una cadena de identificación</td>
      </tr>

      <tr>
       <td>id</td>
       <td>Cadena de identificación</td>
      </tr>

      <tr>
       <td>lines</td>
       <td>Número de líneas</td>
      </tr>

      <tr>
       <td>bytes</td>
       <td>Número de bytes</td>
      </tr>

      <tr>
       <td>ifdisposition</td>
       <td><strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> si hay una cadena de disposición</td>
      </tr>

      <tr>
       <td>disposition</td>
       <td>Cadena de disposición</td>
      </tr>

      <tr>
       <td>ifdparameters</td>
       <td><strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> si hay un array de parámetros <var class="varname">dparameters</var></td>
      </tr>

      <tr>
       <td>dparameters</td>
       <td>array de objetos donde cada objeto tiene una propiedad <code class="literal">&quot;attribute&quot;</code> y una
        propiedad <code class="literal">&quot;value&quot;</code> correspondiente a los parámetros de encabezado
        <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 el array de parámetros existe</td>
      </tr>

      <tr>
       <td>parameters</td>
       <td>Array de objetos donde cada uno tiene una propiedad <code class="literal">&quot;attribute&quot;</code> y
        una propiedad <code class="literal">&quot;value&quot;</code>.</td>
      </tr>

      <tr>
       <td>parts</td>
       <td>Array de objetos que describen cada parte
        <abbr title="Multipurpose Internet Mail Extensions">MIME</abbr> del mensaje</td>
      </tr>

     </tbody>
    
   </table>

  </p>
  <p class="para">
   <table class="doctable table">
     <caption><strong>Tipo primario de cuerpo (puede variar según la biblioteca utilizada)</strong></caption>
     
     <thead>
      <tr><th>Valor</th><th>Tipo</th><th>Constante</th></tr>

     </thead>

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

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

      <tr><td>2</td><td>mensaje</td><td>TYPEMESSAGE</td></tr>

      <tr><td>3</td><td>aplicación</td><td>TYPEAPPLICATION</td></tr>

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

      <tr><td>5</td><td>imagen</td><td>TYPEIMAGE</td></tr>

      <tr><td>6</td><td>video</td><td>TYPEVIDEO</td></tr>

      <tr><td>7</td><td>modelo</td><td>TYPEMODEL</td></tr>

      <tr><td>8</td><td>otro</td><td>TYPEOTHER</td></tr>

      </tbody>
     
   </table>

  </p>
  <p class="para">
   <table class="doctable table">
     <caption><strong>Codificación de transferencia (puede variar según la biblioteca utilizada)</strong></caption>
     
     <thead>
      <tr><th>Valor</th><th>Tipo</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>Binario</td><td>ENCBINARY</td></tr>

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

      <tr><td>4</td><td>Citado imprimible</td><td>ENCQUOTEDPRINTABLE</td></tr>

      <tr><td>5</td><td>Otro</td><td>ENCOTHER</td></tr>

     </tbody>
    
   </table>

  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.imap-fetchstructure-changelog">
  <h3 class="title">Historial de cambios</h3>
  <table class="doctable informaltable">
   
    <thead>
     <tr>
      <th>Versión</th>
      <th>Descripción</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
 <td>8.1.0</td>
 <td>
  El parámetro <code class="parameter">imap</code> ahora espera una instancia de <span class="classname"><a href="class.imap-connection.php" class="classname">IMAP\Connection</a></span>;
  anteriormente, se esperaba un <span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span> <code class="literal">imap</code> válido.
 </td>
</tr>

    </tbody>
   
  </table>

 </div>


 <div class="refsect1 seealso" id="refsect1-function.imap-fetchstructure-seealso">
  <h3 class="title">Ver también</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> - Devuelve una secci&oacute;n extra&iacute;da del cuerpo de un mensaje</span></li>
    <li><span class="function"><a href="function.imap-bodystruct.php" class="function" rel="rdfs-seeAlso">imap_bodystruct()</a> - Lee la estructura de una secci&oacute;n del cuerpo de un correo electr&oacute;nico</span></li>
   </ul>
  </p>
 </div>

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