PHP Extension

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 PHP Extension Downloads

Download Chilkat for PHP Extension

PHP Extension

<?php

include("chilkat.php");

$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 CkImap();

$imap->put_Ssl(true);
$imap->put_Port(993);

$success = $imap->Connect('imap.example.com');
if ($success == false) {
    print $imap->lastErrorText() . "\n";
    exit;
}

$success = $imap->Login('user@example.com','myPassword');
if ($success == false) {
    print $imap->lastErrorText() . "\n";
    exit;
}

$success = $imap->SelectMailbox('Inbox');
if ($success == false) {
    print $imap->lastErrorText() . "\n";
    exit;
}

//  Enter IDLE mode to monitor the mailbox for changes (new mail, deletions, flag changes).
$success = $imap->IdleStart();
if ($success == false) {
    print $imap->lastErrorText() . "\n";
    exit;
}

print 'IDLE mode started.' . "\n";

//  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() . "\n";
    exit;
}

$success = $imap->Disconnect();
if ($success == false) {
    print $imap->lastErrorText() . "\n";
    exit;
}


?>