maize-tech / laravel-msgraph-mailer
Laravel mail transport driver for sending emails via Microsoft Graph API with OAuth2 authentication
Fund package maintenance!
Maize
Installs: 35
Dependents: 0
Suggesters: 0
Security: 0
Stars: 1
Watchers: 0
Forks: 0
Open Issues: 0
pkg:composer/maize-tech/laravel-msgraph-mailer
Requires
- php: ^8.3
- guzzlehttp/psr7: ^2.7
- illuminate/contracts: ^11.0||^12.0
- microsoft/microsoft-graph: ^2.53
- saloonphp/cache-plugin: ^3.0
- saloonphp/saloon: ^3.14
- spatie/laravel-package-tools: ^1.16
- symfony/mailer: ^7.0||^6.0
- symfony/mime: ^7.0||^6.0
Requires (Dev)
- larastan/larastan: ^3.0
- laravel/pint: ^1.14
- nunomaduro/collision: ^8.8
- orchestra/testbench: ^10.0.0||^9.0.0
- pestphp/pest: ^4.0
- pestphp/pest-plugin-arch: ^4.0
- pestphp/pest-plugin-laravel: ^4.0
- phpstan/extension-installer: ^1.4
- phpstan/phpstan-deprecation-rules: ^2.0
- phpstan/phpstan-phpunit: ^2.0
README
A Laravel mail transport driver for sending emails via Microsoft Graph API using OAuth2 authentication.
This package provides a custom Symfony Mailer transport that integrates seamlessly with Laravel's mail system, allowing you to send emails through Microsoft 365 (formerly Office 365) using the Microsoft Graph API with application permissions (client credentials flow).
Installation
You can install the package via composer:
composer require maize-tech/laravel-msgraph-mailer
Configuration
Add the Microsoft Graph mailer configuration to your config/mail.php file:
'mailers' => [ // ... other mailers 'microsoft-graph' => [ 'transport' => 'microsoft-graph', 'tenant_id' => env('MICROSOFT_GRAPH_TENANT_ID'), 'client_id' => env('MICROSOFT_GRAPH_CLIENT_ID'), 'client_secret' => env('MICROSOFT_GRAPH_CLIENT_SECRET'), ], ],
Add the required environment variables to your .env file:
MAIL_MAILER=microsoft-graph MICROSOFT_GRAPH_TENANT_ID=your-tenant-id MICROSOFT_GRAPH_CLIENT_ID=your-client-id MICROSOFT_GRAPH_CLIENT_SECRET=your-client-secret
Usage
Once configured, you can use Laravel's Mail facade as usual. The package will automatically handle OAuth2 authentication and send emails via Microsoft Graph API.
Basic Email
use Illuminate\Support\Facades\Mail; Mail::raw('Hello from Microsoft Graph!', function ($message) { $message->to('recipient@example.com') ->subject('Test Email'); });
Using Mailables
use Illuminate\Support\Facades\Mail; use App\Mail\WelcomeEmail; Mail::to('user@example.com')->send(new WelcomeEmail($user));
HTML Emails with Attachments
use Illuminate\Support\Facades\Mail; Mail::send('emails.welcome', ['user' => $user], function ($message) use ($user) { $message->to($user->email) ->subject('Welcome!') ->attach('/path/to/file.pdf'); });
Token Caching Issues
Access tokens are cached for 55 minutes by default. If you need to clear the cache:
app('mail.microsoft-graph.token-provider')->clearToken();
Features
- OAuth2 Authentication: Uses client credentials flow for secure authentication
- Automatic Token Caching: Access tokens are cached for 55 minutes
- Retry Logic: Automatic retry on transient failures with attempts and delays
- Full Email Support:
- HTML and plain text emails
- File attachments (including inline images)
- Multiple recipients (To, CC, BCC)
- Reply-To headers
- Laravel Integration: Works seamlessly with Laravel's Mail facade, Mailables, and Notifications
Testing
composer test
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
License
The MIT License (MIT). Please see License File for more information.