README

Installation

To install this package, use Composer. Run the following command in your terminal:

composer require kuantiko/ci4-msgraph-mailer

Manual Installation

If you prefer to install the package manually, follow these steps:

1. Clone the repository into your project:

   git clone https://bitbucket.org/kuantiko/ci4-msgraph-mailer.git
   

2. Add the package to your project's autoloader. Update the autoload section in your composer.json file:

   "autoload": {
       "psr-4": {
           "Kuantiko\\Ci4MsgraphMailer\\": "path/to/ci4-msgraph-mailer/src/"
       }
   }
   

3. Run the Composer dump-autoload command to regenerate the autoloader:

   composer dump-autoload
   

Configuration

After installing the package, you need to configure the required values for it to work properly with the Microsoft Graph API.

Make sure to set the email.protocol config key to msgraph protocol and provide the following values in the .env file:

• graphTenantId: The Azure AD tenant ID.
• graphClientId: The client ID registered in Azure AD.
• graphClientSecret: The client secret registered in Azure AD.

Example configuration:

# Email
email.protocol='msgraph'

# GraphMailer
graphmailer.graphTenantId='your-tenant-id',
graphmailer.graphClientId='your-client-id',
graphmailer.graphClientSecret='your-client-secret',

Usage

Once configured, service('email') will automatically return a GraphMailer instance when email.protocol is set to msgraph. No app-level override of Config\Services is required.

$email = service('email');

$email->setFrom('sender@domain.tld', 'Sender Name')
   ->setTo('recipient@domain.tld')
   ->setSubject('Hello from Graph')
   ->setMessage('This email was sent using Microsoft Graph API')
   ->send();

You can also use the graphMailer service alias if you need an explicit GraphMailer instance regardless of the configured protocol:

$email = service('graphMailer');

How it works

This package registers a Config\Services::email() method that CI4 discovers automatically (via $modules->shouldDiscover('services')). When called, it reads Config\EmailDrivers to resolve the correct class for the configured protocol, then instantiates it.

This means any package can register its own send protocol without touching application code:

// your-package/src/Config/Registrar.php
class Registrar
{
    public static function EmailDrivers(): array
    {
        return [
            'drivers' => [
                'yourprotocol' => \YourVendor\YourPackage\YourMailer::class,
            ],
        ];
    }
}

Once installed and autoloaded, setting email.protocol = 'yourprotocol' in the app config is all that is needed.

Contributions

Docker Support

This project includes Docker support for a consistent development environment. You can use the provided docker-compose.yml file to build and run the application in a containerized setup.

To start the Docker environment, run:

docker-compose up -d --build

This will set up the PHP-FPM service with Xdebug enabled for development. Ensure you have Docker and Docker Compose installed on your system before running the command.