designmynight/laravel-log-mailer

A package to support logging via email in Laravel

v2.0.0 2023-11-01 15:37 UTC

This package is auto-updated.

Last update: 2024-10-30 01:37:14 UTC


README

Latest Stable Version Total Downloads StyleCI License: MIT

A service provider to add support for logging via email using Laravels built-in mail provider

image

Table of contents

Installation

Installation using composer:

composer require designmynight/laravel-log-mailer

Laravel version Compatibility

And add the service provider in config/app.php:

DesignMyNight\Laravel\Logging\MailableLogServiceProvider::class,

For usage with Lumen, add the service provider in bootstrap/app.php.

$app->register(DesignMyNight\Laravel\Logging\MailableLogServiceProvider::class);

Configuration

Most configuration options can be automatically populated by environment variables or in config/mailablelog.php, to generate it run php artisan vendor:publish.

To ensure all unhandled exceptions are mailed, set up a mail logging channel and add it to your logging stack in config/logging.php:

'channels' => [
    'stack' => [
        'driver' => 'stack',
        // Add mail to the stack:
        'channels' => ['single', 'mail'],
    ],

    // ...

    // Create a mail logging channel:
    'mail' => [
        'driver' => 'mail',
        // Specify who to mail the log to
        'to' => [
            [
                'address' => 'errors@designmynight.com',
                'name' => 'Error'
            ]
        ],
        // Optionally specify who the log mail was sent by
        // This is overidable in config/mailablelog.php and
        // falls back to your global from in config/mail.php
        'from' => [
            'address' => 'errors@designmynight.com',
            'name' => 'Errors'
        ],
        // Optionally overwrite the mailable template
        // 'mailable' => NewLogMailable::class
    ],
],

You can specify multiple channels and change the recipients and customise the email template per channel.