codenteq/azure-mailer-driver

The Microsoft Azure ACS integration for Symfony Mailer.

v1.0.1 2024-07-05 12:53 UTC

This package is auto-updated.

Last update: 2025-01-09 08:00:51 UTC


README

Latest Stable Version Total Downloads License

1. Introduction:

The integration of Microsoft Azure ACS for Symfony Mailer provides a simple and clean email API supported by the Symfony Azure Mailer Bridge component.

2. Requirements

  • PHP: 8.1 or higher.
  • Composer: 1.6.5 or higher.

3. Installation

First time using Azure ECS? Create your Azure account, if you don’t have one already.

  • Run the following command
composer require codenteq/azure-mailer-driver

Set mail config

WARNING
It will check existence of the config/mail.php file, if it exists then please update the file manually with the below details.

'mailers' => [
        'azure' => [
            'transport'             => 'azure',
            'resource_name'         => env('AZURE_MAIL_RESOURCE_NAME'),
            'endpoint'              => env('AZURE_MAIL_ENDPOINT', 'https://my-acs-resource-name.communication.azure.com'),
            'access_key'            => env('AZURE_MAIL_KEY'),
            'api_version'           => env('AZURE_MAIL_API_VERSION', '2023-03-31'),
            'disable_user_tracking' => env('AZURE_MAIL_DISABLE_TRACKING', false),
            'client' => [
                'max_host_connections' => 10,
                'max_pending_pushes' => 100,
            ]
        ],

WARNING
It will check existence of the .env file, if it exists then please update the file manually with the below details.

  # Mail service entries... 
  MAIL_MAILER=azure
  
  # Azure Service entries
  AZURE_MAIL_RESOURCE_NAME=my-acs-resource-name
  # AZURE_MAIL_ENDPOINT= #optional
  AZURE_MAIL_KEY=Base64AzureAccessToken
  # AZURE_MAIL_API_VERSION=2023-03-31 #optional
  # AZURE_MAIL_DISABLE_TRACKING=false #optional
  

just sent your notification mail messages!

Available resources

How to contribute

Azure Mailer Driver is always open for direct contributions. Contributions can be in the form of design suggestions, documentation improvements, new component suggestions, code improvements, adding new features or fixing problems. For more information please check our Contribution Guideline document.

Acknowledgments

This repository is a fork of the original project created by Rafael Villa Verde. The code has been modified and improved for compatibility with the Symfony framework and packaged for easier use with Composer. Special thanks to the original author for their work. You can find the original repository here: https://github.com/hafael/azure-mailer-driver.