imap-getsubscribed.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 34892f82742329af7e7b4b22be6ad21418fd9768 Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.imap-getsubscribed" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>imap_getsubscribed</refname>
  <refpurpose>Lista todas las carpetas de correo suscritas</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>array</type><type>false</type></type><methodname>imap_getsubscribed</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 todas las carpetas de correo suscritas.
  </para>
  <para>
   <function>imap_getsubscribed</function> es idéntico a
   <function>imap_getmailboxes</function>, pero solo devuelve las
   carpetas de correo a las que el usuario está suscrito.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &imap.imap-parameter.imap;
    <varlistentry>
     <term><parameter>reference</parameter></term>
     <listitem>
      <para>
       <parameter>reference</parameter> debe 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 las
   carpetas de correo. Cada objeto posee un atributo de
   <parameter>name</parameter>, que contiene el nombre completo
   de la carpeta 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>
     <simpara>
      <constant>LATT_NOINFERIORS</constant> - Esta carpeta de correo
      no tiene "hijos" (no hay más carpetas de correo debajo de esta).
     </simpara>
    </listitem>
   <listitem>
     <simpara>
      <constant>LATT_NOSELECT</constant> - Esto es solo un contenedor,
      no una carpeta de correo (no se puede abrir).
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      <constant>LATT_MARKED</constant> - Esta carpeta de correo está marcada.
      Utilizado únicamente con UW-IMAPD.
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      <constant>LATT_UNMARKED</constant> - Esta carpeta de correo no está
      marcada. Utilizado únicamente con UW-IMAPD.
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      <constant>LATT_REFERRAL</constant> - Este contenedor tiene una referencia a una carpeta de correo remota.
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      <constant>LATT_HASCHILDREN</constant> - Esta carpeta de correo tiene inferiores seleccionables.
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      <constant>LATT_HASNOCHILDREN</constant> - Esta carpeta de correo no tiene inferiores seleccionables.
     </simpara>
    </listitem>
   </itemizedlist>
   La función 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>

</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
-->