wip

Author: geisi

README.md

@@ -1,19 +1,12 @@
-# This is my package laravel-msgraph-mail
+# Laravel Microsoft Graph Mail Driver Package
 
 [![Latest Version on Packagist](https://img.shields.io/packagist/v/innoge/laravel-msgraph-mail.svg?style=flat-square)](https://packagist.org/packages/innoge/laravel-msgraph-mail)
 [![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/innoge/laravel-msgraph-mail/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/innoge/laravel-msgraph-mail/actions?query=workflow%3Arun-tests+branch%3Amain)
 [![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/innoge/laravel-msgraph-mail/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/innoge/laravel-msgraph-mail/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
 [![Total Downloads](https://img.shields.io/packagist/dt/innoge/laravel-msgraph-mail.svg?style=flat-square)](https://packagist.org/packages/innoge/laravel-msgraph-mail)
 
-This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.
-
-## Support us
-
-[<img src="https://github-ads.s3.eu-central-1.amazonaws.com/laravel-msgraph-mail.jpg?t=1" width="419px" />](https://spatie.be/github-ad-click/laravel-msgraph-mail)
-
-We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).
-
-We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).
+This package provides a Microsoft Graph mail driver for Laravel. It is an alternative when you don't want to use the
+deprecated and unsecure Basic Auth SMTP driver with Microsoft Office 365.
 
 ## Installation
 
@@ -23,7 +16,22 @@ You can install the package via composer:
 composer require innoge/laravel-msgraph-mail
 ```
 
-First you need to add a new entry to the mail drivers array in your config/mail.php configuration file:
+## Configuration
+
+### Register the Azure App
+
+You need to register an Azure App in your Azure AD tenant. You can do this by following the steps in
+the [Microsoft Graph documentation](https://docs.microsoft.com/en-us/graph/auth-register-app-v2).
+
+After creating the App you have to add the following permissions to the App:
+Mail.Send (Application permission) you will find it under the "Microsoft Graph" section.
+
+Now you have to Grant Admin Consent for the App. You can do this by following the steps in
+the [Microsoft Graph documentation](https://docs.microsoft.com/en-us/graph/auth-v2-service#3-get-administrator-consent).
+
+### Configuring your Laravel app
+
+First you need to add a new entry to the mail drivers array in your `config/mail.php` configuration file:
 
 ```php
 'microsoft-graph' => [
@@ -37,6 +45,16 @@ First you need to add a new entry to the mail drivers array in your config/mail.
     ],
 ],
 ```
+
+For the `client_id`, `client_secret` and `tenant_id` you need to use the values from the Azure App you created in the
+previous step.
+
+Now you can switch your default mail driver to the new `microsoft-graph` driver by setting the env variable:
+
+```dotenv
+MAIL_MAILER=microsoft-graph
+```
+
 ## Testing
 
 ```bash

phpstan-baseline.neon

@@ -0,0 +1,6 @@
+parameters:
+	ignoreErrors:
+		-
+			message: "#^Parameter \\#1 \\$message of static method Symfony\\\\Component\\\\Mime\\\\MessageConverter\\:\\:toEmail\\(\\) expects Symfony\\\\Component\\\\Mime\\\\Message, Symfony\\\\Component\\\\Mime\\\\RawMessage given\\.$#"
+			count: 1
+			path: src/MicrosoftGraphTransport.php

phpstan.neon.dist

@@ -2,13 +2,12 @@ includes:
     - phpstan-baseline.neon
 
 parameters:
-    level: 4
+    level: 8
     paths:
         - src
-        - config
-        - database
     tmpDir: build/phpstan
     checkOctaneCompatibility: true
     checkModelProperties: true
     checkMissingIterableValueType: false
+    checkGenericClassInNonGenericObjectType: false
 

src/Dto/MicrosoftGraphMail.php

@@ -8,16 +8,21 @@ class ConfigurationMissing extends Exception
 {
     public static function tenantId(): self
     {
-        return new static('The tenant id is missing from the configuration file.');
+        return new self('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.');
+        return new self('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.');
+        return new self('The client secret is missing from the configuration file.');
+    }
+
+    public static function fromAddress(): self
+    {
+        return new self('The mail from address is missing from the configuration file.');
     }
 }

src/Exceptions/ConfigurationMissing.php

@@ -39,6 +39,8 @@ public function boot(): void
         });
 
         Mail::extend('microsoft-graph', function (array $config) {
+            throw_unless(filled($config['from']['address'] ?? []), ConfigurationMissing::fromAddress());
+
             return new MicrosoftGraphTransport(
                 app()->make(MicrosoftGraphApiService::class),
                 $config['from']['address']

src/LaravelMsGraphMailServiceProvider.php

@@ -23,7 +23,7 @@ public function __construct(protected MicrosoftGraphApiService $microsoftGraphAp
 
     public function __toString(): string
     {
-        return sprintf('microsoft+graph+api://%s', $this->getEndpoint());
+        return 'microsoft+graph+api://';
     }
 
     /**