imap-getmailboxes.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 34892f82742329af7e7b4b22be6ad21418fd9768 Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.imap-getmailboxes" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>imap_getmailboxes</refname>
  <refpurpose>Lista los buzones de correo y devuelve los detalles de cada uno</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>array</type><type>false</type></type><methodname>imap_getmailboxes</methodname>
   <methodparam><type>IMAP\Connection</type><parameter>imap</parameter></methodparam>
   <methodparam><type>string</type><parameter>reference</parameter></methodparam>
   <methodparam><type>string</type><parameter>pattern</parameter></methodparam>
  </methodsynopsis>
  <para>
   Lista los buzones de correo.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &imap.imap-parameter.imap;
    <varlistentry>
     <term><parameter>reference</parameter></term>
     <listitem>
      <para>
       <parameter>reference</parameter> debería ser solo el servidor
       en la forma descrita en <function>imap_open</function>
      </para>
      &imap.mailboxname.insecure;
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>pattern</parameter></term>
     <listitem>
      &imap.pattern;
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Devuelve un array de objetos que contienen información sobre los
   buzones de correo. Cada objeto posee un atributo de
   <parameter>name</parameter>, que contiene el nombre completo
   del buzón de correo, <parameter>delimiter</parameter> que
   es el delimitador jerárquico y <parameter>attributes</parameter>.
   <parameter>attributes</parameter> es una máscara de bits, que contiene :
   <itemizedlist>
    <listitem>
     <para>
      <constant>LATT_NOINFERIORS</constant> - Este buzón de correo
      no tiene "hijos" (no hay más buzones de correo
      debajo de este) y no puede contener ninguno. Una llamada a la
      función <function>imap_createmailbox</function> no funcionará
      en este buzón.
     </para>
    </listitem>
    <listitem>
     <para>
      <constant>LATT_NOSELECT</constant> - Esto es solo un contenedor,
      no un buzón de correo (no se puede abrir).
     </para>
    </listitem>
    <listitem>
     <para>
      <constant>LATT_MARKED</constant> - Este buzón de correo está marcado.
      Esto significa que puede contener nuevos mensajes desde la última
      vez que fue verificado. Este marcador no se proporciona con todos los
      servidores IMAP.
     </para>
    </listitem>
    <listitem>
     <para>
      <constant>LATT_UNMARKED</constant> - Este buzón de correo no está
      marcado y no contiene nuevos mensajes. Si
      <constant>MARKED</constant> o <constant>UNMARKED</constant> se proporciona,
      se puede asumir que el servidor IMAP soporta esta funcionalidad
      para este buzón de correo.
     </para>
    </listitem>
    <listitem>
     <para>
      <constant>LATT_REFERRAL</constant> - Este contenedor tiene una referencia a un buzón de correo remoto.
     </para>
    </listitem>
    <listitem>
     <para>
      <constant>LATT_HASCHILDREN</constant> - Este buzón de correo tiene inferiores seleccionables.
     </para>
    </listitem>
    <listitem>
     <para>
      <constant>LATT_HASNOCHILDREN</constant> - Este buzón de correo no tiene inferiores seleccionables.
     </para>
    </listitem>
   </itemizedlist>
   Devuelve &false; en caso de fallo.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     &imap.changelog.imap-param;
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Ejemplo con <function>imap_getmailboxes</function></title>
    <programlisting role="php">
<![CDATA[
<?php
$mbox = imap_open("{imap.example.org}", "username", "password", OP_HALFOPEN)
      or die("Conexión imposible: " . imap_last_error());

$list = imap_getmailboxes($mbox, "{imap.example.org}", "*");
if (is_array($list)) {
    foreach ($list as $key => $val) {
        echo "($key) ";
        echo imap_utf7_decode($val->name) . ",";
        echo "'" . $val->delimiter . "',";
        echo $val->attributes . "<br />\n";
    }
} else {
    echo "imap_getmailboxes ha fallado: " . imap_last_error() . "\n";
}

imap_close($mbox);
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>imap_getsubscribed</function></member>
   </simplelist>
  </para>
 </refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->