(CkPython) List IMAP Mailboxes

List the mailboxes available within an IMAP account.

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("MY-IMAP-DOMAIN")
if (success != True):
    print(imap.lastErrorText())
    sys.exit()

# Login
success = imap.Login("MY-IMAP-LOGIN","MY-IMAP-PASSWORD")
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.

refName = ""
# refName is usually set to an empty string.
# A non-empty reference name argument is the name of a mailbox or a level of
# mailbox hierarchy, and indicates the context in which the mailbox
# name is interpreted.

# 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.oldSupport
# INBOX.vendors.paypal
# INBOX.sales
# INBOX.lists
# INBOX.Drafts
# INBOX.vendors.dell
# INBOX.Trash
# INBOX.invoiceRequests
# INBOX.purchases
# INBOX.vendors.inMotion
# INBOX.oldEmail
# INBOX.vendors
# INBOX.lists.python
# INBOX.vendors.myhosting
# INBOX.Templates
# INBOX.friends
# INBOX.bounceSamples
# INBOX.lists.ruby
# INBOX.vendors.peer1
# INBOX.Sent
# INBOX.Junk
# INBOX

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