tapp/filament-maillog

Filament plugin to view outgoing mail

v1.0.4 2024-11-07 13:01 UTC

This package is auto-updated.

Last update: 2024-11-07 13:02:32 UTC


README

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

This plugin adds an event listener to log emails sent on mail_logs database table. It also adds a Filament resource to view the mail logs.

Installation

You can install the package via composer:

composer require tapp/filament-maillog

You can publish and run the migrations with:

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

You can publish the config file with:

php artisan vendor:publish --tag="filament-maillog-config"

This is the contents of the published config file:

return [
    'amazon-ses' => [
        'configuration-set' => null,
    ],

    'resources' => [
        'MaiLogResource' => \Tapp\FilamentMailLog\Resources\MailLogResource::class,
    ],

    'navigation' => [
        'maillog' => [
            'register' => true,
            'sort' => 1,
            'icon' => 'heroicon-o-rectangle-stack',
        ],
    ],

    'sort' => [
        'column' => 'created_at',
        'direction' => 'desc',
    ],
];

Optionally, you can publish the translations files with:

php artisan vendor:publish --tag="filament-maillog-translations"

Using the Resource

Add this plugin to a panel on plugins() method. E.g. in app/Providers/Filament/AdminPanelProvider.php:

use Tapp\FilamentMailLog\FilamentMailLogPlugin;
 
public function panel(Panel $panel): Panel
{
    return $panel
        // ...
        ->plugins([
            FilamentMailLogPlugin::make(),
            //...
        ]);
}

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.