Download the PHP package esign/laravel-email-whitelisting without Composer
On this page you can find all versions of the php package esign/laravel-email-whitelisting. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download esign/laravel-email-whitelisting
More information about esign/laravel-email-whitelisting
Files in esign/laravel-email-whitelisting
Package laravel-email-whitelisting
Short Description Whitelist outgoing email
License MIT
Homepage https://github.com/esign/laravel-email-whitelisting
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package laravel-email-whitelisting
Whitelist outgoing email
This package allows you to whitelist email addresses for outgoing emails. This way you have control over what addresses should be allowed to receive mails. This comes in handy when testing on development / staging environments.
Installation
You can install the package via composer:
Next up, you can publish the configuration file:
The config file will be published as config/email-whitelisting.php with the following contents:
Usage
This package is disabled by default. To enable it you may set the EMAIL_WHITELISTING_ENABLED env variable to true.
It ships with both a ConfigurationDriver and DatabaseDriver out of the box.
Config
You may define whitelisted email addresses for the config driver under the mail_addresses key.
Database
In case you want to configure email whitelisting using the database this package comes with a database driver out of the box. Make sure to publish the migration before making use of this driver:
Whitelisted email addresses can be created in the following way:
Redirecting emails
In some cases you might want to redirect all outgoing mail to certain addresses.
This can be achieved by setting the env variable EMAIL_WHITELISTING_REDIRECTING_ENABLED to true.
When using the database driver you may specify to which email addresses outgoing mail will be redirected, by setting the redirect_email column value to true.
When using the config driver no extra configuration is required. Email addresses defined in the mail_addresses will be used.
Wildcards
In case you need to cover lots of email addresses, this package supports using wildcards.
By using an * you're able to cover a full domain, e.g. *@esign.eu.
Notes
- Notifications sent through the
mailchannel will be whitelisted as well. - When there are no matching whitelisted email addresses found, the email will be cancelled.
- This package will append the original receivers to the subject of the outgoing mail. e.g.
My cool mail subject (To: [email protected]) (Cc: [email protected]).
Events
EmailAddressesSkipped
When an outgoing email contains recipients that are not whitelisted and are therefore skipped, the package will dispatch the Esign\EmailWhitelisting\Events\EmailAddressesSkipped event.
For information on how to register event listeners, see the Laravel documentation.
Testing
License
The MIT License (MIT). Please see License File for more information.
All versions of laravel-email-whitelisting with dependencies
illuminate/mail Version ^11.0|^12.0|^13.0
illuminate/support Version ^11.0|^12.0|^13.0