CoreFiles by mySites.guru
MailOAuth2TokenProvider.php87 lines, 2,370 bytes, from Joomla_6.2.0-Stable-Full_Package.zip
Raw History Compare with 6.1.4
md5
8b71878d345f48b99ba05b3228706d98
sha1
c4e361a7acced9725e29f5b54059d70c8a835cb6
sha256
4da1f910e65130365ff9a4a4b035c41ae14541c896c4b29ccc8ad1456af4f3ea
<?php

/**
 * Joomla! Content Management System
 *
 * @copyright  (C) 2026 Open Source Matters, Inc. <https://www.joomla.org>
 * @license    GNU General Public License version 2 or later; see LICENSE.txt
 */

namespace Joomla\CMS\Mail;

use Joomla\OAuth2\Client;
use PHPMailer\PHPMailer\OAuthTokenProvider;

// phpcs:disable PSR1.Files.SideEffects
\defined('_JEXEC') or die;
// phpcs:enable PSR1.Files.SideEffects

/**
 * Generic OAuth token provider for SMTP XOAUTH2 authentication.
 *
 * @since  6.2.0
 */
final class MailOAuth2TokenProvider implements OAuthTokenProvider
{
    /**
     * @var string|null Access token
     */
    private ?string $accessToken = null;

    /** @var int Expiration time */
    private int $expiresAt = 0;

    public function __construct(
        private string $tokenUrl,
        private string $clientId,
        private string $clientSecret,
        private string $refreshToken,
        private string $userName
    ) {
    }

    /**
     * Generate a base64-encoded OAuth token ensuring that the access token has not expired.
     * The string to be base 64 encoded should be in the form:
     * "user=<user_email_address>\001auth=Bearer <access_token>\001\001"
     *
     * @return string
     */
    public function getOauth64(): string
    {
        if (!$this->accessToken || time() >= $this->expiresAt) {
            $this->requestAccessToken();
        }

        return base64_encode('user=' . $this->userName . "\001auth=Bearer " . $this->accessToken . "\001\001");
    }

    /**
     * Request a new access token using the refresh token.
     *
     * @return void
     */
    private function requestAccessToken(): void
    {
        $oauth2 = new Client([
            'tokenurl'     => $this->tokenUrl,
            'clientid'     => $this->clientId,
            'clientsecret' => $this->clientSecret,
            'userefresh'   => true,
        ]);

        $token = $oauth2->refreshToken($this->refreshToken);

        if (empty($token['access_token'])) {
            throw new \RuntimeException(
                'Failed to acquire SMTP OAuth2 access token.'
            );
        }

        $this->accessToken = (string) $token['access_token'];

        $expiresIn = isset($token['expires_in']) ? (int) $token['expires_in'] : 3600;

        $this->expiresAt = $token['created'] + max(60, $expiresIn - 60);
    }
}

The same content is in 6 releases, Joomla 6.2.0-beta2 to 6.2.1-rc1. See them all, or every version of this file.