(Delphi ActiveX) Hotmail OAuth2 Access Token for SMTP, IMAP, POP

See more OAuth2 Examples

Note: It is only the initial access token that must be obtained interactively using a browser (see the code and comments below). Once the initial OAuth2 access token is obtained, then it can refreshed indefinitely with no user interaction.

Note: This example requires Chilkat v10.1.2 or greater.

Chilkat for Delphi Downloads Chilkat ActiveX DLL for Delphi Chilkat non-ActiveX DLL for Delphi * The examples here use the ActiveX DLL.

uses
    Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
    Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, Chilkat_TLB;

...

procedure TForm1.Button1Click(Sender: TObject);
var
oauth2: TChilkatOAuth2;
url: WideString;
success: Integer;
numMsWaited: Integer;
json: TChilkatJsonObject;
fac: TCkFileAccess;

begin
// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

oauth2 := TChilkatOAuth2.Create(Self);

// This should be the port in the localhost callback URL for your app.  
// The callback URL would look like "http://localhost:3017/" if the port number is 3017.
oauth2.ListenPort := 3017;

// See Microsoft OAuth2 Authorization Endpoint
oauth2.AuthorizationEndpoint := 'https://login.microsoftonline.com/common/oauth2/v2.0/authorize';
oauth2.TokenEndpoint := 'https://login.microsoftonline.com/common/oauth2/v2.0/token';

// Replace this with your actual App Registration's Application (client) ID.
oauth2.ClientId := 'CLIENT_ID';

// This is for Require Proof Key for Code Exchange (PKCE)
// See OAuth2 PKCE Explained
oauth2.CodeChallenge := 1;
oauth2.CodeChallengeMethod := 'S256';

// Provide a SPACE separated list of scopes.
// Important: The offline_access scope is needed to get a refresh token.
oauth2.Scope := 'openid profile offline_access https://outlook.office.com/SMTP.Send https://outlook.office.com/IMAP.AccessAsUser.All https://outlook.office.com/POP.AccessAsUser.All';

// ----------------------------------------------------------------------
// Note: It is only the initial access token that must be obtained interactively using a browser.  
// Once the initial OAuth2 access token is obtained, then it can refreshed indefinitely with no user interaction.
// ----------------------------------------------------------------------

// Begin the OAuth2 Authorization code flow.  This returns a URL that should be loaded in a browser.
url := oauth2.StartAuth();
if (oauth2.LastMethodSuccess <> 1) then
  begin
    Memo1.Lines.Add(oauth2.LastErrorText);
    Exit;
  end;

Memo1.Lines.Add('url = ' + url);

// Launch the default browser on the system and navigate to the url.
// The LaunchBrowser method was added in Chilkat v10.1.2.
success := oauth2.LaunchBrowser(url);
if (success = 0) then
  begin
    Memo1.Lines.Add(oauth2.LastErrorText);
    Exit;
  end;

// Wait for the user to approve or deny authorization in the browser.
numMsWaited := 0;
while (numMsWaited < 90000) and (oauth2.AuthFlowState < 3) do
  begin
    oauth2.SleepMs(100);
    numMsWaited := numMsWaited + 100;
  end;

// If the browser does not respond within the specified time, AuthFlowState will be:
// 
// 1: Waiting for Redirect - The OAuth2 background thread is waiting for the browser's redirect request.
// 2: Waiting for Final Response - The thread is awaiting the final access token response.
// In either case, cancel the background task initiated by StartAuth.

if (oauth2.AuthFlowState < 3) then
  begin
    oauth2.Cancel();
    Memo1.Lines.Add('No response from the browser!');
    Exit;
  end;

// Check AuthFlowState to determine if authorization was granted, denied, or failed:
// 
// 3: Success - OAuth2 flow completed, the background thread exited, and the successful response is in AccessTokenResponse.
// 4: Access Denied - OAuth2 flow completed, the background thread exited, and the error response is in AccessTokenResponse.
// 5: Failure - OAuth2 flow failed before completion, the background thread exited, and error details are in FailureInfo.

if (oauth2.AuthFlowState = 5) then
  begin
    Memo1.Lines.Add('OAuth2 failed to complete.');
    Memo1.Lines.Add(oauth2.FailureInfo);
    Exit;
  end;

if (oauth2.AuthFlowState = 4) then
  begin
    Memo1.Lines.Add('OAuth2 authorization was denied.');
    Memo1.Lines.Add(oauth2.AccessTokenResponse);
    Exit;
  end;

if (oauth2.AuthFlowState <> 3) then
  begin
    Memo1.Lines.Add('Unexpected AuthFlowState:' + IntToStr(oauth2.AuthFlowState));
    Exit;
  end;

Memo1.Lines.Add('OAuth2 authorization granted!');
Memo1.Lines.Add('Access Token = ' + oauth2.AccessToken);

// Get the full JSON response:
json := TChilkatJsonObject.Create(Self);
json.Load(oauth2.AccessTokenResponse);
json.EmitCompact := 0;

// The JSON response looks like this:
// 
// {
//   "token_type": "Bearer",
//   "scope": "IMAP.AccessAsUser.All openid POP.AccessAsUser.All profile SMTP.Send email",
//   "expires_in": 3599,
//   "ext_expires_in": 3599,
//   "access_token": "...",
//   "refresh_token": "...",
//   "id_token": "...",
//   "expires_on": "1592748507"
// }

Memo1.Lines.Add(json.Emit());

// Save the JSON to a file for future requests.
fac := TCkFileAccess.Create(Self);
fac.WriteEntireTextFile('qa_data/tokens/hotmail.json',json.Emit(),'utf-8',0);
end;