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

imap_listmailbox
Prev	XXXI. IMAP Functions	Next

imap_listmailbox

Name

imap_listmailbox — Gets a list of all mailboxes

Synopsis

array imap_listmailbox(connection, ref, pattern); int connection: IMAP connection ID string ref: Server reference string pattern: Search pattern

Returns

An array of mailbox names; FALSE on error

Description

This functions returns an array whose elements contain the names of the mailboxes on the specified IMAP server.

ref is the name of the IMAP server. Generally this is the same as the host name specified in imap_open() . 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 606. Print all the mailbox names

<?php
// open a connection
$imap = imap_open("{localhost}mbox","graeme","inferno");

// list all mailboxes
$boxes = imap_listmailbox($imap, "{localhost}", "*");
for ($i=0; $i<count($boxes); $i++) {
  echo "Mailbox: $boxes[$i]<BR>\n";
}
?>

Output:
Mailbox: {localhost}INBOX
Mailbox: {localhost}test_mailbox

Prev	Home	Next
imap_last_error	Up	imap_mailboxmsginfo

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.