Sample code for 30+ languages & platforms
CkPython Requires Chilkat v11.0.0+

Authorize a desktop application to use Gmail

See more GMail REST API Examples

Enable the Gmail API, configure the OAuth consent screen, and create a Desktop app OAuth client. Launch the system browser and receive the authorization code on a loopback listener. The sample requests read-only access with PKCE and offline access. For another operation, select the scope in that example before authorizing. Gmail scopes.

Run in a private, user-only directory. The file contains bearer credentials. In a deployed application use protected credential storage. To reuse an existing grant, copy the older examples’ qa_data/tokens/gmail.json to gmail-token.json in this private directory. The token retains its original scopes. Gmail clients using IMAP, POP, or SMTP with OAuth need the https://mail.google.com/ scope. Use a separate cache for each user and client.

Google documentation

Chilkat CkPython Downloads

CkPython
import sys
import chilkat

success = False

#  Assumes Chilkat is unlocked. See Global Unlock Sample.

oauth = chilkat.CkOAuth2()
oauth.put_TokenEndpoint("https://oauth2.googleapis.com/token")
oauth.put_ClientId("YOUR_DESKTOP_CLIENT_ID")
oauth.put_ClientSecret("YOUR_DESKTOP_CLIENT_SECRET")

oauth.put_AuthorizationEndpoint("https://accounts.google.com/o/oauth2/v2/auth")
oauth.put_LocalHost("127.0.0.1")
oauth.put_ListenPort(55568)
oauth.put_ListenPortRangeEnd(55578)
oauth.put_CodeChallenge(True)
oauth.put_CodeChallengeMethod("S256")
oauth.put_Scope("https://www.googleapis.com/auth/gmail.readonly")
success = oauth.AddAuthQueryParam("access_type","offline")
if (success != True):
    print("Could not configure offline access.")
    sys.exit()

#  This is the interactive setup step. Subsequent refreshes use the saved refresh token.
success = oauth.AddAuthQueryParam("prompt","consent")
if (success != True):
    print("Could not configure consent.")
    sys.exit()

authUrl = oauth.startAuth()
if (oauth.get_LastMethodSuccess() != True):
    print("Could not start the loopback listener.")
    sys.exit()

success = oauth.LaunchBrowser(authUrl)
if (success != True):
    oauth.Cancel()
    print("Could not open the system browser.")
    sys.exit()

waited = 0
while ((oauth.get_AuthFlowState() < 3) and (waited < 180000)) :
    oauth.SleepMs(200)
    waited = waited + 200

if (oauth.get_AuthFlowState() < 3):
    oauth.Cancel()
    print("Authorization timed out.")
    sys.exit()

if (oauth.get_AuthFlowState() != 3):
    print("Authorization did not complete. Flow state: " + str(oauth.get_AuthFlowState()))
    sys.exit()

token = chilkat.CkJsonObject()
success = token.Load(oauth.accessTokenResponse())
if (success != True):
    print("Could not parse the token response.")
    sys.exit()

if ((token.JsonTypeOf("refresh_token") != 1) or (token.StringOfEquals("refresh_token","",True) == True)):
    print("No offline refresh token was issued. The existing cache was preserved.")
    sys.exit()

success = token.WriteFile("gmail-token.json")
if (success != True):
    print("Could not save the token file.")
    sys.exit()

print("Credentials saved in the private working directory.")