README

This package allows you to easily send expiring emails. This is useful for cases where you do not want to send sensitive data over email directly and you want to make that no sensitive information is kept in a recipient's mailbox without having control over that data.

By using the expiring email driver of this package instead of the regular email driver in a notification, all that is sent to the receiver is a signed and expiring link to the original content of the email.

Installation

You can install the package via composer:

composer require casperboone/laravel-expiring-email

You should publish and run the migrations with:

php artisan vendor:publish --provider="CasperBoone\LaravelExpiringEmail\LaravelExpiringEmailServiceProvider" --tag="expiring-email-migrations"
php artisan migrate

You can optionally publish the config file with:

php artisan vendor:publish --provider="CasperBoone\LaravelExpiringEmail\LaravelExpiringEmailServiceProvider" --tag="expiring-email-config"

You can optionally publish the views to customize the replacement email with:

php artisan vendor:publish --provider="CasperBoone\LaravelExpiringEmail\LaravelExpiringEmailServiceProvider" --tag="expiring-email-views"

An email immediately becomes inaccessible after the expiration date. However, to also remove the emails from your database after the expiration date, you should schedule "clean" command to be run daily.

// app/Console/Kernel.php

protected function schedule(Schedule $schedule)
{
    $schedule->command(CleanExpiredEmails::class)->daily();
}

Usage

The basic usage of this package is very easy, all you need to do is replace 'email' in your via() method of a notification to the expiring email notification channel.

 public function via($notifiable): array
 {
-    return ['mail'];
+    return [ExpiringEmailChannel::class];
 }

This sends an email to the original receiver with a signed expiring link to the content of the original email. The default expiration date is set in the config file but can be set on a case-by-case basis in the notification using ExpiringMailMessage:

 public function toMail($notifiable): MailMessage
 {
-    return (new MailMessage)
+    return (new ExpiringMailMessage)
         ->subject('Secret document')
+        ->expiresInDays(7)
         ->markdown('secret_document_email');
 }

Development

Testing

composer test

Static analysis

composer psalm

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.

casperboone / laravel-expiring-email

Maintainers

Details