(C) IMAP Get List of Flags

When a mailbox is selected, the server response includes a list of flags:

The FLAGS response occurs as a result of a SELECT or EXAMINE command. The flag parenthesized list identifies the flags (at a minimum, the system-defined flags) that are applicable for this mailbox. Flags other than the system flags can also exist, depending on server implementation.

Chilkat C/C++ Library Downloads
MS Visual C/C++ Linux/CentOS C/C++ Alpine Linux C/C++ MAC OS X C/C++	armhf/aarch64 C/C++ C++ Builder iOS C/C++ Android C/C++	Solaris C/C++ MinGW C/C++

#include <C_CkImap.h>
#include <C_CkStringBuilder.h>
#include <C_CkStringTable.h>

void ChilkatSample(void)
    {
    HCkImap imap;
    BOOL success;
    const char *selectResponse;
    HCkStringBuilder sbResponse;
    HCkStringBuilder sbFlagList;
    int numReplaced;
    HCkStringTable flagsTable;
    int i;

    imap = CkImap_Create();

    // This example assumes Chilkat Imap to have been previously unlocked.
    // See Unlock Imap for sample code.

    // Connect to an IMAP server.
    // Use TLS
    CkImap_putSsl(imap,TRUE);
    CkImap_putPort(imap,993);
    success = CkImap_Connect(imap,"MY-IMAP-DOMAIN");
    if (success != TRUE) {
        printf("%s\n",CkImap_lastErrorText(imap));
        CkImap_Dispose(imap);
        return;
    }

    // Login
    success = CkImap_Login(imap,"MY-IMAP-LOGIN","MY-IMAP-PASSWORD");
    if (success != TRUE) {
        printf("%s\n",CkImap_lastErrorText(imap));
        CkImap_Dispose(imap);
        return;
    }

    // Select an IMAP mailbox
    success = CkImap_SelectMailbox(imap,"INBOX");
    if (success != TRUE) {
        printf("%s\n",CkImap_lastErrorText(imap));
        CkImap_Dispose(imap);
        return;
    }

    // The LastResponse property contains the full response of the last command.
    selectResponse = CkImap_lastResponse(imap);
    printf("%s\n",selectResponse);

    // For example, on GMail, the SELECT response looks like this:

    // 	* FLAGS (\Answered \Flagged \Draft \Deleted \Seen $Forwarded $NotPhishing $Phishing $label1 $label2 $label3 $label4 $label5 Junk NonJunk)
    // 	* OK [PERMANENTFLAGS (\Answered \Flagged \Draft \Deleted \Seen $Forwarded $NotPhishing $Phishing $label1 $label2 $label3 $label4 $label5 Junk NonJunk \*)] Flags permitted.
    // 	* OK [UIDVALIDITY 3] UIDs valid.
    // 	* 46 EXISTS
    // 	* 0 RECENT
    // 	* OK [UIDNEXT 4147] Predicted next UID.
    // 	* OK [HIGHESTMODSEQ 402971]
    // 	aaac OK [READ-WRITE] INBOX selected. (Success)

    // The goal of this example is to capture the list of FLAGS.
    // All IMAP servers will respond with the list of flags in a SPACE separated list enclosed in parentheses.

    sbResponse = CkStringBuilder_Create();
    CkStringBuilder_Append(sbResponse,selectResponse);

    // Get just the list of flags:
    sbFlagList = CkStringBuilder_Create();
    CkStringBuilder_Append(sbFlagList,CkStringBuilder_getAfterBetween(sbResponse,"* FLAGS","(",")"));
    printf("%s\n",CkStringBuilder_getAsString(sbFlagList));

    // sbFlagList contains this:  
    // 
    //     \Answered \Flagged \Draft \Deleted \Seen $Forwarded $NotPhishing $Phishing $label1 $label2 $label3 $label4 $label5 Junk NonJunk
    // 

    // Make sure no more than one SPACE char in a row exists.
    CkStringBuilder_TrimInsideSpaces(sbFlagList);
    // Modify sbFlagList to one flag per line
    numReplaced = CkStringBuilder_Replace(sbFlagList," ","\r\n");

    // Load a StringTable with the flag names.
    flagsTable = CkStringTable_Create();
    CkStringTable_AppendFromSb(flagsTable,sbFlagList);

    // Iterate over the individual flag names:
    i = 0;
    while (i < CkStringTable_getCount(flagsTable)) {
        printf("%d: %s\n",i,CkStringTable_stringAt(flagsTable,i));
        i = i + 1;
    }

    // The output is:
    // 
    // 	0: \Answered
    // 	1: \Flagged
    // 	2: \Draft
    // 	3: \Deleted
    // 	4: \Seen
    // 	5: $Forwarded
    // 	6: $NotPhishing
    // 	7: $Phishing
    // 	8: $label1
    // 	9: $label2
    // 	10: $label3
    // 	11: $label4
    // 	12: $label5
    // 	13: Junk
    // 	14: NonJunk
    // 


    CkImap_Dispose(imap);
    CkStringBuilder_Dispose(sbResponse);
    CkStringBuilder_Dispose(sbFlagList);
    CkStringTable_Dispose(flagsTable);

    }