(PHP Extension) Subscribe to Mailboxes and List Subscribed Mailboxes

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

Chilkat PHP Downloads PHP Extension for Windows, Linux, MacOS, Alpine Linux, Solaris

<?php

// The version number (9_5_0) should match version of the Chilkat extension used, omitting the micro-version number.
// For example, if using Chilkat v9.5.0.48, then include as shown here:
include("chilkat_9_5_0.php");

// 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.someMailServer.com');
if ($success != true) {
    print $imap->lastErrorText() . "\n";
    exit;
}

// Login
$success = $imap->Login('myLogin','myPassword');
if ($success != true) {
    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 CkMailboxes
$mboxes = $imap->ListSubscribed($refName,$wildcardedMailbox);
if ($imap->get_LastMethodSuccess() != true) {
    print $imap->lastErrorText() . "\n";
    exit;
}

for ($i = 0; $i <= $mboxes->get_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 != true) {
    print $imap->lastErrorText() . "\n";
    exit;
}

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

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

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

// Re-subscribe to "INBOX/misc/solutions".
$success = $imap->Subscribe('INBOX/misc/solutions');
if ($success != true) {
    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 CkMailboxes
$mboxes = $imap->ListSubscribed('','INBOX/misc*');
if ($imap->get_LastMethodSuccess() != true) {
    print $imap->lastErrorText() . "\n";
    exit;
}

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

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

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

?>