Sample code for 30+ languages & platforms
Delphi ActiveX 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 Delphi ActiveX Downloads

Delphi ActiveX
var
success: Integer;
oauth: TChilkatOAuth2;
authUrl: WideString;
waited: Integer;
token: TChilkatJsonObject;

begin
success := 0;

//  Assumes Chilkat is unlocked. See Global Unlock Sample.

oauth := TChilkatOAuth2.Create(Self);
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 := 1;
oauth.CodeChallengeMethod := 'S256';
oauth.Scope := 'https://www.googleapis.com/auth/gmail.readonly';
success := oauth.AddAuthQueryParam('access_type','offline');
if (success <> 1) then
  begin
    Memo1.Lines.Add('Could not configure offline access.');
    Exit;
  end;
//  This is the interactive setup step. Subsequent refreshes use the saved refresh token.
success := oauth.AddAuthQueryParam('prompt','consent');
if (success <> 1) then
  begin
    Memo1.Lines.Add('Could not configure consent.');
    Exit;
  end;
authUrl := oauth.StartAuth();
if (oauth.LastMethodSuccess <> 1) then
  begin
    Memo1.Lines.Add('Could not start the loopback listener.');
    Exit;
  end;
success := oauth.LaunchBrowser(authUrl);
if (success <> 1) then
  begin
    oauth.Cancel();
    Memo1.Lines.Add('Could not open the system browser.');
    Exit;
  end;
waited := 0;
while ((oauth.AuthFlowState < 3) and (waited < 180000)) do
  begin
    oauth.SleepMs(200);
    waited := waited + 200;
  end;

if (oauth.AuthFlowState < 3) then
  begin
    oauth.Cancel();
    Memo1.Lines.Add('Authorization timed out.');
    Exit;
  end;
if (oauth.AuthFlowState <> 3) then
  begin
    Memo1.Lines.Add('Authorization did not complete. Flow state: ' + IntToStr(oauth.AuthFlowState));
    Exit;
  end;
token := TChilkatJsonObject.Create(Self);
success := token.Load(oauth.AccessTokenResponse);
if (success <> 1) then
  begin
    Memo1.Lines.Add('Could not parse the token response.');
    Exit;
  end;
if ((token.JsonTypeOf('refresh_token') <> 1) or (token.StringOfEquals('refresh_token','',1) = 1)) then
  begin
    Memo1.Lines.Add('No offline refresh token was issued. The existing cache was preserved.');
    Exit;
  end;
success := token.WriteFile('gmail-token.json');
if (success <> 1) then
  begin
    Memo1.Lines.Add('Could not save the token file.');
    Exit;
  end;
Memo1.Lines.Add('Credentials saved in the private working directory.');