wip

Author: geisi

README.md

@@ -23,39 +23,20 @@ You can install the package via composer:
 composer require innoge/laravel-msgraph-mail
 ```
 
-You can publish and run the migrations with:
-
-```bash
-php artisan vendor:publish --tag="laravel-msgraph-mail-migrations"
-php artisan migrate
-```
-
-You can publish the config file with:
-
-```bash
-php artisan vendor:publish --tag="laravel-msgraph-mail-config"
-```
-
-This is the contents of the published config file:
+First you need to add a new entry to the mail drivers array in your config/mail.php configuration file:
 
 ```php
-return [
-];
+'microsoft-graph' => [
+    'transport' => 'microsoft-graph',
+    'client_id' => env('MICROSOFT_GRAPH_CLIENT_ID'),
+    'client_secret' => env('MICROSOFT_GRAPH_CLIENT_SECRET'),
+    'tenant_id' => env('MICROSOFT_GRAPH_TENANT_ID'),
+    'from' => [
+        'address' => env('MAIL_FROM_ADDRESS'),
+        'name' => env('MAIL_FROM_NAME'),
+    ],
+],
 ```
-
-Optionally, you can publish the views using
-
-```bash
-php artisan vendor:publish --tag="laravel-msgraph-mail-views"
-```
-
-## Usage
-
-```php
-$laravelMsGraphMail = new InnoGE\LaravelMsGraphMail();
-echo $laravelMsGraphMail->echoPhrase('Hello, InnoGE!');
-```
-
 ## Testing
 
 ```bash

composer.json

@@ -17,8 +17,9 @@
     ],
     "require": {
         "php": "^8.1",
+        "illuminate/contracts": "^9.0",
         "spatie/laravel-package-tools": "^1.14.0",
-        "illuminate/contracts": "^9.0"
+        "symfony/mailer": "^6.0"
     },
     "require-dev": {
         "laravel/pint": "^1.0",

config/msgraph-mail.php

@@ -2,5 +2,5 @@
 
 // config for InnoGE/LaravelMsGraphMail
 return [
-
+    '',
 ];

src/Dto/MicrosoftGraphMail.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace InnoGE\LaravelMsGraphMail\Dto;
+
+class MicrosoftGraphMail
+{
+}

src/Exceptions/ConfigurationMissing.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace InnoGE\LaravelMsGraphMail\Exceptions;
+
+use Exception;
+
+class ConfigurationMissing extends Exception
+{
+    public static function tenantId(): self
+    {
+        return new static('The tenant id is missing from the configuration file.');
+    }
+
+    public static function clientId(): self
+    {
+        return new static('The client id is missing from the configuration file.');
+    }
+
+    public static function clientSecret(): self
+    {
+        return new static('The client secret is missing from the configuration file.');
+    }
+}

src/LaravelMsGraphMailServiceProvider.php

@@ -2,6 +2,9 @@
 
 namespace InnoGE\LaravelMsGraphMail;
 
+use Illuminate\Support\Facades\Mail;
+use InnoGE\LaravelMsGraphMail\Exceptions\ConfigurationMissing;
+use InnoGE\LaravelMsGraphMail\Services\MicrosoftGraphApiService;
 use Spatie\LaravelPackageTools\Package;
 use Spatie\LaravelPackageTools\PackageServiceProvider;
 
@@ -18,4 +21,28 @@ public function configurePackage(Package $package): void
             ->name('laravel-msgraph-mail')
             ->hasConfigFile();
     }
+
+    public function boot(): void
+    {
+        $this->app->bind(MicrosoftGraphApiService::class, function () {
+            //throw exceptions when config is missing
+            throw_unless(filled(config('mail.mailers.microsoft-graph.tenant_id')), ConfigurationMissing::tenantId());
+            throw_unless(filled(config('mail.mailers.microsoft-graph.client_id')), ConfigurationMissing::clientId());
+            throw_unless(filled(config('mail.mailers.microsoft-graph.client_secret')), ConfigurationMissing::clientSecret());
+
+            return new MicrosoftGraphApiService(
+                tenantId: config('mail.mailers.microsoft-graph.tenant_id', ''),
+                clientId: config('mail.mailers.microsoft-graph.client_id', ''),
+                clientSecret: config('mail.mailers.microsoft-graph.client_secret', ''),
+                accessTokenTtl: config('mail.mailers.microsoft-graph.access_token_ttl', 3000),
+            );
+        });
+
+        Mail::extend('microsoft-graph', function (array $config) {
+            return new MicrosoftGraphTransport(
+                app()->make(MicrosoftGraphApiService::class),
+                $config['from']['address']
+            );
+        });
+    }
 }

