Perl Requires Chilkat v11.0.0+

Subscribe to Mailboxes and List Subscribed Mailboxes

See more IMAP Examples

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

use strict;
use warnings;
use Chilkat2;

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

my $imap = Chilkat2::Imap->new;

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

# Login
$success = $imap->Login('myLogin', 'myPassword');
if (!$success) {
    print $imap->LastErrorText, "\n";
    exit;
}

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

my $mboxes = Chilkat2::Mailboxes->new;
$success = $imap->MbxList($subscribed, $refName, $wildcardedMailbox, $mboxes);
if (!$success) {
    print $imap->LastErrorText, "\n";
    exit;
}

my $i = 0;
while ($i < $mboxes->Count) {
    print $mboxes->GetName($i), "\n";
    $i = $i + 1;
}

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) {
    print $imap->LastErrorText, "\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) {
    print $imap->LastErrorText, "\n";
    exit;
}

$i = 0;
while ($i < $mboxes->Count) {
    print $mboxes->GetName($i), "\n";
    $i = $i + 1;
}

print "----\n";

# Re-subscribe to "INBOX/misc/solutions".
$success = $imap->Subscribe('INBOX/misc/solutions');
if (!$success) {
    print $imap->LastErrorText, "\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) {
    print $imap->LastErrorText, "\n";
    exit;
}

$i = 0;
while ($i < $mboxes->Count) {
    print $mboxes->GetName($i), "\n";
    $i = $i + 1;
}

print "----\n";

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