mindtwo/px-mail-laravel-driver

A project to integrate TX Mail as mail service in Laravel.

0.4.4 2024-03-14 16:12 UTC

This package is auto-updated.

Last update: 2024-10-14 17:24:06 UTC


README

Latest Version on Packagist Software License Total Downloads

Installation

You can install the package via composer:

composer require mindtwo/px-mail-laravel-driver

How to use?

Publish config

To publish the modules config file simply run

php artisan vendor:publish px-mail

This publishes the px-mail.php config file to your projects config folder. Note: This step is optional as long as you complete the next step.

Configure the package

After that you should add the following keys to your .env-file:

  • TX_MAIL_TENANT
  • TX_MAIL_CLIENT_ID
  • TX_MAIL_CLIENT_SECRET

This keys will auto populate the respective config values.

Inside your configuration you will also find the key:

stage which will use your APP_ENV variable.

To send mails via Laravels Mail-Facade you need to add inside your apps mail.php mailers section:

'txmail' => [
    'transport' => 'txmail',
],

Then you need to set your apps default mailer to 'txmail' or update your .env at the position MAIL_MAILER.

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email info@mindtwo.de instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.