(Tcl) List IMAP Mailboxes

List the mailboxes available within an IMAP account.

Note: This example requires Chilkat v11.0.0 or greater.

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

set success 0

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

set imap [new_CkImap]

# Connect to an IMAP server.
# Use TLS
CkImap_put_Ssl $imap 1
CkImap_put_Port $imap 993
set success [CkImap_Connect $imap "MY-IMAP-DOMAIN"]
if {$success == 0} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    exit
}

# Login
set success [CkImap_Login $imap "MY-IMAP-LOGIN" "MY-IMAP-PASSWORD"]
if {$success == 0} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    exit
}

set 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:
set wildcardedMailbox "*"

set subscribed 0

set mboxes [new_CkMailboxes]

set success [CkImap_MbxList $imap $subscribed $refName $wildcardedMailbox $mboxes]
if {$success == 0} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    delete_CkMailboxes $mboxes
    exit
}

set i 0
while {$i < [CkMailboxes_get_Count $mboxes]} {
    puts [CkMailboxes_getName $mboxes $i]
    set i [expr $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.
set success [CkImap_Disconnect $imap]

delete_CkImap $imap
delete_CkMailboxes $mboxes