Swift

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

Download Chilkat for Swift

Swift


func chilkatTest() {
    var success: Bool = 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.

    let imap = CkoImap()!

    imap.ssl = true
    imap.port = 993

    success = imap.connect(hostname: "imap.example.com")
    if success == false {
        print("\(imap.lastErrorText!)")
        return
    }

    success = imap.login(login: "user@example.com", password: "myPassword")
    if success == false {
        print("\(imap.lastErrorText!)")
        return
    }

    //  Populate a Mailboxes object with the full list of mailboxes.  The first argument requests
    //  all mailboxes (not subscribed-only) and "*" matches any name.
    var subscribedOnly: Bool = false
    let mailboxes = CkoMailboxes()!
    success = imap.mbxList(subscribed: subscribedOnly, reference: "", mbxPattern: "*", mboxes: mailboxes)
    if success == false {
        print("\(imap.lastErrorText!)")
        return
    }

    //  Loop over each mailbox in the returned collection.
    var n: Int = mailboxes.count.intValue
    print("Number of mailboxes: \(n)")

    var i: Int
    for i = 0; i <= n - 1; i++ {
        var name: String? = mailboxes.getName(index: i)
        print("Mailbox: \(name!)")

        //  Whether the mailbox can be selected or examined for message access.
        if mailboxes.isSelectable(index: i) {
            print("  Selectable: yes")
        }
        else {
            print("  Selectable: no")
        }

        //  Whether the server marked the mailbox as possibly having new messages.
        if mailboxes.isMarked(index: i) {
            print("  Marked: yes")
        }

        //  Whether the mailbox has, or may contain, child mailboxes.
        if mailboxes.hasInferiors(index: i) {
            print("  May have child mailboxes")
        }

        //  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 mailboxes.hasFlag(index: i, flagName: "\\HasChildren") {
            print("  Has child mailboxes")
        }

        //  Get all of the mailbox's flags as a comma-separated string.
        var flags: String? = mailboxes.getFlags(index: i)
        print("  Flags: \(flags!)")

        //  Iterate the flags individually.
        var numFlags: Int = mailboxes.getNumFlags(index: i).intValue
        var j: Int
        for j = 0; j <= numFlags - 1; j++ {
            var flag: String? = mailboxes.getNthFlag(index: i, flagIndex: j)
            print("    Flag \(j): \(flag!)")
        }

    }

    //  Look up a mailbox by name.  Returns -1 if no mailbox with that name is present.
    var sentIndex: Int = mailboxes.getMailboxIndex(mbxName: "Sent").intValue
    if sentIndex >= 0 {
        print("The Sent mailbox is at index \(sentIndex)")
    }

    success = imap.disconnect()
    if success == false {
        print("\(imap.lastErrorText!)")
        return
    }


}