Skip to content

Latest commit

 

History

History
77 lines (48 loc) · 2.89 KB

README.md

File metadata and controls

77 lines (48 loc) · 2.89 KB

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

This package provides a Filament resource to view all Laravel outgoing emails. It also provides a Model for the database stored emails.

Installation

You can install the package via composer:

composer require ramnzys/filament-email-log

You can publish and run the migrations with:

php artisan vendor:publish --tag="filament-email-log-migrations"
php artisan migrate

You can publish the config file with:

php artisan vendor:publish --tag="filament-email-log-config"

This is the contents of the published config file:

return [

    'resource' => [
        'group' => null,
        'sort' => null,
    ],

    'keep_email_for_days' => 90,

];

Usage

This package will automatically register the EmailResource. You will be able to see it when you visit your Filament admin panel.

Customization

Group and sort order. You can customize the navigation group for the EmailResource by publishing the configuration file and updating the resource.group and resource.sort values.

Prunable model. You can customize how many days to keep the email in the database by updating the keep_email_for_days value. Then you can use or schedule the command artisan model:prune --model="Ramnzys\FilamentEmailLog\Models\Email". This will delete emails older than keep_email_for_days days old.

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Contributions are welcome. Please see CONTRIBUTING for details.

Credits

License

The MIT License (MIT). Please see License File for more information.