Swift

Start IMAP IDLE to Monitor a Mailbox

Demonstrates the Chilkat Imap.IdleStart method, which sends the IMAP IDLE command to begin listening for unsolicited mailbox updates. It takes no arguments. A mailbox must first be selected, and the server must advertise the IDLE capability.

Background: IDLE is IMAP's push mechanism: instead of polling for new mail, the client tells the server "notify me when something changes," and the server pushes updates as they happen. This is what enables near-instant new-mail alerts. While IDLE is active, no other IMAP command may be sent on that connection — call IdleDone to leave IDLE before issuing other commands.

Chilkat Swift Downloads

Download Chilkat for Swift

Swift


func chilkatTest() {
    var success: Bool = false

    //  Demonstrates the Imap.IdleStart method, which sends the IMAP IDLE command to begin listening
    //  for unsolicited mailbox updates.  It takes no arguments.  A mailbox must be selected and the
    //  server must advertise the IDLE capability.

    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
    }

    success = imap.selectMailbox(mailbox: "Inbox")
    if success == false {
        print("\(imap.lastErrorText!)")
        return
    }

    //  Enter IDLE mode to monitor the mailbox for changes (new mail, deletions, flag changes).
    success = imap.idleStart()
    if success == false {
        print("\(imap.lastErrorText!)")
        return
    }

    print("IDLE mode started.")

    //  While IDLE is active, no other IMAP command may be sent.  End IDLE before doing more work.
    success = imap.idleDone()
    if success == false {
        print("\(imap.lastErrorText!)")
        return
    }

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


}