vormkracht10/laravel-mails

Laravel Mails can collect everything you might want to track about the mails that has been sent by your Laravel app.

dev-main 2024-04-08 12:53 UTC

README

Total Downloads Tests PHPStan GitHub release (latest by date) Packagist PHP Version Support Latest Version on Packagist

Laravel Mails can collect everything you might want to track about the mails that has been sent by your Laravel app. Common use cases are provided in this package:

  • Log all sent emails with only specific attributes
  • View all sent emails in the browser using the viewer
  • Collect feedback about the delivery from email providers using webhooks
  • Relate sent emails to Eloquent models
  • Get automatically notified when email bounces
  • Prune logging of emails periodically
  • Resend logged email to another recipient

Why this package

Email as a protocol is very error prone. Succesfull email delivery is not guaranteed in any way, so it is best to monitor your email sending realtime. Using external services like Postmark, Mailgun or Resend email gets better by offering things like logging and delivery feedback, but it still needs your attention and can fail silently but horendously. Therefore we created Laravel Mails that fills in all the gaps.

Installation

You can install the package via composer:

composer require vormkracht10/laravel-mails

You can publish and run the migrations with:

php artisan vendor:publish --tag="mails-migrations"
php artisan migrate

You can publish the config file with:

php artisan vendor:publish --tag="mails-config"

This is the contents of the published config file:

return [
];

Optionally, you can publish the views using

php artisan vendor:publish --tag="mails-views"

Usage

$laravelMails = new Vormkracht10\Mails();
echo $laravelMails->echoPhrase('Hello, Vormkracht10!');

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

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