List IMAP Mailboxes with Reference

Demonstrates how to list all sub-mailboxes within a specified context. In this case, we list all mailboxes under "INBOX.vendors".

Download 32-bit Chilkat IMAP ActiveX (.msi)

Download All 32-bit Chilkat ActiveX Components (.zip)

Download All 64-bit Chilkat ActiveX Components (.zip)

<?php

$imap = new COM("Chilkat.Imap");

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

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

//  Login
$success = $imap->Login('admin@chilkatsoft.com','*myPassword5*');
if ($success != true) {
    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.

//  List all mailboxes under INBOX.vendors
$refName = 'INBOX.vendors';

//  Select all mailboxes matching this pattern:
$wildcardedMailbox = '*';

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

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

//  Sample output looks like this:
//  INBOX.vendors.shareit
//  INBOX.vendors.paypal
//  INBOX.vendors.dell
//  INBOX.vendors.inMotion
//  INBOX.vendors.myhosting
//  INBOX.vendors.peer1

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


?>