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

This example demonstrates how to capture the SELECT (or EXAMINE) response, and parse the list of flags.

Chilkat .NET Downloads

Chilkat .NET Framework

Chilkat for .NET Core

Chilkat.Imap imap = new Chilkat.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.Ssl = true;
imap.Port = 993;
bool success = imap.Connect("MY-IMAP-DOMAIN");
if (success != true) {
    Debug.WriteLine(imap.LastErrorText);
    return;
}

// Login
success = imap.Login("MY-IMAP-LOGIN","MY-IMAP-PASSWORD");
if (success != true) {
    Debug.WriteLine(imap.LastErrorText);
    return;
}

// Select an IMAP mailbox
success = imap.SelectMailbox("INBOX");
if (success != true) {
    Debug.WriteLine(imap.LastErrorText);
    return;
}

// The LastResponse property contains the full response of the last command.
string selectResponse = imap.LastResponse;
Debug.WriteLine(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.

Chilkat.StringBuilder sbResponse = new Chilkat.StringBuilder();
sbResponse.Append(selectResponse);

// Get just the list of flags:
Chilkat.StringBuilder sbFlagList = new Chilkat.StringBuilder();
sbFlagList.Append(sbResponse.GetAfterBetween("* FLAGS","(",")"));
Debug.WriteLine(sbFlagList.GetAsString());

// 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.
Chilkat.StringTable flagsTable = new Chilkat.StringTable();
flagsTable.AppendFromSb(sbFlagList);

// Iterate over the individual flag names:
int i = 0;
while (i < flagsTable.Count) {
    Debug.WriteLine(Convert.ToString(i) + ": " + flagsTable.StringAt(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
//