What is PhpDig?
PhpDig is a PHP MySQL based
Web Spider & Search Engine.

imap_scanmailbox
Prev	XXXI. IMAP Functions	Next

imap_scanmailbox

Name

imap_scanmailbox — Gets the names of mailboxes that contain match search criteria

Synopsis

array imap_scanmailbox(connection, ref, pattern, content); int connection: IMAP connection ID string ref: Server reference string pattern: Mailbox name search pattern string content: Mailbox content search pattern

Returns

An array of mailbox names; FALSE on error

Description

While similar to the functions imap_listmailbox() and imap_getmailboxes() , this function not only can search based on mailbox name, but can also search based on the content of the mailbox itself.

pattern can be used to filter mailbox names and has a basic wildcard usage. The pattern * to show all mailbox names including subfolders. Using % shows mailboxes on the current level only.

Version

From versions 3.0 and 4.0

Example

Example 618. Search for mailboxes containing text

<?php
$imap = imap_open("{localhost}INBOX","graeme","inferno");

// list all mailboxes containing 'hello
$boxes = imap_scanmailbox($imap, "{localhost}", "%", "hello");
for ($i=0; $i<count($boxes); $i++) {
  echo "Mailbox: $boxes[$i]<BR>\n";
}

imap_close($imap);
?>

Output:
Match found: INBOX

Prev	Home	Next
imap_reopen	Up	imap_search

PHP Functions Essential Reference. Copyright © 2002 by New Riders Publishing (Authors: Zak Greant, Graeme Merrall, Torben Wilson, Brett Michlitsch). This material may be distributed only subject to the terms and conditions set forth in the Open Publication License, v1.0 or later (the latest version is presently available at http://www.opencontent.org/openpub/). The authors of this book have elected not to choose any options under the OPL. This online book was obtained from http://www.fooassociates.com/phpfer/ and is designed to provide information about the PHP programming language, focusing on PHP version 4.0.4 for the most part. The information is provided on an as-is basis, and no warranty or fitness is implied. All persons and entities shall have neither liability nor responsibility to any person or entity with respect to any loss or damage arising from the information contained in this book.