guysolamour/laravel-dkim

Laravel package for signing outgoing messages with DKIM.

v1.0 2023-06-09 10:06 UTC

This package is auto-updated.

Last update: 2024-10-09 16:09:42 UTC


README

Packagist Packagist Packagist

Installation

Install via composer

composer require guysolamour/laravel-dkim

After that, you should publish the config file with:

php artisan vendor:publish --provider="Guysolamour\Dkim\ServiceProvider"

The ServiceProvider extends the MailServiceProvider and overwrites a method that we need for our own behavior.

Next we need to create a private and public key pair for signing and verifying the email.

There are many tools available to generate the necessary keys but here is one which is easy to use:

https://tools.socketlabs.com/dkim/generator

Enter your domain and in the "selector" field enter default, or adjust the "selector" in the laravel config file accordingly. Leave the remaining fields as they are.

After you have generated the keys and added the public key to your dns record, here is a tool to validate it:

https://www.mail-tester.com/spf-dkim-check

Finally, store the private key for example in storage/app/dkim/dkim.private.key and configure your settings in .env:

You need to set the full absolute path in the environment variable.

DKIM_DOMAIN=example.com

Credits