List IMAP Mailboxes with Reference

Demonstrates how to list all sub-mailboxes within a specified context. In this case, we list all mailboxes under "INBOX.vendors".

Download Chilkat IMAP ActiveX

LOCAL loImap
LOCAL lnSuccess
LOCAL lcRefName
LOCAL lcWildcardedMailbox
LOCAL loMboxes
LOCAL i

loImap = CreateObject('Chilkat.Imap')

* Anything unlocks the component and begins a fully-functional 30-day trial.
lnSuccess = loImap.UnlockComponent("Anything for 30-day trial")
IF (lnSuccess <> 1) THEN
    =MESSAGEBOX(loImap.LastErrorText)
    QUIT
ENDIF

* Connect to an IMAP server.
lnSuccess = loImap.Connect("mail.chilkatsoft.com")
IF (lnSuccess <> 1) THEN
    =MESSAGEBOX(loImap.LastErrorText)
    QUIT
ENDIF

* Login
lnSuccess = loImap.Login("admin@chilkatsoft.com","*myPassword5*")
IF (lnSuccess <> 1) THEN
    =MESSAGEBOX(loImap.LastErrorText)
    QUIT
ENDIF

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

* List all mailboxes under INBOX.vendors

lcRefName = "INBOX.vendors"

* Select all mailboxes matching this pattern:

lcWildcardedMailbox = "*"

loMboxes = loImap.ListMailboxes(lcRefName,lcWildcardedMailbox)
IF (loMboxes = NULL ) THEN
    =MESSAGEBOX(loImap.LastErrorText)
    QUIT
ENDIF

FOR i = 0 TO loMboxes.Count - 1
    ? loMboxes.GetName(i)
NEXT

* Sample output looks like this:
* INBOX.vendors.shareit
* INBOX.vendors.paypal
* INBOX.vendors.dell
* INBOX.vendors.inMotion
* INBOX.vendors.myhosting
* INBOX.vendors.peer1

* Disconnect from the IMAP server.
loImap.Disconnect()

RELEASE loMboxes