(Lianja) Subscribe to Mailboxes and List Subscribed Mailboxes

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

Chilkat Lianja Extension Download Chilkat Lianja Extension

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

loImap = createobject("CkImap")

// Connect to an IMAP server.
// Use TLS
loImap.Ssl = .T.
loImap.Port = 993
llSuccess = loImap.Connect("imap.someMailServer.com")
if (llSuccess <> .T.) then
    ? loImap.LastErrorText
    release loImap
    return
endif

// Login
llSuccess = loImap.Login("myLogin","myPassword")
if (llSuccess <> .T.) then
    ? loImap.LastErrorText
    release loImap
    return
endif

// First examine the already subscribed mailboxes.
lcRefName = ""
lcWildcardedMailbox = "*"

// Alternatively, the ListMailboxes method can be called to list all mailboxes (both subscribed and unsubscribed).
loMboxes = loImap.ListSubscribed(lcRefName,lcWildcardedMailbox)
if (loImap.LastMethodSuccess <> .T.) then
    ? loImap.LastErrorText
    release loImap
    return
endif

for i = 0 to loMboxes.Count - 1
    ? loMboxes.GetName(i)
next
? "----"
release loMboxes

// 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".
llSuccess = loImap.Unsubscribe("INBOX/misc/solutions")
if (llSuccess <> .T.) then
    ? loImap.LastErrorText
    release loImap
    return
endif

// Get the list of subscribed mailboxes again to verify that "INBOX/misc/solutions" is missing.
loMboxes = loImap.ListSubscribed("","INBOX/misc*")
if (loImap.LastMethodSuccess <> .T.) then
    ? loImap.LastErrorText
    release loImap
    return
endif

for i = 0 to loMboxes.Count - 1
    ? loMboxes.GetName(i)
next
release loMboxes
? "----"

// Re-subscribe to "INBOX/misc/solutions".
llSuccess = loImap.Subscribe("INBOX/misc/solutions")
if (llSuccess <> .T.) then
    ? loImap.LastErrorText
    release loImap
    return
endif

// Get the list of subscribed mailboxes again to verify that "INBOX/misc/solutions" is back in the list.
loMboxes = loImap.ListSubscribed("","INBOX/misc*")
if (loImap.LastMethodSuccess <> .T.) then
    ? loImap.LastErrorText
    release loImap
    return
endif

for i = 0 to loMboxes.Count - 1
    ? loMboxes.GetName(i)
next
release loMboxes
? "----"

// Disconnect from the IMAP server.
llSuccess = loImap.Disconnect()


release loImap