Visual FoxPro

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 Visual FoxPro Downloads

Download Chilkat for Visual FoxPro

Visual FoxPro

LOCAL lnSuccess
LOCAL loImap
LOCAL lnSubscribedOnly
LOCAL loMailboxes
LOCAL n
LOCAL i
LOCAL lcName
LOCAL lcFlags
LOCAL lnNumFlags
LOCAL j
LOCAL lcFlag
LOCAL lnSentIndex

lnSuccess = 0

*  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('Chilkat.Imap')

loImap.Ssl = 1
loImap.Port = 993

lnSuccess = loImap.Connect("imap.example.com")
IF (lnSuccess = 0) THEN
    ? loImap.LastErrorText
    RELEASE loImap
    CANCEL
ENDIF

lnSuccess = loImap.Login("user@example.com","myPassword")
IF (lnSuccess = 0) THEN
    ? loImap.LastErrorText
    RELEASE loImap
    CANCEL
ENDIF

*  Populate a Mailboxes object with the full list of mailboxes.  The first argument requests
*  all mailboxes (not subscribed-only) and "*" matches any name.
lnSubscribedOnly = 0
loMailboxes = CreateObject('Chilkat.Mailboxes')
lnSuccess = loImap.MbxList(lnSubscribedOnly,"","*",loMailboxes)
IF (lnSuccess = 0) THEN
    ? loImap.LastErrorText
    RELEASE loImap
    RELEASE loMailboxes
    CANCEL
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

lnSuccess = loImap.Disconnect()
IF (lnSuccess = 0) THEN
    ? loImap.LastErrorText
    RELEASE loImap
    RELEASE loMailboxes
    CANCEL
ENDIF

RELEASE loImap
RELEASE loMailboxes