Files
denkfabrik-li 4eb8cf915a Add Google / Gmail as the second OAuth mail provider
Same delegated shape as the Microsoft 365 provider, through the same
broker interface: the admin registers an OAuth client in Google Cloud
Console, connects the Google account the installation should send as,
and outgoing email goes through the Gmail API's messages.send as that
account.

The shared authorization-code machinery (exchange, refresh, token
storage, id_token account detection, RFC 6749 failure telling a dead
grant from a transient one) moves into an abstract OAuthCodeFlowBroker;
the two vendor brokers keep only their endpoints, scopes and consent
URL parameters. Google's quirks live where they belong: offline access
with a forced consent screen (the only way Google issues a refresh
token), and a refresh response that never re-sends one — the store
keeps what it has.

The settings screen needed no changes: the dropdown, the credential
form and the connect flow all derive from the provider enum.
2026-08-23 22:46:24 +02:00

58 lines
2.2 KiB
PHP

<?php
declare(strict_types=1);
namespace App\Modules\Platform\Mail;
/**
* Google OAuth tokens for sending through the Gmail API.
*
* Same delegated shape as Microsoft's: an administrator signs into the
* Google account the installation should send as, and the token can
* send as that account and nothing else. The app registration lives in
* Google Cloud Console (an OAuth client of type "Web application");
* a Workspace admin can mark it Internal, everyone else runs it in
* testing/published status — in testing, Google expires the refresh
* token after 7 days, which the daily health check surfaces as a
* reconnect warning rather than silent dead mail.
*/
class GoogleMailBroker extends OAuthCodeFlowBroker
{
/**
* gmail.send is the one permission sending needs; openid/email buy
* the id_token the connected account's address is read from — no
* userinfo call, no broader Gmail access.
*/
private const SCOPE = 'openid email https://www.googleapis.com/auth/gmail.send';
public function authorizeUrl(MailOAuthConnection $connection, string $state, string $redirectUri): string
{
// access_type=offline is what makes Google issue a refresh token
// at all, and prompt must include 'consent' because Google only
// hands one out while showing the consent screen — a silent
// re-auth returns none, and this flow cannot run on borrowed
// time. select_account for the same reason as Microsoft's: the
// sending account is usually not the one the admin is signed
// into.
return 'https://accounts.google.com/o/oauth2/v2/auth?'.http_build_query([
'client_id' => (string) $connection->client_id,
'response_type' => 'code',
'redirect_uri' => $redirectUri,
'scope' => self::SCOPE,
'state' => $state,
'access_type' => 'offline',
'prompt' => 'select_account consent',
]);
}
protected function tokenEndpoint(MailOAuthConnection $connection): string
{
return 'https://oauth2.googleapis.com/token';
}
protected function scope(): string
{
return self::SCOPE;
}
}