mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 14:28:56 +00:00
122 lines
3.7 KiB
XML
122 lines
3.7 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.imap-getsubscribed" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>imap_getsubscribed</refname>
|
|
<refpurpose>List all the subscribed mailboxes</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type class="union"><type>array</type><type>false</type></type><methodname>imap_getsubscribed</methodname>
|
|
<methodparam><type>resource</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 about the subscribed mailboxes.
|
|
</para>
|
|
<para>
|
|
Identical to <function>imap_getmailboxes</function>, except that it only
|
|
returns mailboxes that the user is subscribed to.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
&imap.imap-stream.description;
|
|
<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>
|
|
<simpara>
|
|
<constant>LATT_NOINFERIORS</constant> - This mailbox has no
|
|
"children" (there are no mailboxes below this one).
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<constant>LATT_NOSELECT</constant> - This is only a container,
|
|
not a mailbox - you cannot open it.
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<constant>LATT_MARKED</constant> - This mailbox is marked.
|
|
Only used by UW-IMAPD.
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<constant>LATT_UNMARKED</constant> - This mailbox is not marked.
|
|
Only used by UW-IMAPD.
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<constant>LATT_REFERRAL</constant> - This container has a referral to a remote mailbox.
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<constant>LATT_HASCHILDREN</constant> - This mailbox has selectable inferiors.
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<constant>LATT_HASNOCHILDREN</constant> - This mailbox has no selectable inferiors.
|
|
</simpara>
|
|
</listitem>
|
|
</itemizedlist>
|
|
The function returns &false; on failure.
|
|
</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
|
|
-->
|