(Perl) Subscribe to Mailboxes and List Subscribed Mailboxes

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

Note: This example requires Chilkat v11.0.0 or greater.

Chilkat Perl Downloads Perl Module for Windows, MacOS, Linux, Alpine Linux

use chilkat();

$success = 0;

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

$imap = chilkat::CkImap->new();

# Connect to an IMAP server.
# Use TLS
$imap->put_Ssl(1);
$imap->put_Port(993);
$success = $imap->Connect("imap.example.com");
if ($success == 0) {
    print $imap->lastErrorText() . "\r\n";
    exit;
}

# Login
$success = $imap->Login("myLogin","myPassword");
if ($success == 0) {
    print $imap->lastErrorText() . "\r\n";
    exit;
}

# First examine the already subscribed mailboxes.
$refName = "";
$wildcardedMailbox = "*";
$subscribed = 1;

$mboxes = chilkat::CkMailboxes->new();
$success = $imap->MbxList($subscribed,$refName,$wildcardedMailbox,$mboxes);
if ($success == 0) {
    print $imap->lastErrorText() . "\r\n";
    exit;
}

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

print "----" . "\r\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 == 0) {
    print $imap->lastErrorText() . "\r\n";
    exit;
}

# Get the list of subscribed mailboxes again to verify that "INBOX/misc/solutions" is missing.
$success = $imap->MbxList($subscribed,"","INBOX/misc*",$mboxes);
if ($success == 0) {
    print $imap->lastErrorText() . "\r\n";
    exit;
}

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

print "----" . "\r\n";

# Re-subscribe to "INBOX/misc/solutions".
$success = $imap->Subscribe("INBOX/misc/solutions");
if ($success == 0) {
    print $imap->lastErrorText() . "\r\n";
    exit;
}

# Get the list of subscribed mailboxes again to verify that "INBOX/misc/solutions" is back in the list.
$success = $imap->MbxList($subscribed,"","INBOX/misc*",$mboxes);
if ($success == 0) {
    print $imap->lastErrorText() . "\r\n";
    exit;
}

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

print "----" . "\r\n";

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