dmcbrn/laravel-email-database-log

A simple database logger for all outgoing emails sent by Laravel website - built from shvetsgroup/laravel-email-database-log.

Laravel Email Database Log

A simple database logger for all outgoing emails sent by Laravel website. Forked from ShvetsGroup\LaravelEmailDatabaseLog., _(*1)

For Laravel 5.8 - use 2.* versions, _(*2)

For Laravel 6 - use 3.* versions, _(*3)

For Laravel 7 - use 4.* versions, _(*4)

For Laravel 8 - use 5.* versions, _(*5)

Version 5.1 is using Filesystems which is a breaking change from 5.3. See below for upgrade information., _(*6)

Installation

Step 1: Composer

Laravel Email Database Log can be installed via composer by running this line in terminal:, _(*7)

composer require dmcbrn/laravel-email-database-log

Step 2: Configuration

You can skip this step if your version of Laravel is 5.5 or above. Otherwise, you have to add the following to your config/app.php in the providers array:, _(*8)

'providers' => [
    // ...
    Dmcbrn\LaravelEmailDatabaseLog\LaravelEmailDatabaseLogServiceProvider::class,
],

Step 3: Migration

Now, run this in terminal:, _(*9)

php artisan migrate

Step 4: Config

To publish config file run this in terminal:, _(*10)

php artisan vendor:publish --provider="Dmcbrn\LaravelEmailDatabaseLog\LaravelEmailDatabaseLogServiceProvider"

Config contains following parameters:, _(*11)

//name of the disk where the attachments will be saved
'disk' => env('EMAIL_LOG_DISK','email_log_attachments'),

//to prevent access to list of logged emails through WEB routes add a middlewares
//multiple middlewares can be used (separate by comma)
'access_middleware' => env('EMAIL_LOG_ACCESS_MIDDLEWARE',null),

//to prevent access to list of logged emails through API routes add a middlewares
//multiple middlewares can be used (separate by comma)
'access_middleware_api' => env('EMAIL_LOG_ACCESS_MIDDLEWARE_API',null),

//this parameter prefixes the routes for listing of logged emails using WEB routes
'routes_prefix' => env('EMAIL_LOG_ROUTES_PREFIX',''),

//this parameter prefixes the routes for listing of logged emails using API routes
'routes_prefix_api' => env('EMAIL_LOG_ROUTES_PREFIX_API',''),

//custom route prefix for webhooks
'routes_webhook_prefix' => env('EMAIL_LOG_ROUTES_WEBHOOK_PREFIX', env('EMAIL_LOG_ROUTES_PREFIX','')),

//mailgun secret and whether to ommit events for emails which were not found
'mailgun' => [
    'secret' => env('MAILGUN_SECRET', null),
    'filter_unknown_emails' => env('EMAIL_LOG_MAILGUN_FILTER_UNKNOWN_EMAILS', true),
],

Usage

After installation, any email sent by your website will be logged to email_log table in the site's database., _(*12)

Any attachments will be saved in storage/email_log_attachments disk. The email_log_attachments can be changed by publishing the config file and changing the 'folder' value., _(*13)

You also need to add the following disk in the config/filesystems.php file:, _(*14)

'email_log_attachments' => [
    'driver' => 'local',
    'root' => storage_path('app/email_log_attachments'),
],

If you want to process the logged email or save/format some additional data on your system you can hook up to the Dmcbrn\LaravelEmailDatabaseLog\LaravelEvents\EmailLogged event via a Laravel listener:, _(*15)

https://laravel.com/docs/5.5/events#defining-listeners, _(*16)

Don't forget to register the event:, _(*17)

https://laravel.com/docs/5.5/events#registering-events-and-listeners, _(*18)

If you're using Laravel >=5.8.9 you can use Event Discovery instead:, _(*19)

https://laravel.com/docs/5.8/events#registering-events-and-listeners, _(*20)

If using queues on your server you will need to restart the worker for the library to work:, _(*21)

Remember, queue workers are long-lived processes and store the booted application state in memory. 
As a result, they will not notice changes in your code base after they have been started. 
So, during your deployment process, be sure to restart your queue workers.


