AutoIt

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 AutoIt Downloads

Download Chilkat for AutoIt

AutoIt

Local $bSuccess = False

;  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.

$oImap = ObjCreate("Chilkat.Imap")

$oImap.Ssl = True
$oImap.Port = 993

$bSuccess = $oImap.Connect("imap.example.com")
If ($bSuccess = False) Then
    ConsoleWrite($oImap.LastErrorText & @CRLF)
    Exit
EndIf

$bSuccess = $oImap.Login("user@example.com","myPassword")
If ($bSuccess = False) Then
    ConsoleWrite($oImap.LastErrorText & @CRLF)
    Exit
EndIf

;  Populate a Mailboxes object with the full list of mailboxes.  The first argument requests
;  all mailboxes (not subscribed-only) and "*" matches any name.
Local $bSubscribedOnly = False
$oMailboxes = ObjCreate("Chilkat.Mailboxes")
$bSuccess = $oImap.MbxList($bSubscribedOnly,"","*",$oMailboxes)
If ($bSuccess = False) Then
    ConsoleWrite($oImap.LastErrorText & @CRLF)
    Exit
EndIf

;  Loop over each mailbox in the returned collection.
Local $iN = $oMailboxes.Count
ConsoleWrite("Number of mailboxes: " & $iN & @CRLF)

Local $i
For $i = 0 To $iN - 1
Local $sName = $oMailboxes.GetName($i)
    ConsoleWrite("Mailbox: " & $sName & @CRLF)

    ;  Whether the mailbox can be selected or examined for message access.
    If ($oMailboxes.IsSelectable($i)) Then
        ConsoleWrite("  Selectable: yes" & @CRLF)
    Else
        ConsoleWrite("  Selectable: no" & @CRLF)
    EndIf

    ;  Whether the server marked the mailbox as possibly having new messages.
    If ($oMailboxes.IsMarked($i)) Then
        ConsoleWrite("  Marked: yes" & @CRLF)
    EndIf

    ;  Whether the mailbox has, or may contain, child mailboxes.
    If ($oMailboxes.HasInferiors($i)) Then
        ConsoleWrite("  May have child mailboxes" & @CRLF)
    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 ($oMailboxes.HasFlag($i,"\HasChildren")) Then
        ConsoleWrite("  Has child mailboxes" & @CRLF)
    EndIf

    ;  Get all of the mailbox's flags as a comma-separated string.
Local $sFlags = $oMailboxes.GetFlags($i)
    ConsoleWrite("  Flags: " & $sFlags & @CRLF)

    ;  Iterate the flags individually.
Local $iNumFlags = $oMailboxes.GetNumFlags($i)
Local $iJ
    For $iJ = 0 To $iNumFlags - 1
Local $sFlag = $oMailboxes.GetNthFlag($i,$iJ)
        ConsoleWrite("    Flag " & $iJ & ": " & $sFlag & @CRLF)
    Next
Next

;  Look up a mailbox by name.  Returns -1 if no mailbox with that name is present.
Local $iSentIndex = $oMailboxes.GetMailboxIndex("Sent")
If ($iSentIndex >= 0) Then
    ConsoleWrite("The Sent mailbox is at index " & $iSentIndex & @CRLF)
EndIf

$bSuccess = $oImap.Disconnect()
If ($bSuccess = False) Then
    ConsoleWrite($oImap.LastErrorText & @CRLF)
    Exit
EndIf