PHP Extension

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". PHP Extension

<?php

include("chilkat.php");

$success = false;

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

$imap = new CkImap();

// Connect to an IMAP server.
// Use TLS
$imap->put_Ssl(true);
$imap->put_Port(993);
$success = $imap->Connect('imap.example.com');
if ($success == false) {
    print $imap->lastErrorText() . "\n";
    exit;
}

// Login
$success = $imap->Login('admin@chilkatsoft.com','myPassword');
if ($success == false) {
    print $imap->lastErrorText() . "\n";
    exit;
}

// Get the list of mailboxes.
$refName = '';
$wildcardedMailbox = '*';
$subscribed = false;

$mboxes = new CkMailboxes();
$success = $imap->MbxList($subscribed,$refName,$wildcardedMailbox,$mboxes);
if ($success == false) {
    print $imap->lastErrorText() . "\n";
    exit;
}

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

// 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.
$success = $imap->Disconnect();

?>