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

Gmail IMAP: Discover Special Folders

See more GMail SMTP/IMAP/POP Examples

Find Gmail special folders from the attributes returned by LIST, using MbxList and Mailboxes.HasFlag. The result maps roles such as Sent and Trash to the server-provided mailbox names. Chilkat decodes mailbox names for use with its mailbox methods.

Folder names can be localized and visibility can differ by account. The role attributes are stable; do not hard-code [Gmail]/Sent Mail or use the deprecated XLIST command. INBOX is a protocol-defined name. Missing map keys indicate folders not advertised by the server.

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;

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

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

//  LIST special-use attributes work with localized folder names. XLIST is obsolete.
Chilkat.JsonObject special = new Chilkat.JsonObject();
int i = 0;
while ((i < folders.Count)) {
    if (folders.IsSelectable(i) == true) {
        Debug.WriteLine(folders.GetName(i) + "  " + folders.GetFlags(i));
        if (folders.HasFlag(i,"\\All") == true) {
            special.UpdateString("allMail",folders.GetName(i));
        }

        if (folders.HasFlag(i,"\\Sent") == true) {
            special.UpdateString("sent",folders.GetName(i));
        }

        if (folders.HasFlag(i,"\\Drafts") == true) {
            special.UpdateString("drafts",folders.GetName(i));
        }

        if (folders.HasFlag(i,"\\Junk") == true) {
            special.UpdateString("spam",folders.GetName(i));
        }

        if (folders.HasFlag(i,"\\Trash") == true) {
            special.UpdateString("trash",folders.GetName(i));
        }

        if (folders.HasFlag(i,"\\Flagged") == true) {
            special.UpdateString("starred",folders.GetName(i));
        }

        if (folders.HasFlag(i,"\\Important") == true) {
            special.UpdateString("important",folders.GetName(i));
        }

    }

    i = i + 1;
}

imap.Logout();
imap.Disconnect();
special.EmitCompact = false;
Debug.WriteLine(special.Emit());
//  Missing keys mean the folder was not advertised. Do not substitute an English name.