PHP Extension

End IMAP IDLE Mode

Demonstrates the Chilkat Imap.IdleDone method, which ends IDLE mode by sending the protocol's DONE continuation. It takes no arguments. The authenticated connection remains open and usable afterward.

Background: While IDLE is active the connection is dedicated to receiving push notifications, so any command that needs to talk to the server — fetching a message, setting a flag — must wait until IDLE ends. IdleDone cleanly exits IDLE without dropping the login, so the same connection can immediately be reused. Calling it when IDLE is not active fails.

Chilkat PHP Extension Downloads

Download Chilkat for PHP Extension

PHP Extension

<?php

include("chilkat.php");

$success = false;

//  Demonstrates the Imap.IdleDone method, which ends IMAP IDLE mode by sending the DONE
//  continuation.  It takes no arguments.  The authenticated connection remains open and usable.

$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;
}

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

//  Check once for any updates that arrived.
$timeoutMs = 5000;
$updates = $imap->idleCheck($timeoutMs);
if ($imap->get_LastMethodSuccess() == false) {
    print $imap->lastErrorText() . "\n";
    exit;
}

print $updates . "\n";

//  End IDLE so that ordinary IMAP commands can be sent again on the same connection.
$success = $imap->IdleDone();
if ($success == false) {
    print $imap->lastErrorText() . "\n";
    exit;
}

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

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


?>