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

Gmail IMAP: Search with Gmail Search Syntax

See more GMail SMTP/IMAP/POP Examples

Search with Gmail operators through X-GM-RAW, using QueryMbx to obtain UIDs. The example discovers All Mail and opens it read-only. It quotes the query for the IMAP command rather than URL-encoding it.

IMAP search is limited to the selected mailbox. All Mail normally covers inbox and archived messages, but excludes Spam and Trash; a Gmail search operator cannot expand an IMAP search beyond its selected mailbox. An empty result is successful. Returned IMAP UIDs are mailbox-specific and are not Gmail message IDs. Persist them only with their mailbox and UIDVALIDITY.

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

Chilkat.Mailboxes folders = new Chilkat.Mailboxes();
success = imap.MbxList(false,"","*",folders);
if (success != true) {
    imap.Logout();
    imap.Disconnect();
    Debug.WriteLine("Could not list Gmail folders.");
    return;
}

string allMail = "";
int folderMatches = 0;
int f = 0;
while ((f < folders.Count)) {
    if ((folders.HasFlag(f,"\\All") == true) && (folders.IsSelectable(f) == true)) {
        allMail = folders.GetName(f);
        folderMatches = folderMatches + 1;
    }

    f = f + 1;
}

if (folderMatches != 1) {
    imap.Logout();
    imap.Disconnect();
    Debug.WriteLine("Expected one selectable folder with the \\All special-use attribute. Check label visibility.");
    return;
}

success = imap.ExamineMailbox(allMail);
if (success != true) {
    imap.Logout();
    imap.Disconnect();
    Debug.WriteLine("Could not open All Mail read-only.");
    return;
}

//  This search uses Gmail syntax inside a quoted IMAP search argument.
string query = "has:attachment from:sender@example.net";
Chilkat.StringBuilder quoted = new Chilkat.StringBuilder();
quoted.Append(query);
if ((quoted.Contains("\r",true) == true) || (quoted.Contains("\n",true) == true)) {
    imap.Logout();
    imap.Disconnect();
    Debug.WriteLine("A search query must not contain CR or LF.");
    return;
}

replacements = quoted.Replace("\\","\\\\");
replacements = quoted.Replace("\"","\\\"");
Chilkat.StringBuilder joined1 = new Chilkat.StringBuilder();
joined1.Append("X-GM-RAW \"");
joined1.Append(quoted.GetAsString());
joined1.Append("\"");
string criteria = joined1.GetAsString();
Chilkat.MessageSet found = new Chilkat.MessageSet();
success = imap.QueryMbx(criteria,true,found);
if (success != true) {
    imap.Logout();
    imap.Disconnect();
    Debug.WriteLine("Gmail search failed.");
    return;
}

//  Preserve UIDs as text. They belong to this mailbox and its UIDVALIDITY.
Debug.WriteLine("Matching messages: " + Convert.ToString(found.Count));
Debug.WriteLine("UID set: " + found.ToCompactString());
imap.Logout();
imap.Disconnect();