(Swift 3,4,5...) List IMAP Mailboxes

List the mailboxes available within an IMAP account.

Chilkat Downloads for the Swift Programming Language MAC OS X (Cocoa) Objective-C/Swift Libs iOS Objective-C/Swift Libs

func chilkatTest() {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    let imap = CkoImap()!

    // Connect to an IMAP server.
    // Use TLS
    imap.ssl = true
    imap.port = 993
    var success: Bool = imap.connect("MY-IMAP-DOMAIN")
    if success != true {
        print("\(imap.lastErrorText!)")
        return
    }

    // Login
    success = imap.login("MY-IMAP-LOGIN", password: "MY-IMAP-PASSWORD")
    if success != true {
        print("\(imap.lastErrorText!)")
        return
    }

    // The ListMailboxes method returns a Mailboxes object
    // that contains the collection of mailboxes.
    // It accepts two arguments: a refName and a wildcardedMailbox.

    var refName: String? = ""
    // refName is usually set to an empty string.
    // A non-empty reference name argument is the name of a mailbox or a level of
    // mailbox hierarchy, and indicates the context in which the mailbox
    // name is interpreted.

    // Select all mailboxes matching this pattern:
    var wildcardedMailbox: String? = "*"

    var mboxes: CkoMailboxes? = imap.listMailboxes(refName, wildcardedMailbox: wildcardedMailbox)
    if imap.lastMethodSuccess == false {
        print("\(imap.lastErrorText!)")
        return
    }

    var i: Int = 0
    while i < mboxes!.count.intValue {
        print("\(mboxes!.getName(i)!)")
        i = i + 1
    }

    // Sample output looks like this:
    // INBOX.vendors.shareit
    // INBOX.oldSupport
    // INBOX.vendors.paypal
    // INBOX.sales
    // INBOX.lists
    // INBOX.Drafts
    // INBOX.vendors.dell
    // INBOX.Trash
    // INBOX.invoiceRequests
    // INBOX.purchases
    // INBOX.vendors.inMotion
    // INBOX.oldEmail
    // INBOX.vendors
    // INBOX.lists.python
    // INBOX.vendors.myhosting
    // INBOX.Templates
    // INBOX.friends
    // INBOX.bounceSamples
    // INBOX.lists.ruby
    // INBOX.vendors.peer1
    // INBOX.Sent
    // INBOX.Junk
    // INBOX

    // Disconnect from the IMAP server.
    success = imap.disconnect()

    mboxes = nil

}