Tcl

List and Inspect IMAP Mailboxes

Demonstrates the Chilkat Mailboxes class, a read-only result collection populated by Imap.MbxList. This example connects to an IMAP server, lists all mailboxes into a Mailboxes object, then loops from 0 to Count - 1 and inspects each mailbox: its name (GetName), whether it is selectable (IsSelectable) or marked (IsMarked), whether it may have child mailboxes (HasInferiors), a specific flag (HasFlag), and all of its flags both as a string (GetFlags) and individually (GetNumFlags with GetNthFlag). Finally it looks up a mailbox by name with GetMailboxIndex.

Background: Mailboxes is how an application renders an IMAP folder tree. Because it is read-only, you never construct it directly — you receive it from MbxList and read its entries by index. Mailbox names come back as normal Unicode text (Chilkat handles the modified UTF-7 / IMAP UTF-8 encoding at the protocol level), so a name from GetName can be passed straight to methods like SelectMailbox. Note that HasInferiors is often true: it means children exist or may be created, which is not the same as \HasChildren.

Chilkat Tcl Downloads

Download Chilkat for Tcl

Tcl


load ./chilkat.dll

set success 0

#  Demonstrates using Chilkat.Imap to populate a Mailboxes object (via MbxList), then looping
#  over the collection to inspect each mailbox's name and attributes.  Mailboxes is a read-only
#  result collection -- applications inspect the entries but do not add, remove, or modify them.

set imap [new_CkImap]

CkImap_put_Ssl $imap 1
CkImap_put_Port $imap 993

set success [CkImap_Connect $imap "imap.example.com"]
if {$success == 0} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    exit
}

set success [CkImap_Login $imap "user@example.com" "myPassword"]
if {$success == 0} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    exit
}

#  Populate a Mailboxes object with the full list of mailboxes.  The first argument requests
#  all mailboxes (not subscribed-only) and "*" matches any name.
set subscribedOnly 0
set mailboxes [new_CkMailboxes]

set success [CkImap_MbxList $imap $subscribedOnly "" "*" $mailboxes]
if {$success == 0} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    delete_CkMailboxes $mailboxes
    exit
}

#  Loop over each mailbox in the returned collection.
set n [CkMailboxes_get_Count $mailboxes]
puts "Number of mailboxes: $n"

for {set i 0} {$i <= [expr $n - 1]} {incr i} {
    set name [CkMailboxes_getName $mailboxes $i]
    puts "Mailbox: $name"

    #  Whether the mailbox can be selected or examined for message access.
    if {CkMailboxes_IsSelectable $mailboxes $i} then {
        puts "  Selectable: yes"
    }     else {
        puts "  Selectable: no"
    }

    #  Whether the server marked the mailbox as possibly having new messages.
    if {CkMailboxes_IsMarked $mailboxes $i} then {
        puts "  Marked: yes"
    }

    #  Whether the mailbox has, or may contain, child mailboxes.
    if {CkMailboxes_HasInferiors $mailboxes $i} then {
        puts "  May have child mailboxes"
    }

    #  Check for a specific flag by name.  Include the leading backslash for a system flag;
    #  in CkScript a literal backslash in a string is written as "\\".
    if {CkMailboxes_HasFlag $mailboxes $i "\\HasChildren"} then {
        puts "  Has child mailboxes"
    }

    #  Get all of the mailbox's flags as a comma-separated string.
    set flags [CkMailboxes_getFlags $mailboxes $i]
    puts "  Flags: $flags"

    #  Iterate the flags individually.
    set numFlags [CkMailboxes_GetNumFlags $mailboxes $i]

    for {set j 0} {$j <= [expr $numFlags - 1]} {incr j} {
        set flag [CkMailboxes_getNthFlag $mailboxes $i $j]
        puts "    Flag $j: $flag"
    }
}

#  Look up a mailbox by name.  Returns -1 if no mailbox with that name is present.
set sentIndex [CkMailboxes_GetMailboxIndex $mailboxes "Sent"]
if {$sentIndex >= 0} then {
    puts "The Sent mailbox is at index $sentIndex"
}

set success [CkImap_Disconnect $imap]
if {$success == 0} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    delete_CkMailboxes $mailboxes
    exit
}


delete_CkImap $imap
delete_CkMailboxes $mailboxes