C++

Check for IMAP IDLE Mailbox Updates

Demonstrates the Chilkat Imap.IdleCheck method, which waits for mailbox updates after IdleStart has entered IDLE mode. The only argument is a timeout in milliseconds; 0 performs a non-blocking poll of notifications already received. This example waits up to 30 seconds.

Background: IdleCheck consumes the notifications already waiting on the connection rather than sending a new polling command. A typical monitoring loop repeatedly calls IdleCheck with a timeout and reacts when updates arrive. Because servers usually drop an idle connection after about 29 minutes, long-lived monitors periodically call IdleDone and then IdleStart again to refresh it.

Chilkat C++ Downloads

Download Chilkat for C++

C++

#include <CkImap.h>

void ChilkatSample(void)
    {
    bool success = false;

    //  Demonstrates the Imap.IdleCheck method, which waits for IMAP IDLE mailbox updates and returns
    //  them.  The only argument is a timeout in milliseconds.  Use 0 for a non-blocking poll.

    CkImap imap;

    imap.put_Ssl(true);
    imap.put_Port(993);

    success = imap.Connect("imap.example.com");
    if (success == false) {
        std::cout << imap.lastErrorText() << "\r\n";
        return;
    }

    success = imap.Login("user@example.com","myPassword");
    if (success == false) {
        std::cout << imap.lastErrorText() << "\r\n";
        return;
    }

    success = imap.SelectMailbox("Inbox");
    if (success == false) {
        std::cout << imap.lastErrorText() << "\r\n";
        return;
    }

    success = imap.IdleStart();
    if (success == false) {
        std::cout << imap.lastErrorText() << "\r\n";
        return;
    }

    //  Wait up to 30 seconds for mailbox updates.  IdleCheck returns a string, so assign it to a
    //  string variable and check for success.
    int timeoutMs = 30000;
    const char *updates = imap.idleCheck(timeoutMs);
    if (imap.get_LastMethodSuccess() == false) {
        std::cout << imap.lastErrorText() << "\r\n";
        return;
    }

    std::cout << updates << "\r\n";

    success = imap.IdleDone();
    if (success == false) {
        std::cout << imap.lastErrorText() << "\r\n";
        return;
    }

    success = imap.Disconnect();
    if (success == false) {
        std::cout << imap.lastErrorText() << "\r\n";
        return;
    }
    }