https://github.com/beyondcode/helo-laravel
HELO Laravel helper package to add
https://github.com/beyondcode/helo-laravel
Last synced: 9 months ago
JSON representation
HELO Laravel helper package to add
- Host: GitHub
- URL: https://github.com/beyondcode/helo-laravel
- Owner: beyondcode
- License: mit
- Created: 2020-03-12T15:24:21.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-07-01T09:04:18.000Z (over 1 year ago)
- Last Synced: 2025-03-28T05:28:59.183Z (9 months ago)
- Language: PHP
- Size: 247 KB
- Stars: 88
- Watchers: 7
- Forks: 24
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# HELO Laravel
[](https://packagist.org/packages/beyondcode/helo-laravel)
[](https://packagist.org/packages/beyondcode/helo-laravel)
The helper package to add additional debug information from Laravel to your [HELO](https://usehelo.com) mails.
## Documentation
To install this package, require it via composer:
```bash
composer require --dev beyondcode/helo-laravel
```
You can also publish the package configuration using:
```bash
php artisan vendor:publish --provider="BeyondCode\HeloLaravel\HeloLaravelServiceProvider"
```
This will create a config file called `helo.php` with the following content:
```php
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](https://usehelo.com) 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](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
### Security
If you discover any security related issues, please email marcel@beyondco.de instead of using the issue tracker.
## Credits
- [Marcel Pociot](https://github.com/mpociot)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.