Tcl Requires Chilkat v11.0.0+

Subscribe to Mailboxes and List Subscribed Mailboxes

See more IMAP Examples

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

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 "imap.example.com"]
if {$success == 0} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    exit
}

#  Login
set success [CkImap_Login $imap "myLogin" "myPassword"]
if {$success == 0} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    exit
}

#  First examine the already subscribed mailboxes.
set refName ""
set wildcardedMailbox "*"
set subscribed 1

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]
}
puts "----"

#  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".
set success [CkImap_Unsubscribe $imap "INBOX/misc/solutions"]
if {$success == 0} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    delete_CkMailboxes $mboxes
    exit
}

#  Get the list of subscribed mailboxes again to verify that "INBOX/misc/solutions" is missing.
set success [CkImap_MbxList $imap $subscribed "" "INBOX/misc*" $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]
}
puts "----"

#  Re-subscribe to "INBOX/misc/solutions".
set success [CkImap_Subscribe $imap "INBOX/misc/solutions"]
if {$success == 0} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    delete_CkMailboxes $mboxes
    exit
}

#  Get the list of subscribed mailboxes again to verify that "INBOX/misc/solutions" is back in the list.
set success [CkImap_MbxList $imap $subscribed "" "INBOX/misc*" $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]
}
puts "----"

#  Disconnect from the IMAP server.
set success [CkImap_Disconnect $imap]

delete_CkImap $imap
delete_CkMailboxes $mboxes