Gmail IMAP: Obtain an OAuth2 Token
See more GMail SMTP/IMAP/POP Examples
This page is retained for existing links. It uses the same full-mail authorization as the shared Gmail protocol authorization example.
Obtain a Gmail OAuth2 access token and an offline refresh token for a desktop application using the system browser and a loopback listener. This one authorization works with SMTP, IMAP, and POP3 for the same account; a separate consent flow for each protocol is unnecessary.
In Google Cloud, configure the consent screen and create an OAuth client of type Desktop app. Supply that client's ID and secret. Add the account as a test user while an external app is in Testing. Desktop clients are public clients: an embedded client secret is not a reliable secret. This example uses PKCE with S256 and Chilkat's authorization state handling. The browser and application must run on the same computer; this is not a web-backend redirect handler.
access_type=offline requests a refresh token; prompt=consent is used for this initial setup. Subsequent runs should refresh the saved grant instead of prompting every time. The checked file write saves gmail-mail-token.json in a private working directory without printing credentials. Use one cache per account and OAuth client. Applications with concurrent jobs should serialize and atomically replace cache files.
For an external application in Testing, a refresh token with the mail scope normally expires after seven days. Revocation, account password changes, and organization policies can also require fresh authorization. An access token is short-lived; use its expires_in and the saved UTC obtained_at, allowing a clock margin, to schedule refresh.
Gmail SMTP, IMAP, and POP3 use the https://mail.google.com/ OAuth scope. Narrower Gmail REST scopes such as gmail.send or gmail.readonly do not authorize these protocols. Public applications using this restricted scope must meet Google's verification requirements. See Gmail OAuth scopes and XOAUTH2.
Chilkat Xojo Plugin Downloads
Dim success As Boolean
success = False
// Assumes Chilkat is unlocked. See Global Unlock Sample.
Dim oauth As New Chilkat.OAuth2
oauth.TokenEndpoint = "https://oauth2.googleapis.com/token"
oauth.ClientId = "YOUR_DESKTOP_CLIENT_ID"
oauth.ClientSecret = "YOUR_DESKTOP_CLIENT_SECRET"
oauth.AuthorizationEndpoint = "https://accounts.google.com/o/oauth2/v2/auth"
oauth.LocalHost = "127.0.0.1"
oauth.ListenPort = 55568
oauth.ListenPortRangeEnd = 55578
oauth.CodeChallenge = True
oauth.CodeChallengeMethod = "S256"
oauth.Scope = "https://mail.google.com/"
success = oauth.AddAuthQueryParam("access_type","offline")
If (success <> True) Then
System.DebugLog("Could not configure offline access.")
Return
End If
// This is the interactive setup step. Subsequent refreshes use the saved refresh token.
success = oauth.AddAuthQueryParam("prompt","consent")
If (success <> True) Then
System.DebugLog("Could not configure consent.")
Return
End If
Dim authUrl As String
authUrl = oauth.StartAuth()
If (oauth.LastMethodSuccess <> True) Then
System.DebugLog("Could not start the loopback listener.")
Return
End If
success = oauth.LaunchBrowser(authUrl)
If (success <> True) Then
success = oauth.Cancel()
System.DebugLog("Could not open the system browser.")
Return
End If
Dim waited As Int32
waited = 0
While ((oauth.AuthFlowState < 3) And (waited < 180000))
oauth.SleepMs 200
waited = waited + 200
Wend
If (oauth.AuthFlowState < 3) Then
success = oauth.Cancel()
System.DebugLog("Authorization timed out.")
Return
End If
If (oauth.AuthFlowState <> 3) Then
System.DebugLog("Authorization did not complete. Flow state: " + Str(oauth.AuthFlowState))
Return
End If
Dim token As New Chilkat.JsonObject
success = token.Load(oauth.AccessTokenResponse)
If (success <> True) Then
System.DebugLog("Could not parse the token response.")
Return
End If
If ((token.JsonTypeOf("refresh_token") <> 1) Or (token.StringOfEquals("refresh_token","",True) = True)) Then
System.DebugLog("No offline refresh token was issued. The existing cache was preserved.")
Return
End If
If ((token.JsonTypeOf("access_token") <> 1) Or (token.StringOfEquals("access_token","",True) = True)) Then
System.DebugLog("The response did not contain an access token. The existing cache was preserved.")
Return
End If
Dim obtained As New Chilkat.CkDateTime
success = obtained.SetFromCurrentSystemTime()
success = token.UpdateString("obtained_at",obtained.GetAsTimestamp(False))
// The token response includes expires_in (seconds). Refresh before the access token expires.
// The file contains credentials: use a private, access-controlled directory.
success = token.WriteFile("gmail-mail-token.json")
If (success <> True) Then
System.DebugLog("Could not save the token file.")
Return
End If
System.DebugLog("Credentials saved in the private working directory.")