List IMAP Mailboxes

Download 32-bit Chilkat IMAP ActiveX (.msi)

Download All 32-bit Chilkat ActiveX Components (.zip)

Download All 64-bit Chilkat ActiveX Components (.zip)

List the mailboxes available within an IMAP account.

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.

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 (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.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.
loImap.Disconnect()

RELEASE loMboxes