imap_listscan()

imap_listscan - Returns the list of mailboxes that matches the given text

Syntax

array imap_listscan (resource $imap_stream, string $ref, string $pattern, string $content)

Arguments

• imap_stream - An IMAP stream returned by imap_open().
• ref - ref should normally be just the server specification as described in imap_open()
• pattern - Specifies where in the mailbox hierarchy to start searching. There are two special characters you can pass as part of the pattern : \' *\' and \' %\'. \' *\' means to return all mailboxes. If you pass pattern as \' *\', you will get a list of the entire mailbox hierarchy. \' %\' means to return the current level only. \' %\' as the pattern parameter will return only the top level mailboxes; \' ~/mail/%\' on UW_IMAPDwill return every mailbox in the ~/maildirectory, but none in subfolders of that directory.
• content - The searched string

Description

Returns an array containing the names of the mailboxes that have content in the text of the mailbox.

Version

PHP 4, 5

Return value

Returns an array containing the names of the mailboxes that have content in the text of the mailbox.