bauerdot / filament-mailbox
Filament plugin to add sandbox banner to all laravel emails
Fund package maintenance!
BauerdotUZH
Installs: 3
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 0
Forks: 0
Open Issues: 0
pkg:composer/bauerdot/filament-mailbox
Requires
- php: ^8.2
- aws/aws-php-sns-message-validator: ^1.10
- filament/filament: ^4.0
- illuminate/contracts: ^10.0||^11.0||^12.0
- spatie/laravel-package-tools: ^1.16
Requires (Dev)
- larastan/larastan: ^2.9||^3.0
- laravel/pint: ^1.14
- nunomaduro/collision: ^8.1.1||^7.10.0
- orchestra/testbench: ^10.0.0||^9.0.0||^8.22.0
- pestphp/pest: ^3.0||^2.34
- pestphp/pest-plugin-arch: ^3.0||^2.7
- pestphp/pest-plugin-laravel: ^3.0||^2.3
- phpstan/extension-installer: ^1.3||^2.0
- phpstan/phpstan-deprecation-rules: ^1.1||^2.0
- phpstan/phpstan-phpunit: ^1.3||^2.0
- spatie/laravel-ray: ^1.35
Suggests
- filament/filament: ^4.0 - Adds Filament admin panel integration
README
Filament plugin to add sandbox banner to all laravel emails
This plugin adds, based on managable config in Filament admin panel, a banner to all outgoing emails. Additionally, this package includes small preview of all outgoing emails in Filament admin panel, this past is inspured by TappNetwork package.
Installation
You can install the package via composer:
composer require bauerdot/filament-mailbox
You can publish and run the migrations with:
php artisan vendor:publish --tag="filament-mailbox-migrations"
php artisan migrate
You can publish the config file with:
php artisan vendor:publish --tag="filament-mailbox-config"
Optionally, you can publish the translations files with:
php artisan vendor:publish --tag="filament-mailbox-translations"
Using the Resource
Add this plugin to a panel on plugins()
method.
E.g. in app/Providers/Filament/AdminPanelProvider.php
:
use Bauerdot\FilamentMailBox\FilamentMailBoxPlugin; public function panel(Panel $panel): Panel { return $panel // ... ->plugins([ FilamentMailBoxPlugin::make(), //... ]); }
Using env variables (fastest start/deterministic for envs)
all emails can be types in example@example.com, example@example.com...
MAILBOX_SHOW_ENV_BANNER=true //show banner on all emails MAILBOX_SANDBOX_MODE=true //if sandbox mode all emails are redirected to sandbox address MAILBOX_ALLOWED_EMAILS=example@example.com //which emails are allowed to be send out in sandbox mode MAILBOX_SANDBOX_ADDRESS=example@example.com //all emails are redirected to this address in sandbox mode MAILBOX_BCC_ADDRESS=example@example.com //bcc all outgoing emails
And much more however it is encouraged to use them via config in admin panel.
When you dont lock values in config and try to define it is encourages to run to clear temporary cahce
php artisan filament-mailbox:clear-mail-settings-cache
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.
Next steps
- Add database periodic cleanups (of bodies etc.)
- add proper testing for bcc