Skip to content

[Mailer] Add MicrosoftGraph API Transport #61290

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 12 commits into
base: 7.4
Choose a base branch
from
Open

[Mailer] Add MicrosoftGraph API Transport #61290

wants to merge 12 commits into from
+1,030 −0

Conversation

bobvandevijver
Copy link
Contributor

Q A
Branch? 7.4
Bug fix? no
New feature? yes
Deprecations? no
Issues Alternative for #60408
License MIT

Add a new Mailer bridge for the Microsoft Graph API, but without adding the complete Microsoft SDK as we're talking about just two HTTP POST requests.

I continued the work done in #60408 and kept the names mentioned there in the composer definition, but this implementation has been made from scratch, is based on the existing Azure Bridge and supports more features such as priority and inline attachments.

@carsonbot carsonbot added this to the 7.4 milestone Jul 31, 2025
@bobvandevijver bobvandevijver mentioned this pull request Jul 31, 2025
Closed
@bobvandevijver

This comment was marked as resolved.

Sign in to view
@MatTheCat
Copy link
Contributor

Don’t know if it’s related but it looks like you forgot to update registerMailerConfiguration’s $classToServices in the FrameworkExtension:

symfony/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php

Line 2874 in 39c5025

$classToServices = [

@bobvandevijver bobvandevijver force-pushed the microsoft-graph-mailer branch from a117a29 to e5100cc Compare July 31, 2025 19:08
@bobvandevijver
Copy link
Contributor Author

@MatTheCat You are today's hero, thank you!

xabbuh
xabbuh reviewed Aug 1, 2025
View reviewed changes
@bobvandevijver bobvandevijver force-pushed the microsoft-graph-mailer branch 2 times, most recently from 00ecd57 to 37f87a2 Compare August 1, 2025 11:24
@bobvandevijver

This comment was marked as outdated.

Sign in to view
nicolas-grekas
nicolas-grekas approved these changes Aug 1, 2025
View reviewed changes
Copy link
Member

@nicolas-grekas nicolas-grekas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, I trust you've tested this against the real thing :)
Here are some nitpicking

@bobvandevijver bobvandevijver force-pushed the microsoft-graph-mailer branch from d69147f to e9e0276 Compare August 5, 2025 17:55
fabpot
fabpot requested changes Aug 6, 2025
View reviewed changes
src/Symfony/Component/Mailer/Bridge/MicrosoftGraph/Transport/MicrosoftGraphApiTransport.php

public function __toString(): string
{
return \sprintf('microsoft+graphapi://%s', $this->graphEndpoint);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
return \sprintf('microsoft+graphapi://%s', $this->graphEndpoint);
return \sprintf('microsoftgraph+api://%s', $this->graphEndpoint);

src/Symfony/Component/Mailer/Bridge/MicrosoftGraph/Transport/MicrosoftGraphTransportFactory.php
{
public function create(Dsn $dsn): TransportInterface
{
if ('microsoft+graphapi' !== $dsn->getScheme()) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
if ('microsoft+graphapi' !== $dsn->getScheme()) {
if ('microsoftgraph+api' !== $dsn->getScheme()) {

src/Symfony/Component/Mailer/Bridge/MicrosoftGraph/Transport/MicrosoftGraphTransportFactory.php
}

if (null === $tenantId = $dsn->getOption('tenantId')) {
throw new IncompleteDsnException("Transport 'microsoft+graphapi' requires the 'tenant' option.");
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
throw new IncompleteDsnException("Transport 'microsoft+graphapi' requires the 'tenant' option.");
throw new IncompleteDsnException("Transport 'microsoftgraph+api' requires the 'tenant' option.");

src/Symfony/Component/Mailer/Bridge/MicrosoftGraph/Transport/MicrosoftGraphTransportFactory.php
}

if (null === $authEndpoint) {
throw new IncompleteDsnException("Transport 'microsoft+graphapi' requires the 'authEndpoint' option when not using the default graph endpoint.");
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
throw new IncompleteDsnException("Transport 'microsoft+graphapi' requires the 'authEndpoint' option when not using the default graph endpoint.");
throw new IncompleteDsnException("Transport 'microsoftgraph+api' requires the 'authEndpoint' option when not using the default graph endpoint.");

src/Symfony/Component/Mailer/Bridge/MicrosoftGraph/Transport/MicrosoftGraphTransportFactory.php

protected function getSupportedSchemes(): array
{
return ['microsoft+graphapi'];
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
return ['microsoft+graphapi'];
return ['microsoftgraph+api'];

src/Symfony/Component/Mailer/Bridge/MicrosoftGraph/README.md

```env
# MAILER e.g. for China
MAILER_DSN=microsoft+graph://CLIENT_APP_ID:CLIENT_APP_SECRET@microsoftgraph.chinacloudapi.cn?tenantId=TENANT_ID&authEndpoint=login.partner.microsoftonline.cn
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
MAILER_DSN=microsoft+graph://CLIENT_APP_ID:CLIENT_APP_SECRET@microsoftgraph.chinacloudapi.cn?tenantId=TENANT_ID&authEndpoint=login.partner.microsoftonline.cn
MAILER_DSN=microsoftgraph+api://CLIENT_APP_ID:CLIENT_APP_SECRET@microsoftgraph.chinacloudapi.cn?tenantId=TENANT_ID&authEndpoint=login.partner.microsoftonline.cn

src/Symfony/Component/Mailer/Bridge/MicrosoftGraph/README.md

```env
# MAILER
MAILER_DSN=microsoft+graph://CLIENT_APP_ID:CLIENT_APP_SECRET@default?tenantId=TENANT_ID&noSave=true
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
MAILER_DSN=microsoft+graph://CLIENT_APP_ID:CLIENT_APP_SECRET@default?tenantId=TENANT_ID&noSave=true
MAILER_DSN=microsoftgraph+api://CLIENT_APP_ID:CLIENT_APP_SECRET@default?tenantId=TENANT_ID&noSave=true

src/Symfony/Component/Mailer/Bridge/MicrosoftGraph/README.md
* Register an application in your Microsoft Azure portal,
* Grant this application the Microsoft Graph `Mail.Send` permission,
* Create a secret for that app.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change

src/Symfony/Component/Mailer/Bridge/MicrosoftGraph/README.md
@@ -0,0 +1,54 @@
Microsoft Graph API Mailer
======================
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
======================
==========================

src/Symfony/Component/Mailer/Bridge/MicrosoftGraph/README.md

This will default to `graph.microsoft.com` for the Graph API and `login.microsoftonline.com` for authentication.

If you need to use third parties operated or specific regions Microsoft services (China, US Government, etc.), you can specify Graph Endpoint and Auth Endpoint explicitly.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
If you need to use third parties operated or specific regions Microsoft services (China, US Government, etc.), you can specify Graph Endpoint and Auth Endpoint explicitly.
If you need to use third parties operated or specific regions Microsoft services (China, US Government, etc.), you can specify the Graph Endpoint and the Auth Endpoint explicitly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nicolas-grekas nicolas-grekas nicolas-grekas approved these changes

@OskarStark OskarStark OskarStark left review comments

@xabbuh xabbuh xabbuh left review comments

@fabpot fabpot fabpot requested changes

Assignees
No one assigned
Labels
Feature Mailer Status: Needs Work
Projects
None yet
Milestone
7.4
Development

Successfully merging this pull request may close these issues.
7 participants
@bobvandevijver @MatTheCat @fabpot @nicolas-grekas @OskarStark @xabbuh @carsonbot
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy