(Lianja) 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".

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("imap.someMailServer.com")
if (llSuccess <> .T.) then
    ? loImap.LastErrorText
    release loImap
    return
endif

// Login
llSuccess = loImap.Login("admin@chilkatsoft.com","myPassword")
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.

// List all mailboxes under INBOX.vendors
lcRefName = "INBOX.vendors"

// 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.vendors.paypal
// INBOX.vendors.dell
// INBOX.vendors.inMotion
// INBOX.vendors.myhosting
// INBOX.vendors.peer1

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

release loMboxes


release loImap