List IMAP Mailboxes

List the mailboxes available within an IMAP account.

Download Chilkat Perl Module

use chilkat;

$imap = new chilkat::CkImap();

# Anything unlocks the component and begins a fully-functional 30-day trial.
$success = $imap->UnlockComponent("Anything for 30-day trial");
if ($success != 1) {
    print $imap->lastErrorText() . "\n";
    exit;
}

# Connect to an IMAP server.
$success = $imap->Connect("mail.chilkatsoft.com");
if ($success != 1) {
    print $imap->lastErrorText() . "\n";
    exit;
}

# Login
$success = $imap->Login('admin@chilkatsoft.com',"*myPassword5*");
if ($success != 1) {
    print $imap->lastErrorText() . "\n";
    exit;
}

# The ListMailboxes method returns a Mailboxes object
# that contains the collection of mailboxes.
# It accepts two arguments: a refName and a wildcardedMailbox.

$refName = "";
# refName is usually set to an empty string.
# A non-empty reference name argument is the name of a mailbox or a level of
# mailbox hierarchy, and indicates the context in which the mailbox
# name is interpreted.

# Select all mailboxes matching this pattern:
$wildcardedMailbox = "*";

$mboxes = $imap->ListMailboxes($refName,$wildcardedMailbox);
if ($mboxes == null ) {
    print $imap->lastErrorText() . "\n";
    exit;
}

for ($i = 0; $i <= $mboxes->get_Count() - 1; $i++) {
    print $mboxes->getName($i) . "\r\n";
}

# Sample output looks like this:
# INBOX.vendors.shareit
# INBOX.oldSupport
# INBOX.vendors.paypal
# INBOX.sales
# INBOX.lists
# INBOX.Drafts
# INBOX.vendors.dell
# INBOX.Trash
# INBOX.invoiceRequests
# INBOX.purchases
# INBOX.vendors.inMotion
# INBOX.oldEmail
# INBOX.vendors
# INBOX.lists.python
# INBOX.vendors.myhosting
# INBOX.Templates
# INBOX.friends
# INBOX.bounceSamples
# INBOX.lists.ruby
# INBOX.vendors.peer1
# INBOX.Sent
# INBOX.Junk
# INBOX

# Disconnect from the IMAP server.
$imap->Disconnect();