Sample code for 30+ languages & platforms
Delphi DLL Requires Chilkat v11.0.0+

Gmail SMTP, IMAP, and POP3: Obtain an OAuth2 Token

See more OAuth2 Examples

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.

Google documentation

Chilkat Delphi DLL Downloads

Delphi DLL
var
success: Boolean;
oauth: HCkOAuth2;
authUrl: PWideChar;
waited: Integer;
token: HCkJsonObject;
obtained: HCkDateTime;

begin
success := False;

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

oauth := CkOAuth2_Create();
CkOAuth2_putTokenEndpoint(oauth,'https://oauth2.googleapis.com/token');
CkOAuth2_putClientId(oauth,'YOUR_DESKTOP_CLIENT_ID');
CkOAuth2_putClientSecret(oauth,'YOUR_DESKTOP_CLIENT_SECRET');

CkOAuth2_putAuthorizationEndpoint(oauth,'https://accounts.google.com/o/oauth2/v2/auth');
CkOAuth2_putLocalHost(oauth,'127.0.0.1');
CkOAuth2_putListenPort(oauth,55568);
CkOAuth2_putListenPortRangeEnd(oauth,55578);
CkOAuth2_putCodeChallenge(oauth,True);
CkOAuth2_putCodeChallengeMethod(oauth,'S256');
CkOAuth2_putScope(oauth,'https://mail.google.com/');
success := CkOAuth2_AddAuthQueryParam(oauth,'access_type','offline');
if (success <> True) 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 := CkOAuth2_AddAuthQueryParam(oauth,'prompt','consent');
if (success <> True) then
  begin
    Memo1.Lines.Add('Could not configure consent.');
    Exit;
  end;
authUrl := CkOAuth2__startAuth(oauth);
if (CkOAuth2_getLastMethodSuccess(oauth) <> True) then
  begin
    Memo1.Lines.Add('Could not start the loopback listener.');
    Exit;
  end;
success := CkOAuth2_LaunchBrowser(oauth,authUrl);
if (success <> True) then
  begin
    CkOAuth2_Cancel(oauth);
    Memo1.Lines.Add('Could not open the system browser.');
    Exit;
  end;
waited := 0;
while ((CkOAuth2_getAuthFlowState(oauth) < 3) and (waited < 180000)) do
  begin
    CkOAuth2_SleepMs(oauth,200);
    waited := waited + 200;
  end;

if (CkOAuth2_getAuthFlowState(oauth) < 3) then
  begin
    CkOAuth2_Cancel(oauth);
    Memo1.Lines.Add('Authorization timed out.');
    Exit;
  end;
if (CkOAuth2_getAuthFlowState(oauth) <> 3) then
  begin
    Memo1.Lines.Add('Authorization did not complete. Flow state: ' + IntToStr(CkOAuth2_getAuthFlowState(oauth)));
    Exit;
  end;
token := CkJsonObject_Create();
success := CkJsonObject_Load(token,CkOAuth2__accessTokenResponse(oauth));
if (success <> True) then
  begin
    Memo1.Lines.Add('Could not parse the token response.');
    Exit;
  end;
if ((CkJsonObject_JsonTypeOf(token,'refresh_token') <> 1) or (CkJsonObject_StringOfEquals(token,'refresh_token','',True) = True)) then
  begin
    Memo1.Lines.Add('No offline refresh token was issued. The existing cache was preserved.');
    Exit;
  end;
if ((CkJsonObject_JsonTypeOf(token,'access_token') <> 1) or (CkJsonObject_StringOfEquals(token,'access_token','',True) = True)) then
  begin
    Memo1.Lines.Add('The response did not contain an access token. The existing cache was preserved.');
    Exit;
  end;
obtained := CkDateTime_Create();
CkDateTime_SetFromCurrentSystemTime(obtained);
CkJsonObject_UpdateString(token,'obtained_at',CkDateTime__getAsTimestamp(obtained,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 := CkJsonObject_WriteFile(token,'gmail-mail-token.json');
if (success <> True) then
  begin
    Memo1.Lines.Add('Could not save the token file.');
    Exit;
  end;
Memo1.Lines.Add('Credentials saved in the private working directory.');

CkOAuth2_Dispose(oauth);
CkJsonObject_Dispose(token);
CkDateTime_Dispose(obtained);