Perl

Unsubscribe from an IMAP Mailbox

Demonstrates the Chilkat Imap.Unsubscribe method, which removes the subscription to a mailbox. The mailbox itself and its messages are not deleted. This example unsubscribes from a mailbox.

Background: Unsubscribing simply drops a mailbox from the account's subscription list, so clients that show only subscribed folders will stop displaying it — the folder and everything in it remain on the server untouched. This is the counterpart to Subscribe, and is how you declutter a mailbox listing without deleting anything (deleting a folder is DeleteMailbox).

Chilkat Perl Downloads

Download Chilkat for Perl

Chilkat2 Perl

use strict;
use warnings;
use Chilkat2;

# Demonstrates the Imap.Unsubscribe method, which removes the subscription to a mailbox.
# The mailbox itself and its messages are not deleted.

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

$imap->Ssl(1);
$imap->Port(993);

my $success = $imap->Connect('imap.example.com');
if (!$success) {
    print $imap->LastErrorText, "\n";
    exit;
}

$success = $imap->Login('user@example.com', 'myPassword');
if (!$success) {
    print $imap->LastErrorText, "\n";
    exit;
}

# Remove the subscription to a mailbox (the mailbox is not deleted).
$success = $imap->Unsubscribe('Archive2026');
if (!$success) {
    print $imap->LastErrorText, "\n";
    exit;
}

print "Unsubscribed from the mailbox.\n";

$success = $imap->Disconnect();
if (!$success) {
    print $imap->LastErrorText, "\n";
    exit;
}