Mailbook
Mailbook is a Laravel package that lets you easily inspect your mails without having to actually trigger it in your application.
Installation
You can install the package via composer:
composer require --dev xammie/mailbook
You can register mails in a new service provider.
php artisan make:provider MailbookProvider
Make sure to return early if your application is not in debug mode.
public function boot(): void
{
if (! config('app.debug')) {
return;
}
Mailbook::add(...);
}
and register it in config/app.php.
'providers' => [
...
/*
* Application Service Providers...
*/
App\Providers\MailbookProvider::class,
],
Usage
Before you can view transactional emails in the mailbook you have to register them.
// This will use dependency injection if your mailable has parameters
Mailbook::add(VerificationMail::class);
// Use a closure to customize the parameters of the mail instance
Mailbook::add(function () {
$user = User::factory()->make();
return new VerificationMail($user, '/example/url')
});
// You can also use dependency injection in the closure
Mailbook::add(function (User $user) {
return new VerificationMail($user, '/example/url');
});
Next head over to /mailbook to preview the mailables.
Variants
When creating mails you might have a couple of different scenario's that you want to test for one mail, you can use variants to solve this.
// Use a closure to customize the parameters of the mail instance
Mailbook::add(OrderCreatedMail::class)
->variant('1 item', fn () => new OrderCreatedMail(Order::factory()->withOneProduct()->create()))
->variant('2 items', fn () => new OrderCreatedMail(Order::factory()->withTwoProducts()->create()));
Using the database
Most of the time your mailables will need database models. Sometimes you will even preform queries when rendering these mailables. You can safely use factories and other queries when registering your mailables. Mailbook will automatically rollback these changes after rendering.
// All database changes are rolled back after rendering the mail.
Mailbook::add(function (): OrderShippedMail {
$order = Order::factory()->create();
$tracker = Tracker::factory()->create();
return new OrderShippedMail($order, $tracker);
});
By default, mailbook will roll back any database changes that are executed while rendering the mails. If you don't have a database connection, or if you don't want it to rollback you can disable it in the config.
'database_rollback' => false,
Customization
You can publish the config file with:
php artisan vendor:publish --tag="mailbook-config"
This is the contents of the published config file:
return [
'route_prefix' => '/mailbook',
'database_rollback' => true,
'display_preview' => true,
'refresh_button' => true,
];
Optionally, you can publish the views using
php artisan vendor:publish --tag="mailbook-views"
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.
1k Jan 4, 2023
34 Dec 24, 2022
94 Aug 30, 2022
64 Dec 24, 2022
91 Oct 18, 2022
2 Sep 30, 2022
43 Jan 7, 2023
82 Jan 16, 2022
755 Jan 3, 2023
61 Dec 6, 2022
684 Dec 26, 2022
4 Nov 16, 2021
2 Dec 8, 2021
2 Jun 21, 2022
2 Dec 12, 2022
530 Jan 6, 2023
1.9k Jan 5, 2023
251 Dec 25, 2022