(PHP ActiveX) 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".

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows Note: The php_com_dotnet.dll may need to be enabled inside of php.ini.

<?php

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

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Imap')
$imap = new COM("Chilkat.Imap");

// Connect to an IMAP server.
// Use TLS
$imap->Ssl = 1;
$imap->Port = 993;
$success = $imap->Connect('imap.someMailServer.com');
if ($success != 1) {
    print $imap->LastErrorText . "\n";
    exit;
}

// Login
$success = $imap->Login('admin@chilkatsoft.com','myPassword');
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.

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

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

// mboxes is a Chilkat.Mailboxes
$mboxes = $imap->ListMailboxes($refName,$wildcardedMailbox);
if ($imap->LastMethodSuccess == 0) {
    print $imap->LastErrorText . "\n";
    exit;
}

$i = 0;
while ($i < $mboxes->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();


?>