(Lianja) List IMAP Mailboxes

List the mailboxes available within an IMAP account.

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("MY-IMAP-DOMAIN")
if (llSuccess <> .T.) then
    ? loImap.LastErrorText
    release loImap
    return
endif

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

// The ListMailboxes method returns a Mailboxes object
// that contains the collection of mailboxes.
// It accepts two arguments: a refName and a wildcardedMailbox.

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 = "*"

loMboxes = loImap.ListMailboxes(lcRefName,lcWildcardedMailbox)
if (loImap.LastMethodSuccess = .F.) then
    ? loImap.LastErrorText
    release loImap
    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 loMboxes


release loImap