Configure email providers
Passbolt relies heavily on emails:
- Account creation
- Account recovery
- Notifications on different user actions
Having a working email setup is essential if you want to use passbolt at its best. There are many email providers and each one has its own setup process. The aim of this help page is to provide the basic concepts so each admin can setup their provider adjusting to their particular case.
TLS email providers
If your email provider supports TLS encryption your setup should look like this in
'EmailTransport' => [ 'default' => [ 'host' => 'your.smtp.provider.host.com', 'port' => 587, 'username' => 'user', 'password' => 'secret', 'tls' => true, ], ],
Or, if you are using environment variables:
EMAIL_TRANSPORT_DEFAULT_HOST=your.smtp.provider.host.com EMAIL_TRANSPORT_DEFAULT_PORT=587 EMAIL_TRANSPORT_DEFAULT_USERNAME=user EMAIL_TRANSPORT_DEFAULT_PASSWORD=secret EMAIL_TRANSPORT_DEFAULT_TLS=true
Replace ‘your.smtp.provider.host.com’, ‘user’ and ‘secret’ with the actual values for your provider. Usually email providers that support TLS use port 587 however you should check with your provider specific requirements.
SSL email providers
Some providers support SSL encryption and the setup is slightly different from the TLS case. Just change
config/passbolt.php file to look like this:
'EmailTransport' => [ 'default' => [ 'host' => 'ssl://your.smtp.provider.host.com', 'port' => 465, 'username' => 'user', 'password' => 'secret', 'tls' => null, ], ],
In the case of using env variables:
EMAIL_TRANSPORT_DEFAULT_HOST=ssl://your.smtp.provider.host.com EMAIL_TRANSPORT_DEFAULT_PORT=465 EMAIL_TRANSPORT_DEFAULT_USERNAME=user EMAIL_TRANSPORT_DEFAULT_PASSWORD=secret EMAIL_TRANSPORT_DEFAULT_TLS=null
This article was last updated on March 6th, 2020.