Get IMAP Mailbox Status

See more IMAP Examples

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

#include <C_CkImap.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkImap imap;
    const char *statusXml;

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

    imap = CkImap_Create();

    CkImap_putSsl(imap,TRUE);
    CkImap_putPort(imap,993);

    success = CkImap_Connect(imap,"imap.example.com");
    if (success == FALSE) {
        printf("%s\n",CkImap_lastErrorText(imap));
        CkImap_Dispose(imap);
        return;
    }

    success = CkImap_Login(imap,"user@example.com","myPassword");
    if (success == FALSE) {
        printf("%s\n",CkImap_lastErrorText(imap));
        CkImap_Dispose(imap);
        return;
    }

    //  Get the status of a mailbox (without selecting it).
    statusXml = CkImap_getMailboxStatus(imap,"Inbox");
    if (CkImap_getLastMethodSuccess(imap) == FALSE) {
        printf("%s\n",CkImap_lastErrorText(imap));
        CkImap_Dispose(imap);
        return;
    }

    printf("%s\n",statusXml);

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

    success = CkImap_Disconnect(imap);
    if (success == FALSE) {
        printf("%s\n",CkImap_lastErrorText(imap));
        CkImap_Dispose(imap);
        return;
    }



    CkImap_Dispose(imap);

    }