PHP Extension

List and Inspect IMAP Mailboxes

Demonstrates the Chilkat Mailboxes class, a read-only result collection populated by Imap.MbxList. This example connects to an IMAP server, lists all mailboxes into a Mailboxes object, then loops from 0 to Count - 1 and inspects each mailbox: its name (GetName), whether it is selectable (IsSelectable) or marked (IsMarked), whether it may have child mailboxes (HasInferiors), a specific flag (HasFlag), and all of its flags both as a string (GetFlags) and individually (GetNumFlags with GetNthFlag). Finally it looks up a mailbox by name with GetMailboxIndex.

Background: Mailboxes is how an application renders an IMAP folder tree. Because it is read-only, you never construct it directly — you receive it from MbxList and read its entries by index. Mailbox names come back as normal Unicode text (Chilkat handles the modified UTF-7 / IMAP UTF-8 encoding at the protocol level), so a name from GetName can be passed straight to methods like SelectMailbox. Note that HasInferiors is often true: it means children exist or may be created, which is not the same as \HasChildren.

Chilkat PHP Extension Downloads

Download Chilkat for PHP Extension

PHP Extension

<?php

include("chilkat.php");

$success = false;

//  Demonstrates using Chilkat.Imap to populate a Mailboxes object (via MbxList), then looping
//  over the collection to inspect each mailbox's name and attributes.  Mailboxes is a read-only
//  result collection -- applications inspect the entries but do not add, remove, or modify them.

$imap = new CkImap();

$imap->put_Ssl(true);
$imap->put_Port(993);

$success = $imap->Connect('imap.example.com');
if ($success == false) {
    print $imap->lastErrorText() . "\n";
    exit;
}

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

//  Populate a Mailboxes object with the full list of mailboxes.  The first argument requests
//  all mailboxes (not subscribed-only) and "*" matches any name.
$subscribedOnly = false;
$mailboxes = new CkMailboxes();
$success = $imap->MbxList($subscribedOnly,'','*',$mailboxes);
if ($success == false) {
    print $imap->lastErrorText() . "\n";
    exit;
}

//  Loop over each mailbox in the returned collection.
$n = $mailboxes->get_Count();
print 'Number of mailboxes: ' . $n . "\n";

for ($i = 0; $i <= $n - 1; $i++) {
    $name = $mailboxes->getName($i);
    print 'Mailbox: ' . $name . "\n";

    //  Whether the mailbox can be selected or examined for message access.
    if ($mailboxes->IsSelectable($i)) {
        print '  Selectable: yes' . "\n";
    }
    else {
        print '  Selectable: no' . "\n";
    }

    //  Whether the server marked the mailbox as possibly having new messages.
    if ($mailboxes->IsMarked($i)) {
        print '  Marked: yes' . "\n";
    }

    //  Whether the mailbox has, or may contain, child mailboxes.
    if ($mailboxes->HasInferiors($i)) {
        print '  May have child mailboxes' . "\n";
    }

    //  Check for a specific flag by name.  Include the leading backslash for a system flag;
    //  in CkScript a literal backslash in a string is written as "\\".
    if ($mailboxes->HasFlag($i,'\\HasChildren')) {
        print '  Has child mailboxes' . "\n";
    }

    //  Get all of the mailbox's flags as a comma-separated string.
    $flags = $mailboxes->getFlags($i);
    print '  Flags: ' . $flags . "\n";

    //  Iterate the flags individually.
    $numFlags = $mailboxes->GetNumFlags($i);

    for ($j = 0; $j <= $numFlags - 1; $j++) {
        $flag = $mailboxes->getNthFlag($i,$j);
        print '    Flag ' . $j . ': ' . $flag . "\n";
    }

}

//  Look up a mailbox by name.  Returns -1 if no mailbox with that name is present.
$sentIndex = $mailboxes->GetMailboxIndex('Sent');
if ($sentIndex >= 0) {
    print 'The Sent mailbox is at index ' . $sentIndex . "\n";
}

$success = $imap->Disconnect();
if ($success == false) {
    print $imap->lastErrorText() . "\n";
    exit;
}


?>