Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vormkracht10/filament-mails
Collect everything about sent mails in your Filament app.
https://github.com/vormkracht10/filament-mails
email laravel laravel-framework laravel-package mail mailgun postmark
Last synced: 3 days ago
JSON representation
Collect everything about sent mails in your Filament app.
- Host: GitHub
- URL: https://github.com/vormkracht10/filament-mails
- Owner: vormkracht10
- License: mit
- Created: 2024-08-30T05:57:31.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-12-27T09:22:30.000Z (15 days ago)
- Last Synced: 2025-01-01T07:04:56.646Z (10 days ago)
- Topics: email, laravel, laravel-framework, laravel-package, mail, mailgun, postmark
- Language: PHP
- Homepage:
- Size: 6.15 MB
- Stars: 94
- Watchers: 4
- Forks: 8
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# Filament Mails
[](https://packagist.org/packages/vormkracht10/filament-mails)
[](https://github.com/vormkracht10/filament-mails/actions?query=workflow%3Arun-tests+branch%3Amain)
[](https://github.com/vormkracht10/filament-mails/actions?query=workflow%3A"Fix+PHP+code+styling"+branch%3Amain)
[](https://packagist.org/packages/vormkracht10/filament-mails)
## Nice to meet you, we're [Vormkracht10](https://vormkracht10.nl)
Hi! We are a web development agency from Nijmegen in the Netherlands and we use Laravel for everything: advanced websites with a lot of bells and whitles and large web applications.
## About the package
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 same or another recipient
## Upcoming features
- We're currently in the process of writing mail events support for other popular email service providers like 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](https://github.com/vormkracht10/laravel-mails).
## Installation
You can install the package via composer:
```bash
composer require vormkracht10/filament-mails
```
You can publish and run the migrations with:
```bash
php artisan vendor:publish --tag="mails-migrations"
php artisan migrate
```
You can publish the config file with:
```bash
php artisan vendor:publish --tag="mails-config"
php artisan vendor:publish --tag="filament-mails-config"
```
Optionally, you can publish the views using
```bash
php artisan vendor:publish --tag="filament-mails-views"
```
Add the routes to your `web.php` file:
```php
use Vormkracht10\FilamentMails\Facades\FilamentMails;
FilamentMails::routes();
```
Then add the plugin to your `PanelProvider`
```php
use Vormkracht10\FilamentMails\FilamentMailsPlugin;
public function panel(Panel $panel): Panel
{
return $panel
->plugin(FilamentMailsPlugin::make());
}
```
### Tenant middleware / route protection
If you want to protect the mail routes with your (tenant) middleware, you can do so by adding the routes to the `tenantRoutes`:
```php
use Vormkracht10\FilamentMails\FilamentMailsPlugin;
use Vormkracht10\FilamentMails\Facades\FilamentMails;
public function panel(Panel $panel): Panel
{
return $panel
->plugin(FilamentMailsPlugin::make())
->tenantRoutes(fn() => FilamentMails::routes());
}
```
> [!IMPORTANT]
> For setting up the webhooks to register mail events, please look into the README of [Laravel Mails](https://github.com/vormkracht10/laravel-mails), the underlying package that powers this package.
### 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.
```php
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
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [Baspa](https://github.com/vormkracht10)
- [Mark van Eijk](https://github.com/markvaneijk)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.