php man page for imap_listscan

Query: imap_listscan

OS: php

Section: 3

Format: Original Unix Latex Style Formatted with HTML and a Horizontal Scroll Bar

IMAP_LISTSCAN(3)							 1							  IMAP_LISTSCAN(3)

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

SYNOPSIS
array imap_listscan (resource $imap_stream, string $ref, string $pattern, string $content)
DESCRIPTION
Returns an array containing the names of the mailboxes that have $content in the text of the mailbox. This function is similar to imap_listmailbox(3), but it will additionally check for the presence of the string $content inside the mailbox data.
PARAMETERS
o $ imap_stream -An IMAP stream returned by imap_open(3). o $ref -$ref should normally be just the server specification as described in imap_open(3) o $pattern -Specifies where in the mailbox hierarchy to start searching.There are two special characters you can pass as part of the $pat- tern: ' *' 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_IMAPD will return every mailbox in the ~/mail directory, but none in subfolders of that directory. o $content - The searched string
RETURN VALUES
Returns an array containing the names of the mailboxes that have $content in the text of the mailbox.
SEE ALSO
imap_listmailbox(3), imap_search(3). PHP Documentation Group IMAP_LISTSCAN(3)
Related Man Pages
cyrus-ipurge(8) - debian
ipurge(8) - debian
imap_append(3) - php
imap_getmailboxes(3) - php
imap_set_quota(3) - php
Similar Topics in the Unix Linux Community
How to separate file content
file content in an array PERL
problem in sending out content in unix
To compare the content of two text files
Extract lines that match a pattern