(Perl) Subscribe to Mailboxes and List Subscribed Mailboxes

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

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

use chilkat();

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

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

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

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

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

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

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

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

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

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

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

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