<?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-lsub.php',
    1 => 'imap_lsub',
    2 => 'Lista todas las carpetas de correo registradas',
  ),
  'up' => 
  array (
    0 => 'ref.imap.php',
    1 => 'Funciones IMAP',
  ),
  'prev' => 
  array (
    0 => 'function.imap-listsubscribed.php',
    1 => 'imap_listsubscribed',
  ),
  'next' => 
  array (
    0 => 'function.imap-mail.php',
    1 => 'imap_mail',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'es',
    'path' => 'reference/imap/functions/imap-lsub.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.imap-lsub" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">imap_lsub</h1>
  <p class="verinfo">(PHP 4, PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">imap_lsub</span> &mdash; <span class="dc-title">Lista todas las carpetas de correo registradas</span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.imap-lsub-description">
  <h3 class="title">Descripción</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>imap_lsub</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">$reference</code></span>, <span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$pattern</code></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">
   Recupera un array que contiene todas las carpetas de correo a las que se ha suscrito.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.imap-lsub-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">reference</code></dt>
     <dd>
      <p class="para">
       <code class="parameter">reference</code> debería ser solo el servidor en la forma descrita en <span class="function"><a href="function.imap-open.php" class="function">imap_open()</a></span>
      </p>
      <div class="warning"><strong class="warning">Advertencia</strong><p class="simpara">
Pasar datos no confiables a este parámetro es <em>inseguro</em>, a menos que
<a href="imap.configuration.php#ini.imap.enable-insecure-rsh" class="link">imap.enable_insecure_rsh</a> esté desactivado.
</p></div>
     </dd>
    
    
     <dt><code class="parameter">pattern</code></dt>
     <dd>
      <p class="para">Especifica en qué parte de la jerarquía del buzón
comenzar la búsqueda.</p><p class="para">Hay dos caracteres especiales que se pueden
pasar como parte del <code class="parameter">pattern</code>:
&#039;<code class="literal">*</code>&#039; y &#039;<code class="literal">%</code>&#039;.
&#039;<code class="literal">*</code>&#039; significa devolver todos los buzones. Si se pasa
<code class="parameter">pattern</code> como &#039;<code class="literal">*</code>&#039;, se
obtendrá una lista de toda la jerarquía del buzón.
&#039;<code class="literal">%</code>&#039;
significa devolver solo el nivel actual.
&#039;<code class="literal">%</code>&#039; como parámetro <code class="parameter">pattern</code>
devolverá solo los buzones de nivel superior;
&#039;<code class="literal">~/mail/%</code>&#039; en <code class="literal">UW_IMAPD</code> devolverá cada buzón en el directorio <var class="filename">~/mail</var>, pero ninguno en las subcarpetas de ese directorio.</p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.imap-lsub-returnvalues">
  <h3 class="title">Valores devueltos</h3>
  <p class="para">
   Devuelve un array que contiene todas las carpetas de correo suscritas,  o <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> si ocurre un error.
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.imap-lsub-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-lsub-seealso">
  <h3 class="title">Ver también</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.imap-list.php" class="function" rel="rdfs-seeAlso">imap_list()</a> - Lee la lista de buzones de correo</span></li>
    <li><span class="function"><a href="function.imap-getmailboxes.php" class="function" rel="rdfs-seeAlso">imap_getmailboxes()</a> - Lista los buzones de correo y devuelve los detalles de cada uno</span></li>
   </ul>
  </p>
 </div>

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