mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-28 14:58:55 +00:00
c030e2adf7
- All id attributes are now xml:id - Add docbook namespace to all root elements - Replace <ulink /> with <link xlink:href /> - Minor markup fixes here and there git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@238160 c90b9560-bf6c-de11-be94-00142212c4b1
119 lines
3.8 KiB
XML
119 lines
3.8 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.6 $ -->
|
|
<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>array</type><methodname>imap_getsubscribed</methodname>
|
|
<methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>ref</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>pattern</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Gets information on the subscribeds 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>ref</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
<parameter>ref</parameter> should normally be just the server
|
|
specification as described in <function>imap_open</function>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>pattern</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Specifies where in the mailbox hierarchy to start searching.
|
|
</para>
|
|
<para>
|
|
There are two special characters you can pass as part of the
|
|
<parameter>pattern</parameter>: '*' and '%'. '*' means to return
|
|
all mailboxes. If you pass <parameter>pattern</parameter> as '*',
|
|
you will get a list of the entire mailbox hierarchy. '%' means to
|
|
return the current level only. '%' as the
|
|
<parameter>pattern</parameter> parameter will return only the top
|
|
level mailboxes; '~/mail/%' on UW_IMAPD will return every mailbox
|
|
in the ~/mail directory, but none in subfolders of that
|
|
directory.
|
|
</para>
|
|
</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>
|
|
</itemizedlist>
|
|
</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:"../../../../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
|
|
-->
|