mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-21 03:18:55 +00:00
df987c11c9
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@205771 c90b9560-bf6c-de11-be94-00142212c4b1
70 lines
1.9 KiB
XML
70 lines
1.9 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.6 $ -->
|
|
<refentry id="function.imap-list">
|
|
<refnamediv>
|
|
<refname>imap_list</refname>
|
|
<refpurpose>Read the list of mailboxes</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>array</type><methodname>imap_list</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>
|
|
Returns an array containing the names of the mailboxes.
|
|
See <function>imap_getmailboxes</function> for a description
|
|
of <parameter>ref</parameter> and <parameter>pattern</parameter>.
|
|
</para>
|
|
<para>
|
|
<example>
|
|
<title><function>imap_list</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_list($mbox, "{imap.example.org}", "*");
|
|
if (is_array($list)) {
|
|
foreach ($list as $val) {
|
|
echo imap_utf7_decode($val) . "<br />\n";
|
|
}
|
|
} else {
|
|
echo "imap_list failed: " . imap_last_error() . "\n";
|
|
}
|
|
|
|
imap_close($mbox);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
<para>
|
|
See also: <function>imap_getmailboxes</function>.
|
|
</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
|
|
-->
|