Lianja Requires Chilkat v11.0.0+

List IMAP Mailboxes

List the mailboxes available within an IMAP account. 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("MY-IMAP-DOMAIN")
if (llSuccess = .F.) then
    ? loImap.LastErrorText
    release loImap
    return
endif

//  Login
llSuccess = loImap.Login("MY-IMAP-LOGIN","MY-IMAP-PASSWORD")
if (llSuccess = .F.) then
    ? loImap.LastErrorText
    release loImap
    return
endif

lcRefName = ""
//  refName is usually set to an empty string.
//  A non-empty reference name argument is the name of a mailbox or a level of
//  mailbox hierarchy, and indicates the context in which the mailbox
//  name is interpreted.

//  Select all mailboxes matching this pattern:
lcWildcardedMailbox = "*"

llSubscribed = .F.

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 looks like this:
//  INBOX.vendors.shareit
//  INBOX.oldSupport
//  INBOX.vendors.paypal
//  INBOX.sales
//  INBOX.lists
//  INBOX.Drafts
//  INBOX.vendors.dell
//  INBOX.Trash
//  INBOX.invoiceRequests
//  INBOX.purchases
//  INBOX.vendors.inMotion
//  INBOX.oldEmail
//  INBOX.vendors
//  INBOX.lists.python
//  INBOX.vendors.myhosting
//  INBOX.Templates
//  INBOX.friends
//  INBOX.bounceSamples
//  INBOX.lists.ruby
//  INBOX.vendors.peer1
//  INBOX.Sent
//  INBOX.Junk
//  INBOX

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


release loImap
release loMboxes