vormkracht10 / filament-mails
This is my package filament-mails
Fund package maintenance!
vormkracht10
Requires
- php: ^8.1
- filament/filament: ^3.0
- spatie/laravel-package-tools: ^1.15.0
- vormkracht10/laravel-mails: dev-main
Requires (Dev)
- laravel/pint: ^1.0
- nunomaduro/collision: ^7.9
- nunomaduro/larastan: ^2.0.1
- orchestra/testbench: ^8.0
- pestphp/pest: ^2.1
- pestphp/pest-plugin-arch: ^2.0
- pestphp/pest-plugin-laravel: ^2.0
- phpstan/extension-installer: ^1.1
- phpstan/phpstan-deprecation-rules: ^1.0
- phpstan/phpstan-phpunit: ^1.0
This package is auto-updated.
Last update: 2024-10-30 15:53:36 UTC
README
Filament Mails can collect everything you might want to track about the mails that has been sent by your Filament 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
- Get automatically notified when email bounces
- Prune logging of emails periodically
- Resend logged email to another recipient
Upcoming features
- We're currently in the process of writing mail events support for other popular email service providers like Mailgun, Resend, SendGrid, Amazon SES and Mailtrap.
- Relate emails being send in Laravel directly to Eloquent models, for example the order confirmation email attached to an Order model.
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.
The package is built on top of Laravel Mails.
Installation
You can install the package via composer:
composer require vormkracht10/filament-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" php artisan vendor:publish --tag="filament-mails-config"
Optionally, you can publish the views using
php artisan vendor:publish --tag="filament-mails-views"
Then add the plugin to your PanelProvider
use Vormkracht10\FilamentMails\FilamentMailsPlugin; public function panel(Panel $panel): Panel { return $panel ->plugin(FilamentMailsPlugin::make()); }
Configuration
Sometimes you want to customize the resource, like configuring which users or roles may access the resource. You can do this by overriding the MailResource
or EventResource
classes in the filament-mails
config file. Make sure your custom resource extends the original resource.
return [ 'resources' => [ 'mail' => \App\Filament\Resources\MailResource::class, 'event' => \App\Filament\Resources\EventResource::class, ], ];
Features and screenshots
List with all sent emails and statistics
The package provides a clear overview of all emails, including statistics and the ability to filter the data.
Resending emails
You can resend emails to the same or another recipient(s). This is useful when your email has bounced and you want to resend it.
Information
You can view all relevant information about the email, such as the subject, the body, the attachments, the from address, the to address(es), the cc address(es), the bcc address(es), the reply to address, metadata and much more.
Preview email
The package provides a preview of the email. This is useful to quickly check if the email is correct.
We also provide the raw HTML and plain text of the email.
Events
The package also logs all events that are fired when an email is sent. This is useful to track the email sending process.
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.