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

imap_getmailboxes
Prev	XXXI. IMAP Functions	Next

imap_getmailboxes

Name

imap_getmailboxes — Gets information for each mailbox.

Synopsis

object imap_getmailboxes(connection, ref, pattern); int connection: IMAP connection ID string ref: Server reference string pattern: Search pattern

Returns

An array of objects with mailbox information.

Description

This function gets an array of objects, each with the attributes of name, delimiter, attributes. The delimiter object shows the delimiter for the part of the hierarchy this mailbox is in. The attributes object contains contains a bitmask of mailbox attributes:

`LATT_NOINFERIORS`	This mailbox has no children
`LATT_NOSELECT`	Container only, not a mailbox
`LATT_MARKED`	Mailbox is marked (UW_IMAP only)
`LATT_UNMARKED`	Mailbox is not marked (UW_IMAP only)

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

Version

From versions 3.0.12

Example

Example 604. Print all mailbox names

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

$mailbox = "test_mailbox";

// create mailbox
imap_createmailbox($imap,"{localhost}$mailbox");

// list all mailboxes
$boxes = imap_getmailboxes($imap, "{localhost}", "test_%");

foreach($boxes as $val) {
    echo "Name: ", $val->name, "<BR>\n";
    echo "Delimiter: ", $val->delimiter, "<BR>\n";
    echo "Attributes: ", $val->attributes, "<br>\n\n";
}

// remove mailbox
imap_deletemailbox($imap,"{localhost}$mailbox");

imap_close($imap);
?>

Output:
Name: {localhost}test_mailbox
Delimiter: /
Attributes: 1

Prev	Home	Next
imap_fetchstructure	Up	imap_last_error

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.