/azure-mailer-driver

Azure Communication Service (ECS) SwiftMailer driver for Laravel Framework.

Primary LanguagePHPMIT LicenseMIT

Azure Email Communication Service (ECS) for Laravel

This package is an Microsoft Azure Email Communication Service (ECS) Swift Mailer Driver for Laravel.

Latest Stable Version Latest Unstable Version Total Downloads License

This library provides developers with a simple set of features for sending Laravel Framework emails through the Microsoft Azure ECS service.

πŸ’‘ Requirements

PHP 7.3 or higher

🧩 Available resources

Resource Status
Plain Text βœ…
HTML βœ…
Attachments βœ…
Multiple recipients βœ…
Auth HMAC-SHA256 βœ…
Notifications βœ…
Mkt Campaigns βœ…
Markdown βœ…

πŸ“¦ Installation

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

  1. Download Composer if not already installed

  2. On your project directory run on the command line composer require "hafael/azure-mailer-driver"

  3. Get your Azure CS Access Key and Service Endpoint.

🌟 Set mail config

Add entry to [root-of-laravel]/config/mail.php:

  <?php
    
    ...

    'mailers' => [
        //...other drivers

        'azure' => [
            'transport'             => 'azure',
            'endpoint'              => env('AZURE_MAIL_ENDPOINT', 'https://{communicatonServiceName}.communication.azure.com'),
            'access_key'            => env('AZURE_MAIL_KEY'),
            'api_version'           => env('AZURE_MAIL_API_VERSION', '2021-10-01-preview'), //optional
            'disable_user_tracking' => env('AZURE_MAIL_DISABLE_TRACKING', false), //optional
        ],
    ]

  ?>

Add entry to [root-of-laravel]/.env:

  
  #...other entries

  # Mail service entries... 
  MAIL_MAILER=azure
  
  # Azure Service entries
  AZURE_MAIL_ENDPOINT="https://{communicatonServiceName}.communication.azure.com"
  AZURE_MAIL_KEY="{base64accessToken}"
  AZURE_MAIL_API_VERSION="2021-10-01-preview" #optional
  AZURE_MAIL_DISABLE_TRACKING=false #optional
  

and just sent your notification mail messages!

πŸ“š Documentation

Visit our Dev Site for further information regarding:

  • Azure Communication Service Docs: English

πŸ“œ License

MIT license. Copyright (c) 2023 - Rafael For more information, see the LICENSE file.