(PHP ActiveX) Subscribe to Mailboxes and List Subscribed Mailboxes

Demonstrates how to list subscribed mailboxes, and unsubscribe/subscribe to a mailbox.

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('myLogin','myPassword');
if ($success != 1) {
    print $imap->LastErrorText . "\n";
    exit;
}

// First examine the already subscribed mailboxes.
$refName = '';
$wildcardedMailbox = '*';

// Alternatively, the ListMailboxes method can be called to list all mailboxes (both subscribed and unsubscribed).
// mboxes is a Chilkat.Mailboxes
$mboxes = $imap->ListSubscribed($refName,$wildcardedMailbox);
if ($imap->LastMethodSuccess != 1) {
    print $imap->LastErrorText . "\n";
    exit;
}

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

print '----' . "\n";

// Sample output.

// INBOX
// INBOX/recent
// INBOX/misc
// INBOX/misc/solutions
// ...
// Outbox
// Deleted Items
// Sent Items
// Drafts
// Junk E-mail
// Trash
// Sent
// Templates

// Let's unsubscribe to "INBOX/misc/solutions".
$success = $imap->Unsubscribe('INBOX/misc/solutions');
if ($success != 1) {
    print $imap->LastErrorText . "\n";
    exit;
}

// Get the list of subscribed mailboxes again to verify that "INBOX/misc/solutions" is missing.
// mboxes is a Chilkat.Mailboxes
$mboxes = $imap->ListSubscribed('','INBOX/misc*');
if ($imap->LastMethodSuccess != 1) {
    print $imap->LastErrorText . "\n";
    exit;
}

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

print '----' . "\n";

// Re-subscribe to "INBOX/misc/solutions".
$success = $imap->Subscribe('INBOX/misc/solutions');
if ($success != 1) {
    print $imap->LastErrorText . "\n";
    exit;
}

// Get the list of subscribed mailboxes again to verify that "INBOX/misc/solutions" is back in the list.
// mboxes is a Chilkat.Mailboxes
$mboxes = $imap->ListSubscribed('','INBOX/misc*');
if ($imap->LastMethodSuccess != 1) {
    print $imap->LastErrorText . "\n";
    exit;
}

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

print '----' . "\n";

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

?>