beyondcode/helo-laravel

HELO Laravel debug helper

1.3.0 2021-05-11 11:05 UTC

This package is auto-updated.

Last update: 2021-07-11 11:30:45 UTC


README

Latest Version on Packagist Build Status Quality Score Total Downloads

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.