PHP

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 Downloads

Download Chilkat for PHP

Chilkat2 PHP

<?php

use Chilkat2\Imap;
use Chilkat2\Mailboxes;

// 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 Imap();

$imap->Ssl = true;
$imap->Port = 993;

try {
    $imap->Connect('imap.example.com');

    $imap->Login('user@example.com', 'myPassword');

    // 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 Mailboxes();
    $imap->MbxList($subscribedOnly, '', '*', $mailboxes);
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}

// Loop over each mailbox in the returned collection.
$n = $mailboxes->Count;
echo 'Number of mailboxes: ', $n, "\n";

for ($i = 0; $i < $n; $i++) {
    $name = $mailboxes->GetName($i);
    echo 'Mailbox: ', $name, "\n";

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

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

    // Whether the mailbox has, or may contain, child mailboxes.
    if ($mailboxes->HasInferiors($i)) {
        echo "  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')) {
        echo "  Has child mailboxes\n";
    }

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

    // Iterate the flags individually.
    $numFlags = $mailboxes->GetNumFlags($i);
    for ($j = 0; $j < $numFlags; $j++) {
        $flag = $mailboxes->GetNthFlag($i, $j);
        echo '    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) {
    echo 'The Sent mailbox is at index ', $sentIndex, "\n";
}

try {
    $imap->Disconnect();
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}