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 CkJava Downloads
import com.chilkatsoft.*;
public class ChilkatExample {
static {
try {
System.loadLibrary("chilkat");
} catch (UnsatisfiedLinkError e) {
System.err.println("Native code library failed to load.\n" + e);
System.exit(1);
}
}
public static void main(String argv[])
{
boolean success = false;
// Assumes Chilkat is unlocked. See Global Unlock Sample.
CkOAuth2 oauth = new 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) {
System.out.println("Could not configure offline access.");
return;
}
// This is the interactive setup step. Subsequent refreshes use the saved refresh token.
success = oauth.AddAuthQueryParam("prompt","consent");
if (success != true) {
System.out.println("Could not configure consent.");
return;
}
String authUrl = oauth.startAuth();
if (oauth.get_LastMethodSuccess() != true) {
System.out.println("Could not start the loopback listener.");
return;
}
success = oauth.LaunchBrowser(authUrl);
if (success != true) {
oauth.Cancel();
System.out.println("Could not open the system browser.");
return;
}
int waited = 0;
while (((oauth.get_AuthFlowState() < 3) && (waited < 180000))) {
oauth.SleepMs(200);
waited = waited+200;
}
if (oauth.get_AuthFlowState() < 3) {
oauth.Cancel();
System.out.println("Authorization timed out.");
return;
}
if (oauth.get_AuthFlowState() != 3) {
System.out.println("Authorization did not complete. Flow state: " + oauth.get_AuthFlowState());
return;
}
CkJsonObject token = new CkJsonObject();
success = token.Load(oauth.accessTokenResponse());
if (success != true) {
System.out.println("Could not parse the token response.");
return;
}
if ((token.JsonTypeOf("refresh_token") != 1) || (token.StringOfEquals("refresh_token","",true) == true)) {
System.out.println("No offline refresh token was issued. The existing cache was preserved.");
return;
}
success = token.WriteFile("gmail-token.json");
if (success != true) {
System.out.println("Could not save the token file.");
return;
}
System.out.println("Credentials saved in the private working directory.");
}
}