Store One or More Flags on a Single Message

See more IMAP Examples

Demonstrates the Chilkat Imap.StoreFlags method, which sets or clears one or more flags on a single message identified by ID. The first argument is the message ID, the second (bUid) selects UID vs sequence number, the third is a space-separated list of flag names, and the fourth is the value (1 to set, 0 to clear). This example applies the Seen and Flagged flags to one message by UID.

Background: StoreFlags is the single-message counterpart to SetFlags and lets you change several flags at once by listing them space-separated (without leading backslashes). Because the ID can be either a UID or a sequence number, the bUid argument must match how you obtained it — a UID from a UID search, or a sequence number from a sequence-based operation. UIDs are the safer choice since they remain valid as the mailbox changes.

Chilkat C Downloads

Download Chilkat for C

#include <C_CkImap.h>
#include <C_CkMessageSet.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkImap imap;
    HCkMessageSet msgSet;
    unsigned long uid;

    success = FALSE;

    //  Demonstrates the Imap.StoreFlags method, which sets or clears one or more flags on a single
    //  message identified by ID.  The 1st argument is the message ID, the 2nd (bUid) selects UID
    //  vs sequence number, the 3rd is a space-separated list of flag names, and the 4th is the
    //  value (1 to set, 0 to clear).

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

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

    //  Get the UIDs of all messages.
    msgSet = CkMessageSet_Create();
    success = CkImap_QueryMbx(imap,"ALL",TRUE,msgSet);
    if (success == FALSE) {
        printf("%s\n",CkImap_lastErrorText(imap));
        CkImap_Dispose(imap);
        CkMessageSet_Dispose(msgSet);
        return;
    }

    if (CkMessageSet_getCount(msgSet) > 0) {
        //  Apply the Seen and Flagged flags to the first message.  bUid is TRUE because the ID
        //  came from a UID search.
        uid = CkMessageSet_GetId(msgSet,0);
        success = CkImap_StoreFlags(imap,uid,TRUE,"Seen Flagged",1);
        if (success == FALSE) {
            printf("%s\n",CkImap_lastErrorText(imap));
            CkImap_Dispose(imap);
            CkMessageSet_Dispose(msgSet);
            return;
        }

        printf("Updated flags on UID %u\n",uid);
    }

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



    CkImap_Dispose(imap);
    CkMessageSet_Dispose(msgSet);

    }