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 C# Downloads
bool success = false;
// Assumes Chilkat is unlocked. See Global Unlock Sample.
Chilkat.OAuth2 oauth = new Chilkat.OAuth2();
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 = true;
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 != true) {
Debug.WriteLine("Could not configure account selection.");
return;
}
string authUrl = oauth.StartAuth();
if (oauth.LastMethodSuccess != true) {
Debug.WriteLine("Could not start the loopback listener.");
return;
}
success = oauth.LaunchBrowser(authUrl);
if (success != true) {
oauth.Cancel();
Debug.WriteLine("Could not open the system browser.");
return;
}
int waited = 0;
while (((oauth.AuthFlowState < 3) && (waited < 180000))) {
oauth.SleepMs(200);
waited = waited + 200;
}
if (oauth.AuthFlowState < 3) {
oauth.Cancel();
Debug.WriteLine("Authorization timed out.");
return;
}
if (oauth.AuthFlowState != 3) {
Debug.WriteLine("Authorization did not complete. Flow state: " + Convert.ToString(oauth.AuthFlowState));
return;
}
Chilkat.JsonObject token = new Chilkat.JsonObject();
success = token.Load(oauth.AccessTokenResponse);
if (success != true) {
Debug.WriteLine("Could not parse the token response.");
return;
}
if ((token.JsonTypeOf("refresh_token") != 1) || (token.StringOfEquals("refresh_token","",true) == true)) {
Debug.WriteLine("No offline refresh token was issued. The existing cache was preserved.");
return;
}
if ((token.JsonTypeOf("access_token") != 1) || (token.StringOfEquals("access_token","",true) == true)) {
Debug.WriteLine("The response did not contain an access token. The existing cache was preserved.");
return;
}
Chilkat.CkDateTime obtained = new Chilkat.CkDateTime();
obtained.SetFromCurrentSystemTime();
token.UpdateString("obtained_at",obtained.GetAsTimestamp(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 = token.WriteFile("qa_data/tokens/hotmail.json");
if (success != true) {
Debug.WriteLine("Could not save the token file.");
return;
}
Debug.WriteLine("Credentials saved in the private working directory.");