README

A Laravel package for automatically tracking emails sent through Mail and Notification features. Capture email metadata, monitor delivery status, and maintain a complete history of your application's email communications.

Features

• 🚀 Automatic Tracking - Captures email metadata without changing existing code
• 👁️ Open & Click Tracking - Auto-injects a tracking pixel and rewrites links for all HTML mail (self-hosted, any transport)
• 📊 Status Monitoring - Tracks email lifecycle from "Sending" to "Sent"
• 🔍 Hash-based Identification - Unique identifiers for each email
• ⚡ Queue Support - Works seamlessly with Laravel's queue system
• 🎯 Mailable & Notification Support - Track both mail types
• 🛠️ Artisan Commands - Built-in testing and maintenance tools

Quick Start

Installation

composer require cleaniquecoders/mailhistory
php artisan vendor:publish --tag="mailhistory-migrations"
php artisan migrate

Basic Usage

Add the trait to your Mailable:

use CleaniqueCoders\MailHistory\Concerns\InteractsWithMailMetadata;

class WelcomeMail extends Mailable
{
    use InteractsWithMailMetadata;

    public function __construct()
    {
        $this->configureMetadataHash();
    }
}

That's it! Your emails are now being tracked automatically.

Documentation

Comprehensive documentation is available in the docs/ directory:

📚 Complete Documentation

• Getting Started - Installation, configuration, and quick start
• Usage Guide - Mail tracking, notifications, and commands
• Architecture - Technical deep-dive and design patterns
• Advanced Topics - Custom hashes, testing, and troubleshooting

Quick Links

• Installation Guide
• Configuration
• Mail Tracking
• Notification Tracking
• Artisan Commands
• Troubleshooting

Requirements

• PHP 8.1 or higher
• Laravel 9.x, 10.x, or 11.x

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

• Nasrul Hazim Bin Mohamad
• All Contributors

License

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