Sample code for 30+ languages & platforms
C# Requires Chilkat v11.1.0+

Gmail IMAP: Read, Add, or Remove Message Labels

See more GMail SMTP/IMAP/POP Examples

Locate a message in INBOX by its decimal Gmail message ID, then read its labels or add/remove one custom label with X-GM-LABELS. The default action is read. Changing action to add or remove modifies the mailbox. Obtain the message ID from the message and thread IDs example.

The code changes only the specified custom label and preserves other labels. A message shown under several labels is still one Gmail message. System labels have different semantics; use the archive/Trash example for those operations. If the message left INBOX, select its current mailbox before searching.

This focused raw-command example accepts printable ASCII custom labels beginning with a letter or digit, escapes quotes and backslashes, and displays the returned label list in IMAP syntax. Non-ASCII names require IMAP modified UTF-7 encoding. The response is not parsed by splitting on spaces because quoted names can contain spaces.

Use the mailbox that authorized the full-mail scope https://mail.google.com/. Obtain the protocol OAuth token and refresh it before running this example. The token is loaded from gmail-mail-token.json in a private working directory; a narrow Gmail REST token is insufficient.

Google documentation

Chilkat C# Downloads

C#
bool success = false;

int replacements;
//  Assumes Chilkat is unlocked. See Global Unlock Sample.

Chilkat.StringBuilder statusText = new Chilkat.StringBuilder();
Chilkat.JsonObject statusMatch = new Chilkat.JsonObject();
int completed;
Chilkat.JsonObject token = new Chilkat.JsonObject();
success = token.LoadFile("gmail-mail-token.json");
if (success != true) {
    Debug.WriteLine("Could not load the protocol token from the private working directory.");
    return;
}

if ((token.JsonTypeOf("access_token") != 1) || (token.StringOfEquals("access_token","",true) == true)) {
    Debug.WriteLine("Authorize or refresh the mailbox first.");
    return;
}

string mailbox = "user@example.com";
Chilkat.Imap imap = new Chilkat.Imap();
imap.Ssl = true;
imap.Port = 993;
imap.RequireSslCertVerify = true;
imap.AuthMethod = "XOAUTH2";
success = imap.Connect("imap.gmail.com");
if (success != true) {
    Debug.WriteLine("Could not establish the Gmail IMAP TLS connection.");
    return;
}

success = imap.Login(mailbox,token.StringOf("access_token"));
if (success != true) {
    imap.Disconnect();
    Debug.WriteLine("IMAP authentication failed. Check the mailbox, scope, expiry, and account policy.");
    return;
}

string capabilities = imap.Capability();
if ((imap.LastMethodSuccess != true) || (imap.HasCapability("X-GM-EXT-1",capabilities) != true)) {
    imap.Logout();
    imap.Disconnect();
    Debug.WriteLine("Gmail IMAP extensions are unavailable.");
    return;
}

success = imap.SelectMailbox("INBOX");
if (success != true) {
    imap.Logout();
    imap.Disconnect();
    Debug.WriteLine("Could not open INBOX.");
    return;
}

//  Obtain this decimal string from the Gmail message/thread ID example.
string gmailMessageId = "1278455344230334865";
Chilkat.StringBuilder idText = new Chilkat.StringBuilder();
idText.Append(gmailMessageId);
Chilkat.JsonObject validation = new Chilkat.JsonObject();
int matches = idText.RegexMatch("\\A[1-9][0-9]{0,19}\\z",validation,1000);
if (matches != 1) {
    imap.Logout();
    imap.Disconnect();
    Debug.WriteLine("Expected a decimal Gmail message ID string.");
    return;
}

Chilkat.MessageSet target = new Chilkat.MessageSet();
Chilkat.StringBuilder joined1 = new Chilkat.StringBuilder();
joined1.Append("X-GM-MSGID ");
joined1.Append(gmailMessageId);
success = imap.QueryMbx(joined1.GetAsString(),true,target);
if (success != true) {
    imap.Logout();
    imap.Disconnect();
    Debug.WriteLine("Could not find the Gmail message in the selected mailbox.");
    return;
}

if (target.Count != 1) {
    imap.Logout();
    imap.Disconnect();
    Debug.WriteLine("Expected one message in the selected mailbox. Matches: " + Convert.ToString(target.Count));
    return;
}

string uid = target.ToCompactString();
//  Choose read, add, or remove. Only add/remove changes the message.
string action = "read";
string label = "Example label";
if ((action != "read") && (action != "add") && (action != "remove")) {
    imap.Logout();
    imap.Disconnect();
    Debug.WriteLine("Choose read, add, or remove.");
    return;
}

Chilkat.StringBuilder labelText = new Chilkat.StringBuilder();
labelText.Append(label);
//  This raw-command example accepts printable ASCII custom labels only.
//  For non-ASCII labels, encode modified UTF-7 before quoting the command argument.
matches = labelText.RegexMatch("\\A[A-Za-z0-9][\\x20-\\x7e]*\\z",validation,1000);
if (matches != 1) {
    imap.Logout();
    imap.Disconnect();
    Debug.WriteLine("Use a printable ASCII custom label starting with a letter or digit.");
    return;
}

replacements = labelText.Replace("\\","\\\\");
replacements = labelText.Replace("\"","\\\"");
string response;
string command;
if (action != "read") {
    string operation = "+X-GM-LABELS.SILENT";
    if (action == "remove") {
        operation = "-X-GM-LABELS.SILENT";
    }

    Chilkat.StringBuilder joined2 = new Chilkat.StringBuilder();
    joined2.Append("UID STORE ");
    joined2.Append(uid);
    joined2.Append(" ");
    joined2.Append(operation);
    joined2.Append(" (\"");
    joined2.Append(labelText.GetAsString());
    joined2.Append("\")");
    command = joined2.GetAsString();
    response = imap.SendRawCommand(command);
    statusText.SetString(response);
    //  A completed raw exchange can still return NO or BAD. Require tagged OK.
    completed = statusText.RegexMatch("(?i)(?:\\A|\\r\\n)[^*+ \\r\\n]+ OK[^\\r\\n]*\\r?\\n?\\z",statusMatch,1000);

    if ((imap.LastMethodSuccess != true) || (completed != 1)) {
        imap.Logout();
        imap.Disconnect();
        Debug.WriteLine("Label update failed. Check the custom label and mailbox permissions.");
        return;
    }

}

Chilkat.StringBuilder joined3 = new Chilkat.StringBuilder();
joined3.Append("UID FETCH ");
joined3.Append(uid);
joined3.Append(" (X-GM-LABELS)");
response = imap.SendRawCommand(joined3.GetAsString());
statusText.SetString(response);
//  A completed raw exchange can still return NO or BAD. Require tagged OK.
completed = statusText.RegexMatch("(?i)(?:\\A|\\r\\n)[^*+ \\r\\n]+ OK[^\\r\\n]*\\r?\\n?\\z",statusMatch,1000);

if ((imap.LastMethodSuccess != true) || (completed != 1)) {
    imap.Logout();
    imap.Disconnect();
    Debug.WriteLine("Could not read the message labels.");
    return;
}

//  Display the server's label-list syntax, including quoted/encoded names.
//  This is a FETCH response, not an authentication/session log.
Debug.WriteLine(response);
imap.Logout();
imap.Disconnect();