(Tcl) Subscribe to Mailboxes and List Subscribed Mailboxes

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

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

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

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

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

# Alternatively, the ListMailboxes method can be called to list all mailboxes (both subscribed and unsubscribed).
# mboxes is a CkMailboxes
set mboxes [CkImap_ListSubscribed $imap $refName $wildcardedMailbox]
if {[CkImap_get_LastMethodSuccess $imap] != 1} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    exit
}

for {set i 0} {$i <= [expr [CkMailboxes_get_Count $mboxes] - 1]} {incr i} {
    puts [CkMailboxes_getName $mboxes $i]
}
puts "----"
delete_CkMailboxes $mboxes

# 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 != 1} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    exit
}

# Get the list of subscribed mailboxes again to verify that "INBOX/misc/solutions" is missing.
set mboxes [CkImap_ListSubscribed $imap "" "INBOX/misc*"]
if {[CkImap_get_LastMethodSuccess $imap] != 1} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    exit
}

for {set i 0} {$i <= [expr [CkMailboxes_get_Count $mboxes] - 1]} {incr i} {
    puts [CkMailboxes_getName $mboxes $i]
}
delete_CkMailboxes $mboxes

puts "----"

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

# Get the list of subscribed mailboxes again to verify that "INBOX/misc/solutions" is back in the list.
set mboxes [CkImap_ListSubscribed $imap "" "INBOX/misc*"]
if {[CkImap_get_LastMethodSuccess $imap] != 1} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    exit
}

for {set i 0} {$i <= [expr [CkMailboxes_get_Count $mboxes] - 1]} {incr i} {
    puts [CkMailboxes_getName $mboxes $i]
}
delete_CkMailboxes $mboxes

puts "----"

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

delete_CkImap $imap