Lianja

List and Inspect IMAP Mailboxes

Demonstrates the Chilkat Mailboxes class, a read-only result collection populated by Imap.MbxList. This example connects to an IMAP server, lists all mailboxes into a Mailboxes object, then loops from 0 to Count - 1 and inspects each mailbox: its name (GetName), whether it is selectable (IsSelectable) or marked (IsMarked), whether it may have child mailboxes (HasInferiors), a specific flag (HasFlag), and all of its flags both as a string (GetFlags) and individually (GetNumFlags with GetNthFlag). Finally it looks up a mailbox by name with GetMailboxIndex.

Background: Mailboxes is how an application renders an IMAP folder tree. Because it is read-only, you never construct it directly — you receive it from MbxList and read its entries by index. Mailbox names come back as normal Unicode text (Chilkat handles the modified UTF-7 / IMAP UTF-8 encoding at the protocol level), so a name from GetName can be passed straight to methods like SelectMailbox. Note that HasInferiors is often true: it means children exist or may be created, which is not the same as \HasChildren.

Chilkat Lianja Downloads

Download Chilkat for Lianja

Lianja

llSuccess = .F.

//  Demonstrates using Chilkat.Imap to populate a Mailboxes object (via MbxList), then looping
//  over the collection to inspect each mailbox's name and attributes.  Mailboxes is a read-only
//  result collection -- applications inspect the entries but do not add, remove, or modify them.

loImap = createobject("CkImap")

loImap.Ssl = .T.
loImap.Port = 993

llSuccess = loImap.Connect("imap.example.com")
if (llSuccess = .F.) then
    ? loImap.LastErrorText
    release loImap
    return
endif

llSuccess = loImap.Login("user@example.com","myPassword")
if (llSuccess = .F.) then
    ? loImap.LastErrorText
    release loImap
    return
endif

//  Populate a Mailboxes object with the full list of mailboxes.  The first argument requests
//  all mailboxes (not subscribed-only) and "*" matches any name.
llSubscribedOnly = .F.
loMailboxes = createobject("CkMailboxes")
llSuccess = loImap.MbxList(llSubscribedOnly,"","*",loMailboxes)
if (llSuccess = .F.) then
    ? loImap.LastErrorText
    release loImap
    release loMailboxes
    return
endif

//  Loop over each mailbox in the returned collection.
n = loMailboxes.Count
? "Number of mailboxes: " + str(n)

for i = 0 to n - 1
    lcName = loMailboxes.GetName(i)
    ? "Mailbox: " + lcName

    //  Whether the mailbox can be selected or examined for message access.
    if (loMailboxes.IsSelectable(i)) then
        ? "  Selectable: yes"
    else
        ? "  Selectable: no"
    endif

    //  Whether the server marked the mailbox as possibly having new messages.
    if (loMailboxes.IsMarked(i)) then
        ? "  Marked: yes"
    endif

    //  Whether the mailbox has, or may contain, child mailboxes.
    if (loMailboxes.HasInferiors(i)) then
        ? "  May have child mailboxes"
    endif

    //  Check for a specific flag by name.  Include the leading backslash for a system flag;
    //  in CkScript a literal backslash in a string is written as "\\".
    if (loMailboxes.HasFlag(i,"\\HasChildren")) then
        ? "  Has child mailboxes"
    endif

    //  Get all of the mailbox's flags as a comma-separated string.
    lcFlags = loMailboxes.GetFlags(i)
    ? "  Flags: " + lcFlags

    //  Iterate the flags individually.
    lnNumFlags = loMailboxes.GetNumFlags(i)

    for j = 0 to lnNumFlags - 1
        lcFlag = loMailboxes.GetNthFlag(i,j)
        ? "    Flag " + str(j) + ": " + lcFlag
    next
next

//  Look up a mailbox by name.  Returns -1 if no mailbox with that name is present.
lnSentIndex = loMailboxes.GetMailboxIndex("Sent")
if (lnSentIndex >= 0) then
    ? "The Sent mailbox is at index " + str(lnSentIndex)
endif

llSuccess = loImap.Disconnect()
if (llSuccess = .F.) then
    ? loImap.LastErrorText
    release loImap
    release loMailboxes
    return
endif



release loImap
release loMailboxes