(MFC) 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++ Libs

See Also: Using MFC CString in Chilkat

#include <CkImap.h>
#include <CkStringBuilder.h>
#include <CkStringTable.h>

void ChilkatSample(void)
    {
    CkString strOut;

    CkImap imap;

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

    // Connect to an IMAP server.
    // Use TLS
    imap.put_Ssl(true);
    imap.put_Port(993);
    bool success = imap.Connect("MY-IMAP-DOMAIN");
    if (success != true) {
        strOut.append(imap.lastErrorText());
        strOut.append("\r\n");
        SetDlgItemText(IDC_EDIT1,strOut.getUnicode());
        return;
    }

    // Login
    success = imap.Login("MY-IMAP-LOGIN","MY-IMAP-PASSWORD");
    if (success != true) {
        strOut.append(imap.lastErrorText());
        strOut.append("\r\n");
        SetDlgItemText(IDC_EDIT1,strOut.getUnicode());
        return;
    }

    // Select an IMAP mailbox
    success = imap.SelectMailbox("INBOX");
    if (success != true) {
        strOut.append(imap.lastErrorText());
        strOut.append("\r\n");
        SetDlgItemText(IDC_EDIT1,strOut.getUnicode());
        return;
    }

    // The LastResponse property contains the full response of the last command.
    const char *selectResponse = imap.lastResponse();
    strOut.append(selectResponse);
    strOut.append("\r\n");

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

    CkStringBuilder sbResponse;
    sbResponse.Append(selectResponse);

    // Get just the list of flags:
    CkStringBuilder sbFlagList;
    sbFlagList.Append(sbResponse.getAfterBetween("* FLAGS","(",")"));
    strOut.append(sbFlagList.getAsString());
    strOut.append("\r\n");

    // 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.
    sbFlagList.TrimInsideSpaces();
    // Modify sbFlagList to one flag per line
    int numReplaced = sbFlagList.Replace(" ","\r\n");

    // Load a StringTable with the flag names.
    CkStringTable flagsTable;
    flagsTable.AppendFromSb(sbFlagList);

    // Iterate over the individual flag names:
    int i = 0;
    while (i < flagsTable.get_Count()) {
        strOut.appendInt(i);
        strOut.append(": ");
        strOut.append(flagsTable.stringAt(i));
        strOut.append("\r\n");
        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
    // 


    SetDlgItemText(IDC_EDIT1,strOut.getUnicode());

    }