README

A simple Laravel package that automatically logs every email sent by your application to the database. It listens to Laravel's built-in MessageSending event to record information without wrapping or modifying the mailer itself. Ships with configurable table names, a swappable Eloquent model, and a built-in prune command to manage retention.

Requirements

PHP 8.4+
Laravel 13+

Installation

You can install the package via composer:

composer require codeldev/laravel-mail-log

You can publish and run the migrations with:

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

You can publish the config file with:

php artisan vendor:publish --tag="mail-log-config"

This is the contents of the published config file:

return [
    'prune_days' => (int) env('MAIL_LOG_PRUNE_DAYS', 365),
    'model' => CodelDev\LaravelMailLog\Models\LaravelMailLog::class,
    'table' => env('MAIL_LOG_TABLE', 'mail_log'),
];

Environment Variables

The following env variables are available to configure the package using your env file.

MAIL_LOG_PRUNE_DAYS=365
MAIL_LOG_TABLE=mail_log

Usage

Once installed, the package automatically logs every outgoing email. No additional setup is required.

Pruning Old Records

Add to your routes/console.php file:

Schedule::command('mail-log:prune')
    ->weeklyOn(1, '02:30')
    ->withoutOverlapping();

Run manually:

php artisan mail-log:prune

Querying the Data

The package provides an Eloquent model you can use directly:

use CodelDev\LaravelMailLog\Models\LaravelMailLog;

// Get all logged emails
$emails = LaravelMailLog::all();

// Get emails sent to a specific address (not available for SQLite)
$emails = LaravelMailLog::query()
    ->whereJsonContains('to', 'user@example.com')
    ->latest()
    ->get();

// Get emails sent today
$emails = LaravelMailLog::query()
    ->whereDate('created_at', today())
    ->get();

// Search by subject
$emails = LaravelMailLog::query()
    ->where('subject', 'like', '%Welcome%')
    ->latest()
    ->get();

Available Fields

LaravelMailLog

Field	Type
`id`	`string` (UUID)
`from`	`string\|null`
`to`	`array<int, string>\|null`
`cc`	`array<int, string>\|null`
`bcc`	`array<int, string>\|null`
`subject`	`string`
`body`	`string`
`headers`	`string\|null`
`attachments`	`array<int, string>\|null`
`created_at`	`CarbonImmutable`
`updated_at`	`CarbonImmutable`

Using a Custom Model

You can extend the package model to add your own behaviour, scopes, or relationships. Create your custom model, extend the package model, then update the config:

use CodelDev\LaravelMailLog\Models\LaravelMailLog as BaseMailLog;

class MailLog extends BaseMailLog
{
    public function scopeToRecipient($query, string $email)
    {
        return $query->whereJsonContains('to', $email);
    }
}

Then in config/mail-log.php:

'model' => \App\Models\MailLog::class,

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

CodelDev

License

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

codeldev / laravel-mail-log

Maintainers

Package info

Fund package maintenance!

Statistics

Security