Xojo Plugin

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 Xojo Plugin Downloads

Download Chilkat for Xojo Plugin

Xojo Plugin

Dim success As Boolean
success = 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.

Dim imap As New Chilkat.Imap

imap.Ssl = True
imap.Port = 993

success = imap.Connect("imap.example.com")
If (success = False) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

success = imap.Login("user@example.com","myPassword")
If (success = False) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

success = imap.SelectMailbox("Inbox")
If (success = False) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

//  Enter IDLE mode to monitor the mailbox for changes (new mail, deletions, flag changes).
success = imap.IdleStart()
If (success = False) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

System.DebugLog("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) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

success = imap.Disconnect()
If (success = False) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If