Lua

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

Download Chilkat for Lua

Lua

local chilkat = require("chilkat")

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

local imap = chilkat.Imap.new()

imap.ssl = true
imap.port = 993

local success = imap:connect("imap.example.com")
if not success then
    print(imap.last_error_text)
    return
end

success = imap:login("user@example.com", "myPassword")
if not success then
    print(imap.last_error_text)
    return
end

success = imap:select_mailbox("Inbox")
if not success then
    print(imap.last_error_text)
    return
end

-- Enter IDLE mode to monitor the mailbox for changes (new mail, deletions, flag changes).
success = imap:idle_start()
if not success then
    print(imap.last_error_text)
    return
end

print("IDLE mode started.")

-- While IDLE is active, no other IMAP command may be sent.  End IDLE before doing more work.
success = imap:idle_done()
if not success then
    print(imap.last_error_text)
    return
end

success = imap:disconnect()
if not success then
    print(imap.last_error_text)
    return
end