(Chilkat2-Python) Subscribe to Mailboxes and List Subscribed Mailboxes

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

Chilkat2 Python Downloads install with pip pip3 install chilkat2 or download... Python Module for Windows, Linux, Alpine Linux, MacOS, Solaris

import sys
import chilkat2

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

imap = chilkat2.Imap()

# Connect to an IMAP server.
# Use TLS
imap.Ssl = True
imap.Port = 993
success = imap.Connect("imap.someMailServer.com")
if (success != True):
    print(imap.LastErrorText)
    sys.exit()

# Login
success = imap.Login("myLogin","myPassword")
if (success != True):
    print(imap.LastErrorText)
    sys.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 CkMailboxes
mboxes = imap.ListSubscribed(refName,wildcardedMailbox)
if (imap.LastMethodSuccess != True):
    print(imap.LastErrorText)
    sys.exit()

for i in range(0,mboxes.Count):
    print(mboxes.GetName(i))

print("----")

# 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 != True):
    print(imap.LastErrorText)
    sys.exit()

# Get the list of subscribed mailboxes again to verify that "INBOX/misc/solutions" is missing.
# mboxes is a CkMailboxes
mboxes = imap.ListSubscribed("","INBOX/misc*")
if (imap.LastMethodSuccess != True):
    print(imap.LastErrorText)
    sys.exit()

for i in range(0,mboxes.Count):
    print(mboxes.GetName(i))

print("----")

# Re-subscribe to "INBOX/misc/solutions".
success = imap.Subscribe("INBOX/misc/solutions")
if (success != True):
    print(imap.LastErrorText)
    sys.exit()

# Get the list of subscribed mailboxes again to verify that "INBOX/misc/solutions" is back in the list.
# mboxes is a CkMailboxes
mboxes = imap.ListSubscribed("","INBOX/misc*")
if (imap.LastMethodSuccess != True):
    print(imap.LastErrorText)
    sys.exit()

for i in range(0,mboxes.Count):
    print(mboxes.GetName(i))

print("----")

# Disconnect from the IMAP server.
success = imap.Disconnect()