Download the PHP package pod-point/laravel-mail-export without Composer
On this page you can find all versions of the php package pod-point/laravel-mail-export. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package laravel-mail-export
Laravel Mail Export
This package can export any mail sent with Laravel's Mailable
class to any desired filesystem disk and path as a .eml
file.
This can be useful when wanting to store emails sent for archive purposes.
Installation
You can install the package via composer:
For Laravel 9.x, 10.x, 11.x (requires PHP version 8.2 or higher)
For Laravel 7.x and 8.x
For Laravel 5.x and 6.x
Publishing the config file
The configuration for this package comes with some sensible values but you can optionally publish the config file with:
You will be able to specify:
enabled
: whether this package is enabled or not. Once installed, it's enabled by default but theMAIL_EXPORT
environment variable can be used to configure this.disk
: which disk to use by default.null
will use the default disk from your application filesystem.path
: the default path, within the configured disk, where mail will be exported.
See our config/mail-export.php
for more details.
Usage
Simply add the Exportable
trait and the ShouldExport
interface to any Mailable class that you want to persist into any storage disk.
This will use the default filesystem disk
and path
from the configuration and will also generate a unique filename
for you.
The default filename is using a timestamp, the mail recipients, the subject and will look like so:
You can also specify the disk
, path
or filename
to use for a specific Mailable using properties:
You can also use methods if you need more flexibility:
Then you can keep using your Mailable
as usual:
Even with Notifications too:
Testing
Run the tests with:
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Credits
- themsaid and Spatie's laravel-mail-preview for some inspiration
- Laravel Package Development documentation by John Braun
- Pod Point
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
Travel shouldn't damage the earth 🌍
Made with ❤️ at Pod Point
All versions of laravel-mail-export with dependencies
illuminate/filesystem Version ^9.0|^10.0|^11.0
illuminate/mail Version ^9.0|^10.0|^11.0
illuminate/support Version ^9.0|^10.0|^11.0
nesbot/carbon Version ^2.0