PowerShell

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

Download Chilkat for PowerShell

PowerShell

Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"

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

$imap = New-Object Chilkat.Imap

$imap.Ssl = $true
$imap.Port = 993

$success = $imap.Connect("imap.example.com")
if ($success -eq $false) {
    $($imap.LastErrorText)
    exit
}

$success = $imap.Login("user@example.com","myPassword")
if ($success -eq $false) {
    $($imap.LastErrorText)
    exit
}

$success = $imap.SelectMailbox("Inbox")
if ($success -eq $false) {
    $($imap.LastErrorText)
    exit
}

#  Enter IDLE mode to monitor the mailbox for changes (new mail, deletions, flag changes).
$success = $imap.IdleStart()
if ($success -eq $false) {
    $($imap.LastErrorText)
    exit
}

$("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 -eq $false) {
    $($imap.LastErrorText)
    exit
}

$success = $imap.Disconnect()
if ($success -eq $false) {
    $($imap.LastErrorText)
    exit
}