(CkPython) List IMAP Mailboxes with Reference

Demonstrates how to list all sub-mailboxes within a specified context. In this case, we list all mailboxes under "INBOX.vendors".

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

import sys
import chilkat

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

imap = chilkat.CkImap()

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

# Login
success = imap.Login("admin@chilkatsoft.com","myPassword")
if (success != True):
    print(imap.lastErrorText())
    sys.exit()

# The ListMailboxes method returns a Mailboxes object
# that contains the collection of mailboxes.
# It accepts two arguments: a refName and a wildcardedMailbox.

# List all mailboxes under INBOX.vendors
refName = "INBOX.vendors"

# Select all mailboxes matching this pattern:
wildcardedMailbox = "*"

# mboxes is a CkMailboxes
mboxes = imap.ListMailboxes(refName,wildcardedMailbox)
if (imap.get_LastMethodSuccess() == False):
    print(imap.lastErrorText())
    sys.exit()

i = 0
while i < mboxes.get_Count() :
    print(mboxes.getName(i))
    i = i + 1

# Sample output looks like this:
# INBOX.vendors.shareit
# INBOX.vendors.paypal
# INBOX.vendors.dell
# INBOX.vendors.inMotion
# INBOX.vendors.myhosting
# INBOX.vendors.peer1

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