imap-getmailboxes.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.imap-getmailboxes" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>imap_getmailboxes</refname>
  <refpurpose>Read the list of mailboxes, returning detailed information on each one</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>
   Gets information on the mailboxes.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &imap.imap-parameter.imap;
    <varlistentry>
     <term><parameter>reference</parameter></term>
     <listitem>
      <para>
       <parameter>reference</parameter> should normally be just the server
       specification as described in <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>
   Returns an array of objects containing mailbox information. Each
   object has the attributes <parameter>name</parameter>, specifying
   the full name of the mailbox; <parameter>delimiter</parameter>,
   which is the hierarchy delimiter for the part of the hierarchy
   this mailbox is in; and
   <parameter>attributes</parameter>. <parameter>Attributes</parameter>
   is a bitmask that can be tested against:
   <itemizedlist>
    <listitem>
     <para>
      <constant>LATT_NOINFERIORS</constant> - This mailbox not contains, and may not contain any
      "children" (there are no mailboxes below this one). Calling 
      <function>imap_createmailbox</function> will not work on this mailbox.
     </para>
    </listitem>
   <listitem>
     <para>
      <constant>LATT_NOSELECT</constant> - This is only a container,
      not a mailbox - you cannot open it.
     </para>
    </listitem>
    <listitem>
     <para>
      <constant>LATT_MARKED</constant> - This mailbox is marked. This means that it may 
      contain new messages since the last time it was checked. Not provided by all IMAP
      servers.
     </para>
    </listitem>
    <listitem>
     <para>
      <constant>LATT_UNMARKED</constant> - This mailbox is not marked, does not contain new
      messages.  If either <constant>MARKED</constant> or <constant>UNMARKED</constant> is
      provided, you can assume the IMAP server  supports this feature for this mailbox.
     </para>
    </listitem>
    <listitem>
     <para>
      <constant>LATT_REFERRAL</constant> - This container has a referral to a remote mailbox.
     </para>
    </listitem>
    <listitem>
     <para>
      <constant>LATT_HASCHILDREN</constant> - This mailbox has selectable inferiors.
     </para>
    </listitem>
    <listitem>
     <para>
      <constant>LATT_HASNOCHILDREN</constant> - This mailbox has no selectable inferiors.
     </para>
    </listitem>
   </itemizedlist>
   The function returns &false; on failure.
  </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><function>imap_getmailboxes</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
$mbox = imap_open("{imap.example.org}", "username", "password", OP_HALFOPEN)
      or die("can't connect: " . 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 failed: " . 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
-->