Sample code for 30+ languages & platforms
CkPython 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 CkPython Downloads

CkPython
import sys
import chilkat

success = False

#  Assumes Chilkat is unlocked. See Global Unlock Sample.

token = chilkat.CkJsonObject()
success = token.LoadFile("gmail-mail-token.json")
if (success != True):
    print("Could not load the protocol token from the private working directory.")
    sys.exit()

if ((token.JsonTypeOf("access_token") != 1) or (token.StringOfEquals("access_token","",True) == True)):
    print("Authorize or refresh the mailbox first.")
    sys.exit()

mailbox = "user@example.com"
imap = chilkat.CkImap()
imap.put_Ssl(True)
imap.put_Port(993)
imap.put_RequireSslCertVerify(True)
imap.put_AuthMethod("XOAUTH2")
success = imap.Connect("imap.gmail.com")
if (success != True):
    print("Could not establish the Gmail IMAP TLS connection.")
    sys.exit()

success = imap.Login(mailbox,token.stringOf("access_token"))
if (success != True):
    imap.Disconnect()
    print("IMAP authentication failed. Check the mailbox, scope, expiry, and account policy.")
    sys.exit()

folders = chilkat.CkMailboxes()
success = imap.MbxList(False,"","*",folders)
if (success != True):
    imap.Logout()
    imap.Disconnect()
    print("Could not list Gmail folders.")
    sys.exit()

#  LIST special-use attributes work with localized folder names. XLIST is obsolete.
special = chilkat.CkJsonObject()
i = 0
while (i < folders.get_Count()) :
    if (folders.IsSelectable(i) == True):
        print(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.put_EmitCompact(False)
print(special.emit())
#  Missing keys mean the folder was not advertised. Do not substitute an English name.