xiaohuilam/http-mail-driver

A Mail driver that sends the email in a json format to a supplied endpoint

v0.0.2 2023-12-17 11:36 UTC

Requires

• php: >=8.0
• guzzlehttp/guzzle: >=7.5
• illuminate/support: >=10.0
• symfony/mailer: >=6.0

Requires (Dev)

• phpunit/phpunit: >=10.0

MIT

• skyracer2012

• http-mail-driver

README

This package gives your the ability to send emails via HTTP requests. This is useful for sending emails via Mailchannels and their Cloudflare Workers partnerships but can be used for other applications. Note: There is currently no support for attachments due to Mailchannels not supporting them via their transactional message api.

Installation

You can install the package via composer:

composer require skyracer2012/http-mail-driver

After that, please set the value HTTP_MAIL_URL in your .env file to the URL of your HTTP Mail endpoint. You should also define the HTTP_MAIL_KEY in your .env file which will be used to authenticate your requests in the Authorization header.

HTTP_MAIL_URL=https://webhook.example.com
HTTP_MAIL_KEY=secret

Optionally you can also add DKIM data, which is useful for the mailchannels integration. See the config entry for further information. Make sure this matches your mail sender configuration to avoid dmarc issues!

HTTP_MAIL_DKIM_ENABLED=true
HTTP_MAIL_DKIM_DOMAIN=example.com
HTTP_MAIL_DKIM_SELECTOR=mailchannels
HTTP_MAIL_DKIM_PRIVATE_KEY=yourprivatkey

Next should should add the http entry to your config/mail.php file under the mailers array.

'mailers' => [
    // other mailers
    'http' => [
        'transport' => 'http',
        'url' => env('HTTP_MAIL_URL'),
        'key' => env('HTTP_MAIL_KEY'),
        //DKIM settings. Look at https://developers.cloudflare.com/pages/platform/functions/plugins/mailchannels/#dkim-support-for-mailchannels-api for more information
        'dkim_enabled' => env('HTTP_MAIL_DKIM_ENABLED', false), //Whether to enable DKIM in the database
        'dkim_domain' => env('HTTP_MAIL_DKIM_DOMAIN'), //The domain you are sending the email from.
        'dkim_selector' => env('HTTP_MAIL_DKIM_SELECTOR'), //Specifies where to find the associated public key in your DNS records
        'dkim_private_key' => env('HTTP_MAIL_DKIM_PRIVATE_KEY'), //The base-64 encoded private key.
    ],
],

Now you can set the default mailer to http in your .env file.

MAIL_MAILER=http

Cloudflare Mailchannel integration

⚠️ Mailchannels now enforces Domain Lockdown™: Please create DNS record according to their help center article!

This package was made to work in combination with the Cloudflare Worker Mailchannels partnership. To use this, deploy a worker with the code of this gist: https://gist.github.com/skyracer2012/54e85953162f24ac8f8e0a0fa747f1e3

Credits

• skyracer2012
• All Contributors

License

The MIT License (MIT). Please see License File for more information.

Laravel Package Boilerplate

This package was generated using the Laravel Package Boilerplate.