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 VB.NET Downloads
Dim success As Boolean = 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://www.googleapis.com/auth/gmail.readonly"
success = oauth.AddAuthQueryParam("access_type","offline")
If (success <> True) Then
Debug.WriteLine("Could not configure offline access.")
Exit Sub
End If
' This is the interactive setup step. Subsequent refreshes use the saved refresh token.
success = oauth.AddAuthQueryParam("prompt","consent")
If (success <> True) Then
Debug.WriteLine("Could not configure consent.")
Exit Sub
End If
Dim authUrl As String = oauth.StartAuth()
If (oauth.LastMethodSuccess <> True) Then
Debug.WriteLine("Could not start the loopback listener.")
Exit Sub
End If
success = oauth.LaunchBrowser(authUrl)
If (success <> True) Then
oauth.Cancel()
Debug.WriteLine("Could not open the system browser.")
Exit Sub
End If
Dim waited As Integer = 0
While ((oauth.AuthFlowState < 3) And (waited < 180000))
oauth.SleepMs(200)
waited = waited + 200
End While
If (oauth.AuthFlowState < 3) Then
oauth.Cancel()
Debug.WriteLine("Authorization timed out.")
Exit Sub
End If
If (oauth.AuthFlowState <> 3) Then
Debug.WriteLine("Authorization did not complete. Flow state: " & oauth.AuthFlowState)
Exit Sub
End If
Dim token As New Chilkat.JsonObject
success = token.Load(oauth.AccessTokenResponse)
If (success <> True) Then
Debug.WriteLine("Could not parse the token response.")
Exit Sub
End If
If ((token.JsonTypeOf("refresh_token") <> 1) Or (token.StringOfEquals("refresh_token","",True) = True)) Then
Debug.WriteLine("No offline refresh token was issued. The existing cache was preserved.")
Exit Sub
End If
success = token.WriteFile("gmail-token.json")
If (success <> True) Then
Debug.WriteLine("Could not save the token file.")
Exit Sub
End If
Debug.WriteLine("Credentials saved in the private working directory.")