beyondcode / helo-laravel
HELO Laravel debug helper
Installs: 295 422
Dependents: 0
Suggesters: 0
Security: 0
Stars: 88
Watchers: 8
Forks: 26
Open Issues: 2
Requires
- php: ^8.0 || ^8.1 || ^8.2
- illuminate/console: ^8.0 || ^9.0 || ^10.0 || ^11.0
- illuminate/mail: ^8.0 || ^9.0 || ^10.0 || ^11.0
- illuminate/view: ^8.0 || ^9.0 || ^10.0 || ^11.0
Requires (Dev)
- orchestra/testbench: ^7.0 || ^8.0 || ^9.0
- pestphp/pest: 1.x-dev || 2.x-dev
README
The helper package to add additional debug information from Laravel to your HELO mails.
Documentation
To install this package, require it via composer:
composer require --dev beyondcode/helo-laravel
You can also publish the package configuration using:
php artisan vendor:publish --provider="BeyondCode\HeloLaravel\HeloLaravelServiceProvider"
This will create a config file called helo.php
with the following content:
<?php return [ /** * This flag determines if you want to send additional SMTP headers that will contain the debug output that HELO * makes use of. * By default, this is only the case when your application is in debug mode. */ 'is_enabled' => env('HELO_ENABLED', env('APP_DEBUG')), ];
Using the package
When the package is enabled in your Laravel application, all mailables that you send via your application will contain additional SMTP headers with debug information, that HELO will display in the UI. Please refer to the HELO documentation in order to setup your application to send mails to HELO.
Once HELO accepts emails from your application, you can try if the package works, using the built-in test command:
php artisan helo:test
A test message should appear in your HELO UI containing additional debug information:
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email marcel@beyondco.de instead of using the issue tracker.
Credits
License
The MIT License (MIT). Please see License File for more information.