1. Go to this page and download the library: Download henryavila/email-tracking library. Choose the download type require.
2. Extract the ZIP file and open the index.php.
3. Add this code to the index.php.
<?php
require_once('vendor/autoload.php');
/* Start to develop here. Best regards https://php-download.com/ */
henryavila / email-tracking example snippets
public function boot(): void
{
\Illuminate\Support\Facades\Event::listen(
events: \Illuminate\Mail\Events\MessageSent::class,
listener: \HenryAvila\EmailTracking\Listeners\LogEmailSentListener::class
);
}
return [
/**
* Database connection for Email model (optional)
* If null, uses default connection
*/
'email-db-connection' => null,
/**
* Save HTML body of sent emails
*/
'log-body-html' => true,
/**
* Save text body of sent emails
*/
'log-body-txt' => true,
];
use HenryAvila\EmailTracking\Mail\TrackableMail;
class OrderShippedMail extends TrackableMail
{
public function __construct($order)
{
$viewData = [
'order' => $order,
'trackingNumber' => $order->tracking_number,
];
parent::__construct($order, 'emails.order-shipped', $viewData);
}
}
use HenryAvila\EmailTracking\Notifications\TrackableNotificationMailMessage;
class OrderShippedNotification extends Notification
{
public function __construct(protected Order $order)
{
}
public function toMail($notifiable): MailMessage
{
return (new TrackableNotificationMailMessage($this->order))
->subject('Your order has been shipped!')
->line('Your order #' . $this->order->number . ' is on its way.')
->action('Track Shipment', url('/orders/' . $this->order->id))
->line('Thank you for your purchase!');
}
}
namespace App\Enums;
enum EmailType: string
{
case TRANSACTIONAL = 'transactional';
case MARKETING = 'marketing';
case NOTIFICATION = 'notification';
case ADMINISTRATIVE = 'administrative';
case SYSTEM = 'system';
}
use App\Enums\EmailType;
use HenryAvila\EmailTracking\Mail\TrackableMail;
class OrderConfirmationMail extends TrackableMail
{
protected function getEmailType(): EmailType
{
return EmailType::TRANSACTIONAL;
}
}
use App\Models\Email;
// Get all transactional emails
$transactional = Email::where('email_type', 'transactional')->get();
// Add convenient scopes to your Email model
Email::transactional()->delivered()->get();
// Analytics by type
$stats = Email::select('email_type')
->selectRaw('count(*) as total, sum(opened) as opens')
->groupBy('email_type')
->get();
use HenryAvila\EmailTracking\Models\Email;
// Get all emails for a model
$order = Order::find(1);
$emails = $order->emails; // Requires ModelWithEmailsSenderTrait on Order model
// Query email status
$delivered = Email::whereNotNull('delivered_at')->get();
$opened = Email::where('opened', '>', 0)->get();
$clicked = Email::where('clicked', '>', 0)->get();
$failed = Email::whereNotNull('failed_at')->get();
// Get recent emails
$recentEmails = Email::orderBy('created_at', 'desc')->limit(10)->get();
// Search by recipient
$userEmails = Email::where('to', 'like', '%[email protected]%')->get();
namespace App\Listeners;
use HenryAvila\EmailTracking\Events\EmailWebhookProcessed;
use HenryAvila\EmailTracking\Events\Email\DeliveredEmailEvent;
use HenryAvila\EmailTracking\Events\Email\OpenedEmailEvent;
class MailgunWebhookProcessedListener
{
public function handle(EmailWebhookProcessed $event): void
{
match ($event->emailEvent::class) {
DeliveredEmailEvent::class => $this->handleDelivered($event->emailEvent),
OpenedEmailEvent::class => $this->handleOpened($event->emailEvent),
// Add other events as needed
default => null,
};
}
private function handleDelivered(DeliveredEmailEvent $event): void
{
// Your custom logic when email is delivered
$email = $event->email;
logger()->info("Email delivered to {$email->to}");
}
private function handleOpened(OpenedEmailEvent $event): void
{
// Your custom logic when email is opened
$email = $event->email;
logger()->info("Email opened by {$email->to}");
}
}