README

Yii Logging Library - Email Target

This package provides the Email target for the yiisoft/log library.

Requirements

• PHP 8.1 - 8.5.

Installation

The package could be installed with Composer:

composer require yiisoft/log-target-email

General usage

Creating a target:

$emailTarget = new \Yiisoft\Log\Target\Email\EmailTarget($mailer, $emailTo, $subjectEmail, $levels);

• $mailer (\Yiisoft\Mailer\MailerInterface) - The mailer instance that sends email and should be already configured.
• $emailTo (string|array) - The receiver email address. You may pass an array of addresses if multiple recipients should receive this message. You may also specify receiver name in addition to email address using format: [email => name].
• $subjectEmail (string) - The email message subject. Defaults to Application Log.
• $levels (array) - Optional. The log message levels that this target is interested in. Defaults to [] (all levels). For example: [LogLevel::ERROR, LogLevel::WARNING].

Example with level filtering:

use Psr\Log\LogLevel;

// Only log ERROR and WARNING messages
$emailTarget = new \Yiisoft\Log\Target\Email\EmailTarget(
    $mailer, 
    'admin@example.com', 
    'Application Errors',
    [LogLevel::ERROR, LogLevel::WARNING]
);

Creating a logger:

$logger = new \Yiisoft\Log\Logger([$emailTarget]);

For use in the Yii framework, see the configuration files:

• config/di.php
• config/params.php

Documentation

For a description of using the logger, see the yiisoft/log package.

• Yii guide to logging
• Internals

If you need help or have a question, the Yii Forum is a good place for that. You may also check out other Yii Community Resources.

License

The Yii Logging Library - Email Target is free software. It is released under the terms of the BSD License. Please see LICENSE for more information.

Maintained by Yii Software.

Support the project

Follow updates