Sample code for 30+ languages & platforms
Lianja 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.

Chilkat Lianja Downloads

Lianja
llSuccess = .F.

//  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.example.com")
if (llSuccess = .F.) then
    ? loImap.LastErrorText
    release loImap
    return
endif

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

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

loMboxes = createobject("CkMailboxes")
llSuccess = loImap.MbxList(llSubscribed,lcRefName,lcWildcardedMailbox,loMboxes)
if (llSuccess = .F.) then
    ? loImap.LastErrorText
    release loImap
    release loMboxes
    return
endif

i = 0
do while i < loMboxes.Count
    ? loMboxes.GetName(i)
    i = i + 1
enddo
? "----"

//  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 = .F.) then
    ? loImap.LastErrorText
    release loImap
    release loMboxes
    return
endif

//  Get the list of subscribed mailboxes again to verify that "INBOX/misc/solutions" is missing.
llSuccess = loImap.MbxList(llSubscribed,"","INBOX/misc*",loMboxes)
if (llSuccess = .F.) then
    ? loImap.LastErrorText
    release loImap
    release loMboxes
    return
endif

i = 0
do while i < loMboxes.Count
    ? loMboxes.GetName(i)
    i = i + 1
enddo
? "----"

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

//  Get the list of subscribed mailboxes again to verify that "INBOX/misc/solutions" is back in the list.
llSuccess = loImap.MbxList(llSubscribed,"","INBOX/misc*",loMboxes)
if (llSuccess = .F.) then
    ? loImap.LastErrorText
    release loImap
    release loMboxes
    return
endif

i = 0
do while i < loMboxes.Count
    ? loMboxes.GetName(i)
    i = i + 1
enddo
? "----"

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


release loImap
release loMboxes