BookStack sends out emails for a range of purposes such as email-address confirmation & “forgot password” flows. The following mechanisms for sending mail are supported:
- Sendmail (Linux sendmail)
To get up and running with SMTP you will need to add, or set, the following variables in your
MAIL_DRIVER=smtp # Host, Port & Encryption mechanism to use MAIL_HOST=smtp.provider.tld MAIL_PORT=465 MAIL_ENCRYPTION=tls # Authentication details for your SMTP service MAIL_USERNAMEemail@example.com MAIL_PASSWORD=onlyifneeded # The "from" email address for outgoing email MAIL_FROMfirstname.lastname@example.org # The "from" name used for outgoing email MAIL_FROM_NAME=BookStack
sendmail drivers uses the sendmail application on the host system. It will call
To enable this option you can set the following in your
MAIL_DRIVER=sendmail # The "from" email address for outgoing email MAIL_FROMemail@example.com # The "from" name used for outgoing email MAIL_FROM_NAME=BookStack
You can follow the instructions provided in the debugging documentation page to help gain more details about issues you may come across. Within the Settings > Maintenance area of BookStack you can find a “Send a Test Email” action which provides a quick & easy way to send emails after changing your configuration. This action will also attempt to capture any errors thrown and display them.