Swift

Get IMAP Mailbox Status

Demonstrates the Chilkat Imap.GetMailboxStatus method, which sends the IMAP STATUS command for a mailbox and returns the reported values as XML attributes — including messages (total count), recent, uidnext, uidvalidity, and unseen. This example gets the Inbox status.

Tip: XML parsing code for this result can be generated at Chilkat Tools.

Background: STATUS queries a mailbox's summary counts without selecting it — ideal for showing unread counts across many folders in a UI, or checking whether a folder has new mail before deciding to open it. Two values are especially useful for sync: uidvalidity (if it changes, previously stored UIDs are no longer valid) and uidnext (the UID the next new message will get, so anything at or above a remembered value is new).

Chilkat Swift Downloads

Download Chilkat for Swift

Swift


func chilkatTest() {
    var success: Bool = false

    //  Demonstrates the Imap.GetMailboxStatus method, which sends the IMAP STATUS command for a
    //  mailbox and returns the reported values as XML attributes (such as messages, recent,
    //  uidnext, uidvalidity, and unseen).

    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
    }

    //  Get the status of a mailbox (without selecting it).
    var statusXml: String? = imap.getMailboxStatus(mailbox: "Inbox")
    if imap.lastMethodSuccess == false {
        print("\(imap.lastErrorText!)")
        return
    }

    print("\(statusXml!)")

    //  XML parsing code for this result can be generated at Chilkat's online tool:
    //  https://tools.chilkat.io/xmlParse

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


}