src/MicrosoftGraphTransport.php

@@ -0,0 +1,106 @@
+<?php
+
+namespace InnoGE\LaravelMsGraphMail;
+
+use Illuminate\Http\Client\RequestException;
+use Illuminate\Support\Collection;
+use InnoGE\LaravelMsGraphMail\Services\MicrosoftGraphApiService;
+use Psr\EventDispatcher\EventDispatcherInterface;
+use Psr\Log\LoggerInterface;
+use Symfony\Component\Mailer\Envelope;
+use Symfony\Component\Mailer\SentMessage;
+use Symfony\Component\Mailer\Transport\AbstractTransport;
+use Symfony\Component\Mime\Address;
+use Symfony\Component\Mime\Email;
+use Symfony\Component\Mime\MessageConverter;
+
+class MicrosoftGraphTransport extends AbstractTransport
+{
+    public function __construct(protected MicrosoftGraphApiService $microsoftGraphApiService, protected string $from, EventDispatcherInterface $dispatcher = null, LoggerInterface $logger = null)
+    {
+        parent::__construct($dispatcher, $logger);
+    }
+
+    public function __toString(): string
+    {
+        return sprintf('microsoft+graph+api://%s', $this->getEndpoint());
+    }
+
+    /**
+     * @throws RequestException
+     */
+    protected function doSend(SentMessage $message): void
+    {
+        $email = MessageConverter::toEmail($message->getOriginalMessage());
+        $envelope = $message->getEnvelope();
+
+        $payload = [
+            'message' => [
+                'subject' => $email->getSubject(),
+                'body' => [
+                    'contentType' => $email->getHtmlBody() === null ? 'Text' : 'HTML',
+                    'content' => $email->getHtmlBody() ?: $email->getTextBody(),
+                ],
+                'toRecipients' => $this->transformEmailAddresses($this->getRecipients($email, $envelope)),
+                'ccRecipients' => $this->transformEmailAddresses(collect($email->getCc())),
+                'bccRecipients' => $this->transformEmailAddresses(collect($email->getBcc())),
+                'replyTo' => $this->transformEmailAddresses(collect($email->getReplyTo())),
+                'sender' => $this->transformEmailAddress($envelope->getSender()),
+                'attachments' => $this->getAttachments($email),
+            ],
+            'saveToSentItems' => false,
+        ];
+
+        $this->microsoftGraphApiService->sendMail($this->from, $payload);
+    }
+
+    /**
+     * @param  Collection<Address>  $recipients
+     * @return array
+     */
+    protected function transformEmailAddresses(Collection $recipients): array
+    {
+        return $recipients
+            ->map(fn (Address $recipient) => $this->transformEmailAddress($recipient))
+            ->toArray();
+    }
+
+    /**
+     * @param  Address  $address
+     * @return array
+     */
+    protected function transformEmailAddress(Address $address): array
+    {
+        return [
+            'emailAddress' => [
+                'address' => $address->getAddress(),
+            ],
+        ];
+    }
+
+    /**
+     * @param  Email  $email
+     * @param  Envelope  $envelope
+     * @return Collection<Address>
+     */
+    protected function getRecipients(Email $email, Envelope $envelope): Collection
+    {
+        return collect($envelope->getRecipients())
+            ->filter(fn (Address $address) => ! in_array($address, array_merge($email->getCc(), $email->getBcc()), true));
+    }
+
+    protected function getAttachments(Email $email): array
+    {
+        $attachments = [];
+        foreach ($email->getAttachments() as $attachment) {
+            $attachments[] = [
+                '@odata.type' => '#microsoft.graph.fileAttachment',
+                'name' => $attachment->getName(),
+                'contentType' => $attachment->getMediaType(),
+                'contentBytes' => base64_encode($attachment->getBody()),
+            ];
+        }
+
+        return $attachments;
+    }
+}

