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.
Chilkat PowerShell Downloads
Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"
$success = $false
# Assumes Chilkat is unlocked. See Global Unlock Sample.
$oauth = New-Object 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://www.googleapis.com/auth/gmail.readonly"
$success = $oauth.AddAuthQueryParam("access_type","offline")
if ($success -ne $true) {
$("Could not configure offline access.")
exit
}
# This is the interactive setup step. Subsequent refreshes use the saved refresh token.
$success = $oauth.AddAuthQueryParam("prompt","consent")
if ($success -ne $true) {
$("Could not configure consent.")
exit
}
$authUrl = $oauth.StartAuth()
if ($oauth.LastMethodSuccess -ne $true) {
$("Could not start the loopback listener.")
exit
}
$success = $oauth.LaunchBrowser($authUrl)
if ($success -ne $true) {
$oauth.Cancel()
$("Could not open the system browser.")
exit
}
$waited = 0
while ((($oauth.AuthFlowState -lt 3) -and ($waited -lt 180000))) {
$oauth.SleepMs(200)
$waited = $waited + 200
}
if ($oauth.AuthFlowState -lt 3) {
$oauth.Cancel()
$("Authorization timed out.")
exit
}
if ($oauth.AuthFlowState -ne 3) {
$("Authorization did not complete. Flow state: " + $oauth.AuthFlowState)
exit
}
$token = New-Object Chilkat.JsonObject
$success = $token.Load($oauth.AccessTokenResponse)
if ($success -ne $true) {
$("Could not parse the token response.")
exit
}
if (($token.JsonTypeOf("refresh_token") -ne 1) -or ($token.StringOfEquals("refresh_token","",$true) -eq $true)) {
$("No offline refresh token was issued. The existing cache was preserved.")
exit
}
$success = $token.WriteFile("gmail-token.json")
if ($success -ne $true) {
$("Could not save the token file.")
exit
}
$("Credentials saved in the private working directory.")