C++

Get IMAP Mailbox Status

Demonstrates the Chilkat Imap.GetMailboxStatus method, which sends the IMAP STATUS command for a mailbox and returns the reported values as XML attributes — including messages (total count), recent, uidnext, uidvalidity, and unseen. This example gets the Inbox status.

Tip: XML parsing code for this result can be generated at Chilkat Tools.

Background: STATUS queries a mailbox's summary counts without selecting it — ideal for showing unread counts across many folders in a UI, or checking whether a folder has new mail before deciding to open it. Two values are especially useful for sync: uidvalidity (if it changes, previously stored UIDs are no longer valid) and uidnext (the UID the next new message will get, so anything at or above a remembered value is new).

Chilkat C++ Downloads

Download Chilkat for C++

C++

#include <CkImap.h>

void ChilkatSample(void)
    {
    bool success = false;

    //  Demonstrates the Imap.GetMailboxStatus method, which sends the IMAP STATUS command for a
    //  mailbox and returns the reported values as XML attributes (such as messages, recent,
    //  uidnext, uidvalidity, and unseen).

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

    //  Get the status of a mailbox (without selecting it).
    const char *statusXml = imap.getMailboxStatus("Inbox");
    if (imap.get_LastMethodSuccess() == false) {
        std::cout << imap.lastErrorText() << "\r\n";
        return;
    }

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

    //  XML parsing code for this result can be generated at Chilkat's online tool:
    //  https://tools.chilkat.io/xmlParse

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