Sample code for 30+ languages & platforms
Visual Basic 6.0 Requires Chilkat v11.0.0+

Outlook.com: Obtain Mail OAuth2 Tokens with Desktop PKCE

See more Office365 Examples

Obtain delegated SMTP, IMAP, and POP access with authorization code flow and S256 PKCE. Register a public desktop application in Microsoft Entra with a Mobile and desktop applications loopback redirect URI of http://localhost:3017/. Do not register this callback as a Web or SPA application. No client secret belongs in a distributed desktop application. Run the sample where the user can launch a browser and return to the local listener; it is not a web-server callback example.

Choose an app registration supporting personal Microsoft accounts. The consumers authority permits personal accounts only, including Outlook.com, Hotmail, and Live.

The example requests all three delegated protocol permissions for demonstration. Remove unused scopes in your application. Microsoft Graph scopes and ID tokens are not substitutes for mail-protocol access tokens. The user may need consent again after revocation or policy changes; refresh is not guaranteed indefinitely.

Create qa_data/tokens in a private, access-controlled working directory before running. The saved JSON contains credentials, not just settings. Use separate caches per account, app, and authority; prevent concurrent writers, use an OS credential store in production, and never publish token responses. The sample validates the response before writing, but a production cache also needs atomic replacement and recovery from write failures.

Microsoft reference documentation

Chilkat Visual Basic 6.0 Downloads

Visual Basic 6.0
Dim success As Long
success = 0

'  Assumes Chilkat is unlocked. See Global Unlock Sample.

Dim oauth As New ChilkatOAuth2
oauth.TokenEndpoint = "https://login.microsoftonline.com/consumers/oauth2/v2.0/token"
oauth.ClientId = "CLIENT_ID"
'  A public desktop client does not have a client secret.

oauth.AuthorizationEndpoint = "https://login.microsoftonline.com/consumers/oauth2/v2.0/authorize"
oauth.LocalHost = "localhost"
oauth.ListenPort = 3017
oauth.CodeChallenge = 1
oauth.CodeChallengeMethod = "S256"
'  Request only the protocols your application needs; this sample covers all three.
oauth.Scope = "offline_access https://outlook.office.com/SMTP.Send https://outlook.office.com/IMAP.AccessAsUser.All https://outlook.office.com/POP.AccessAsUser.All"
success = oauth.AddAuthQueryParam("prompt","select_account")
If (success <> 1) Then
    Debug.Print "Could not configure account selection."
    Exit Sub
End If

Dim authUrl As String
authUrl = oauth.StartAuth()
If (oauth.LastMethodSuccess <> 1) Then
    Debug.Print "Could not start the loopback listener."
    Exit Sub
End If

success = oauth.LaunchBrowser(authUrl)
If (success <> 1) Then
    success = oauth.Cancel()
    Debug.Print "Could not open the system browser."
    Exit Sub
End If

Dim waited As Long
waited = 0
Do While ((oauth.AuthFlowState < 3) And (waited < 180000))
    oauth.SleepMs 200
    waited = waited + 200
Loop
If (oauth.AuthFlowState < 3) Then
    success = oauth.Cancel()
    Debug.Print "Authorization timed out."
    Exit Sub
End If

If (oauth.AuthFlowState <> 3) Then
    Debug.Print "Authorization did not complete. Flow state: " & oauth.AuthFlowState
    Exit Sub
End If

Dim token As New ChilkatJsonObject
success = token.Load(oauth.AccessTokenResponse)
If (success <> 1) Then
    Debug.Print "Could not parse the token response."
    Exit Sub
End If

If ((token.JsonTypeOf("refresh_token") <> 1) Or (token.StringOfEquals("refresh_token","",1) = 1)) Then
    Debug.Print "No offline refresh token was issued. The existing cache was preserved."
    Exit Sub
End If

If ((token.JsonTypeOf("access_token") <> 1) Or (token.StringOfEquals("access_token","",1) = 1)) Then
    Debug.Print "The response did not contain an access token. The existing cache was preserved."
    Exit Sub
End If

Dim obtained As New CkDateTime
success = obtained.SetFromCurrentSystemTime()
success = token.UpdateString("obtained_at",obtained.GetAsTimestamp(0))
'  The token response includes expires_in (seconds). Refresh before the access token expires.
'  The file contains credentials: use a private, access-controlled directory.
success = token.WriteFile("qa_data/tokens/hotmail.json")
If (success <> 1) Then
    Debug.Print "Could not save the token file."
    Exit Sub
End If

Debug.Print "Credentials saved in the private working directory."