(PHP Extension) IMAP Auto-Refresh Office365 Access Token

See more Office365 Examples

Demonstrates how to automatically recover from an expired access token when OAuth2 authentication fails in the IMAP protocol. If the server responds with "NO AUTHENTICATE failed.", then we refresh the access token and retry.

Chilkat PHP Downloads PHP Extension for Windows, Linux, MacOS, Alpine Linux, Solaris

<?php

// The version number (9_5_0) should match version of the Chilkat extension used, omitting the micro-version number.
// For example, if using Chilkat v9.5.0.48, then include as shown here:
include("chilkat_9_5_0.php");

// An Office365 OAuth2 access token must first be obtained prior
// to running this code.

// Getting the OAuth2 access token for the 1st time requires the O365 account owner's 
// interactive authorizaition via a web browser.  Afterwards, the access token
// can be repeatedly refreshed automatically.

// See the following examples for getting and refreshing an OAuth2 access token

// Get Office365 SMTP/IMAP/POP3 OAuth2 Access Token
// Refresh Office365 SMTP/IMAP/POP3 OAuth2 Access Token

// First get our previously obtained OAuth2 access token.
$jsonToken = new CkJsonObject();
$success = $jsonToken->LoadFile('qa_data/tokens/office365.json');
if ($success == false) {
    print 'Failed to open the office365 OAuth JSON file.' . "\n";
    exit;
}

$imap = new CkImap();

$imap->put_Ssl(true);
$imap->put_Port(993);

// Connect to the Office365 IMAP server.
$success = $imap->Connect('outlook.office365.com');
if ($success != true) {
    print $imap->lastErrorText() . "\n";
    exit;
}

// Use OAuth2 authentication.
$imap->put_AuthMethod('XOAUTH2');

// Login using our username (i.e. email address) and the access token for the password.
$success = $imap->Login('OFFICE365_EMAIL_ADDRESS',$jsonToken->stringOf('access_token'));
if ($success != true) {
    $loginLastErrorText = $imap->lastErrorText();

    // If we're still connected to the mail server, then it means the server sent a non-success response,
    // Such as:  NO AUTHENTICATE failed.
    if ($imap->IsConnected() == true) {

        // Refresh the OAuth2 access token, and if successful, save the new (refreshed) access token and try authenticating again.
        $oauth2 = new CkOAuth2();

        // Use your actual Directory (tenant) ID instead of "112d7ed6-71bf-4eba-a866-738364321bfc"
        $oauth2->put_TokenEndpoint('https://login.microsoftonline.com/112d7ed6-71bf-4eba-a866-738364321bfc/oauth2/v2.0/token');

        // Replace these with your Azure App Registration's actual values.
        $oauth2->put_ClientId('CLIENT_ID');
        $oauth2->put_ClientSecret('CLIENT_SECRET');

        // Get the "refresh_token"
        $oauth2->put_RefreshToken($jsonToken->stringOf('refresh_token'));

        // Send the HTTP POST to refresh the access token..
        $success = $oauth2->RefreshAccessToken();
        if ($success != true) {
            print $oauth2->lastErrorText() . "\n";
            exit;
        }

        print 'New access token: ' . $oauth2->accessToken() . "\n";
        print 'New refresh token: ' . $oauth2->refreshToken() . "\n";

        // Update the JSON with the new tokens.
        $jsonToken->UpdateString('access_token',$oauth2->accessToken());
        $jsonToken->UpdateString('refresh_token',$oauth2->refreshToken());

        // Save the new JSON access token response to a file.
        $sbJson = new CkStringBuilder();
        $jsonToken->put_EmitCompact(false);
        $jsonToken->EmitSb($sbJson);
        $sbJson->WriteFile('qa_data/tokens/office365.json','utf-8',false);

        print 'New Access Token = ' . $oauth2->accessToken() . "\n";

        // Retry the login.
        $success = $imap->Login('OFFICE365_EMAIL_ADDRESS',$jsonToken->stringOf('access_token'));
        if ($success == false) {
            print $imap->lastErrorText() . "\n";
            exit;
        }

    }
    else {
        // Show the last error text for the call to Login
        print $loginLastErrorText . "\n";
        exit;
    }

}
else {
    print 'O365 OAuth authentication is successful.' . "\n";
}

// Do something...
$success = $imap->SelectMailbox('Inbox');
if ($success != true) {
    print $imap->lastErrorText() . "\n";
    exit;
}

// Your application can continue to do other things in the IMAP session....

// When finished, logout and close the connection.
$success = $imap->Logout();
$success = $imap->Disconnect();

print 'Finished.' . "\n";

?>