https://laravel.com/docs/5.5/queues#running-the-queue-worker

You can review sent emails using the following URI /email-log., _(*22)

You can prefix this URI by adding something like EMAIL_LOG_ROUTES_PREFIX=prefix/ to your .env file., _(*23)

You can protect this URI using middleware by adding something like EMAIL_LOG_ACCESS_MIDDLEWARE=auth,landlord to your .env file., _(*24)

MailGun webhooks

You can use Mailgun webhooks to log webhook events. In your MailGun Webhooks section add:, _(*25)

https://example.com/email-log/webhooks/event

for all of the events. If you used a prefix in the config file then this should be reflected in the url:, _(*26)

https://example.com/your-prefix/email-log/webhooks/event

Upgrade from 5.2.2 to 5.3.0 - API ENDPOINTS AVAILABLE, BREAKING CHANGE

API ENDPOINTS AVAILABLE:, _(*27)

New routes with JSON responses:, _(*28)

https://example.com/api/your-prefix/email-log
https://example.com/api/your-prefix/email-log/{id}
https://example.com/api/your-prefix/email-log/{id}/attachment/{attachment}
https://example.com/api/your-prefix/email-log/delete

BREAKING CHANGE:, _(*29)

The logic for presentation of attachments (on single email view: show.blade.php) has been moved to backend. If you are not using the default show.blade.php and are displaying list of attachments you should reflect these changes in your code. Namely, you no need to check if the file exists or add the attachment to the route to access it. Instead the returned data will be array with of following formats (depending if file can be found on disk or not):, _(*30)

//file can be found
[
    'name' => 'filename.pdf',
    'route' => 'https://example.com/api/email-log/email-id/attachment/attachment-key',
]
//file can't be found
[
    'name' => 'filename.pdf',
    'message' => 'file not found',
]

Note following: /api part will be dropped in html response, email-id is the id of the email, attachment-key is the order of attachment starting at 0., _(*31)

Upgrade from 5.1.0 to 5.2.0 - BREAKING CHANGE

Add the following parameters to the end of the config/email_log.php array:, _(*32)

    ...

    'routes_webhook_prefix' => env('EMAIL_LOG_ROUTES_WEBHOOK_PREFIX', env('EMAIL_LOG_ROUTES_PREFIX','')),
    'mailgun' => [
        'secret' => env('MAILGUN_SECRET', null),
        'filter_unknown_emails' => env('EMAIL_LOG_MAILGUN_FILTER_UNKNOWN_EMAILS', true),
    ],

Upgrade from 5.0.3 to 5.1.0 - BREAKING CHANGE

IMPORTANT - please upgrade to 5.2.1 right away as there are some fixes for the 5.1.0 upgrade. I was hastly and missed some issues which are corrected in 5.2.1., _(*33)

As email log attachments might quickly grow to large size you'd want to use some external storage to save them. To enable this we need to utilize the Laravel's Filesystem. Follow the guide below if you were using the 5.0.3 and wish to upgrade to 5.1.0., _(*34)

Change a line in config/email_log.php file from:, _(*35)

'folder' => env('EMAIL_LOG_ATTACHMENT_FOLDER','email_log_attachments'),

to, _(*36)

'disk' => env('EMAIL_LOG_DISK','email_log_attachments'),

In config/filesystems.php add, _(*37)

'email_log_attachments' => [
    'driver' => 'local',
    'root' => storage_path('app/email_log_attachments'),
],

the 'root' must point to the folder where you were previously saving the attachements., _(*38)

You will also need to drop the current prefix from the email_log.attachments column (default was email_log_attachments). For example email_log_attachments/12345678910/my_file.jpg should be renamed to 12345678910/my_file.jpg., _(*39)

You can run following code using php artisan tinker to fix these issues. Depending on the amount of data, it could take some time to finish:, _(*40)

$log = Dmcbrn\LaravelEmailDatabaseLog\EmailLog::where('attachments','!=', null)
$log->count()
$log->chunk(100, function($chunk) { foreach($chunk as $l) { $l->attachments = str_replace('email_log_attachments/', '', $l->attachments); $l->save(); } })