README

Laravel Mail Viewer

Easily log, view, and search outgoing emails directly in your browser.

This package logs all outgoing emails to a database and provides a web interface to view them, formatted as they appear in modern email clients like Gmail.

• Laravel Mail Viewer
  • Features
  • Installation
    • Step 1: Install via Composer
    • Step 2: Publish Assets & Configurations
    • Step 3: Run Migrations
    • Step 4: View Emails
  • Configuration
    • Data Pruning
  • Production Usage
    • Restrict Access with Middleware
    • Disable package in production mode
      • Disable auto-discovery:
      • Register package for non-production environments
  • License
  • Credits

Features

• Logs all outgoing emails to the database
• Modern in-browser email viewer
• Searchable UI with auto-refreshing entries
• Configurable route and access protection
• Optional email pruning

Installation

Step 1: Install via Composer

Run the following command in your terminal:

composer require masterro/laravel-mail-viewer

Step 2: Publish Assets & Configurations

php artisan mail-viewer:publish

Step 3: Run Migrations

php artisan migrate

Step 4: View Emails

Visit /_mail-viewer in your browser to access the email viewer.

Note: The route can be customized in the configuration file.

Configuration

You can adjust default settings in the config/mail-viewer.php file.

Data Pruning

The package supports Laravel's Model Pruning. Define how many days emails should be retained in the configuration:

'prune_older_than_days' => 365,

Production Usage

By default, the email viewer is publicly accessible. In a production environment, it's highly recommended to restrict access using middleware or something like Access Screen package. Alternatively, you can disable the package in production environments.

Restrict Access with Middleware

Modify your config/mail-viewer.php to apply authorization:

'middleware' => ['web', 'can:viewMailLogs'],

Note: viewMailLogs is just an example ability you can register via Laravel’s Authorization Gate. This ability is not included in the package.

You can also limit access by IP address in App\Http\Middleware\RestrictMailViewerAccess.php:

namespace App\Http\Middleware;

use Closure;
use Illuminate\Http\Request;

class RestrictMailViewerAccess
{
    public function handle(Request $request, Closure $next)
    {
        if (!in_array($request->ip(), ['127.0.0.1', '::1', 'YOUR_ALLOWED_IP'])) {
            abort(403);
        }

        return $next($request);
    }
}

Apply it in config:

'middleware' => ['web', RestrictMailViewerAccess::class],

Now, only authorized users or allowed IPs can access the mail viewer.

Disable package in production mode

Disable auto-discovery:

"extra": {
  "laravel": {
    "dont-discover": [
      "masterro/laravel-mail-viewer"
    ]
  }
},

Register package for non-production environments

In your application's ServiceProvider

use MasterRO\MailViewer\Providers\MailViewerServiceProvider;

public function register(): void
{
    if (!$this->app->environment('production')) {
        $this->app->register(MailViewerServiceProvider::class);
    }
}

License

This package is open-source software licensed under the MIT license.

Credits

Developed by MasterRO.