php-doc-en/reference/imap/functions/imap-listscan.xml
Markus Fischer 2d23ddfe59 - Sync most protos with current source.
- Move alised documented to their real function name and document what an
  alias is.


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@99005 c90b9560-bf6c-de11-be94-00142212c4b1
2002-10-09 14:55:05 +00:00

51 lines
1.7 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.imap-listscan">
<refnamediv>
<refname>imap_listscan</refname>
<refpurpose>
Read the list of mailboxes, takes a string to search for in the
text of the mailbox
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>imap_listscan</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>
<methodparam><type>string</type><parameter>content</parameter></methodparam>
</methodsynopsis>
<para>
Returns an array containing the names of the mailboxes that have
<parameter>content</parameter> in the text of the mailbox.
This function is similar to <function>imap_listmailbox</function>,
but it will additionally check for the presence of the string
<parameter>content</parameter> inside the mailbox data.
See <function>imap_getmailboxes</function> for a description
of <parameter>ref</parameter> and <parameter>pattern</parameter>.
</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
-->