src/Services/MicrosoftGraphApiService.php

@@ -0,0 +1,53 @@
+<?php
+
+namespace InnoGE\LaravelMsGraphMail\Services;
+
+use Illuminate\Http\Client\PendingRequest;
+use Illuminate\Http\Client\RequestException;
+use Illuminate\Http\Client\Response;
+use Illuminate\Support\Facades\Cache;
+use Illuminate\Support\Facades\Http;
+
+class MicrosoftGraphApiService
+{
+    public function __construct(protected readonly string $tenantId,
+                                protected readonly string $clientId,
+                                protected readonly string $clientSecret,
+                                protected readonly int $accessTokenTtl
+    ) {
+    }
+
+    /**
+     * @throws RequestException
+     */
+    public function sendMail(string $from, array $payload): Response
+    {
+        return $this->getBaseRequest()
+            ->post("/users/{$from}/sendMail", $payload)
+            ->throw();
+    }
+
+    protected function getBaseRequest(): PendingRequest
+    {
+        return Http::withToken($this->getAccessToken())
+            ->baseUrl('https://graph.microsoft.com/v1.0');
+    }
+
+    protected function getAccessToken(): string
+    {
+        return Cache::remember('microsoft-graph-api-access-token', $this->accessTokenTtl, function (): string {
+            $response = Http::asForm()
+                ->post("https://login.microsoftonline.com/{$this->tenantId}/oauth2/v2.0/token",
+                    [
+                        'grant_type' => 'client_credentials',
+                        'client_id' => $this->clientId,
+                        'client_secret' => $this->clientSecret,
+                        'scope' => 'https://graph.microsoft.com/.default',
+                    ]);
+
+            $response->throw();
+
+            return $response->json('access_token');
+        });
+    }
+}

tests/MicrosoftGraphTransportTest.php

@@ -0,0 +1,24 @@
+<?php
+
+use Illuminate\Contracts\Queue\Factory;
+use Illuminate\Support\Facades\Config;
+use Illuminate\Support\Facades\Http;
+use Illuminate\Support\Facades\Mail;
+
+it('sends mails with microsoft graph', function () {
+    Config::set('mail.mailers.microsoft-graph', [
+        'transport' => 'microsoft-graph',
+        'client_id' => 'foo_client_id',
+        'client_secret' => 'foo_client_secret',
+        'tenant_id' => 'foo_tenant_id',
+        'from' => [
+            'address' => '[email protected]',
+            'name' => 'Taylor Otwell',
+        ],
+    ]);
+    Http::fake();
+
+    Http::assertSent(function ($value) {
+        dd($value);
+    });
+});

tests/Stubs/DevTest.php

@@ -0,0 +1,62 @@
+<?php
+
+namespace InnoGE\LaravelMsGraphMail\Tests\Stubs;
+
+use Illuminate\Bus\Queueable;
+use Illuminate\Mail\Attachment;
+use Illuminate\Mail\Mailable;
+use Illuminate\Mail\Mailables\Content;
+use Illuminate\Mail\Mailables\Envelope;
+use Illuminate\Queue\SerializesModels;
+
+class DevTest extends Mailable
+{
+    use Queueable, SerializesModels;
+
+    /**
+     * Create a new message instance.
+     *
+     * @return void
+     */
+    public function __construct()
+    {
+        //
+    }
+
+    /**
+     * Get the message envelope.
+     *
+     * @return \Illuminate\Mail\Mailables\Envelope
+     */
+    public function envelope()
+    {
+        return new Envelope(
+            subject: 'Dev Test',
+        );
+    }
+
+    /**
+     * Get the message content definition.
+     *
+     * @return \Illuminate\Mail\Mailables\Content
+     */
+    public function content()
+    {
+        return new Content(
+            html: '<b>Test</b>',
+        );
+    }
+
+    /**
+     * Get the attachments for the message.
+     *
+     * @return array
+     */
+    public function attachments(): array
+    {
+        return [
+            Attachment::fromPath(resource_path('pdf-test.pdf')),
+            Attachment::fromPath(resource_path('pdf-test2.pdf')),
+        ];
+    }
+}