CkPython

Subscribe to an IMAP Mailbox

Demonstrates the Chilkat Imap.Subscribe method, which subscribes the authenticated IMAP account to a mailbox. Subscription controls which mailboxes are returned by subscribed-mailbox listings. This example subscribes to a mailbox.

Background: An account can have many mailboxes, but a user often cares about only some of them. IMAP's subscription list is that curated set: mail clients typically show subscribed folders by default and hide the rest. Subscribing does not create or change a mailbox — it only adds it to the "show me this one" list (retrieved with a subscribed-only listing). Unsubscribe removes it from that list.

Chilkat CkPython Downloads

Download Chilkat for CkPython

CkPython

import sys
import chilkat

success = False

#  Demonstrates the Imap.Subscribe method, which subscribes the authenticated IMAP account to
#  a mailbox.  Subscription controls which mailboxes are returned by subscribed-mailbox
#  listings.

imap = chilkat.CkImap()

imap.put_Ssl(True)
imap.put_Port(993)

success = imap.Connect("imap.example.com")
if (success == False):
    print(imap.lastErrorText())
    sys.exit()

success = imap.Login("user@example.com","myPassword")
if (success == False):
    print(imap.lastErrorText())
    sys.exit()

#  Subscribe to a mailbox.
success = imap.Subscribe("Archive2026")
if (success == False):
    print(imap.lastErrorText())
    sys.exit()

print("Subscribed to the mailbox.")

success = imap.Disconnect()
if (success == False):
    print(imap.lastErrorText())
    sys.exit()