yiisoft / log-target-email
Yii Logging Library - Email Target
Fund package maintenance!
Open Collective
yiisoft
Requires
- php: ^8.0
- yiisoft/log: ^2.0
- yiisoft/mailer: ^3.0|^4.0|^5.0
Requires (Dev)
- maglnet/composer-require-checker: ^4.3
- phpunit/phpunit: ^9.5
- rector/rector: ^0.15.0
- roave/infection-static-analysis-plugin: ^1.25
- spatie/phpunit-watcher: ^1.23
- vimeo/psalm: ^4.30|^5.1
- yiisoft/di: ^1.2
- yiisoft/event-dispatcher: ^1.1
This package is auto-updated.
Last update: 2024-04-16 21:47:06 UTC
README
Yii Logging Library - Email Target
This package provides the Email target for the yiisoft/log library.
Requirements
- PHP 8.0 or higher.
Installation
The package could be installed with composer:
composer require yiisoft/log-target-email --prefer-dist
General usage
Creating a target:
$emailTarget = new \Yiisoft\Log\Target\Email\EmailTarget($mailer, $emailTo, $subjectEmail);
$mailer (\Yiisoft\Mailer\MailerInterface)
- The mailer instance that sends email and should be already configured.$emailTo (strig|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 toApplication Log
.
Creating a logger:
$logger = new \Yiisoft\Log\Logger([$emailTarget]);
For a description of using the logger, see the yiisoft/log package.
For use in the Yii framework, see the configuration files:
See Yii guide to logging for more info.
Testing
Unit testing
The package is tested with PHPUnit. To run tests:
./vendor/bin/phpunit
Mutation testing
The package tests are checked with Infection mutation framework with Infection Static Analysis Plugin. To run it:
./vendor/bin/roave-infection-static-analysis-plugin
Static analysis
The code is statically analyzed with Psalm. To run static analysis:
./vendor/bin/psalm
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.