To receive email notifications, users of Kanboard must have:
- Activated notifications in their profile
- Have a valid email address in their profile
- Be a member of the project that will trigger notifications
Note: The logged user who performs the action doesn’t receive any notifications, only other project members.
There are several email transports available:
- PHP native mail function
- Other methods can be provided by external plugins: Postmark, Sendgrid and Mailgun
By default, Kanboard will use the bundled PHP mail function to send emails. Usually that requires no configuration if your server can already send emails.
However, it’s possible to use other methods, the SMTP protocol and Sendmail.
Rename the file
config.php and change
// We choose "smtp" as mail transport define('MAIL_TRANSPORT', 'smtp'); // We define our server settings define('MAIL_SMTP_HOSTNAME', 'mail.example.com'); define('MAIL_SMTP_PORT', 25); // Credentials for authentication on the SMTP server (not mandatory) define('MAIL_SMTP_USERNAME', 'username'); define('MAIL_SMTP_PASSWORD', 'super password');
It’s also possible to use a secure connection, TLS or SSL:
define('MAIL_SMTP_ENCRYPTION', 'ssl'); // Valid values are "null", "ssl" or "tls"
Some servers will reject emails based on the hostname transmitted with the HELO (EHLO) command (see RFC 5321). The (fully-qualified) hostname supplied in the HELO command can be set explicitly by:
define('MAIL_SMTP_HELO_NAME', null); // valid: null (default), or FQDN
By default the sendmail command will be
/usr/sbin/sendmail -bs but
you can customize that in your config file.
// We choose "sendmail" as mail transport define('MAIL_TRANSPORT', 'sendmail'); // If you need to change the sendmail command, replace the value define('MAIL_SENDMAIL_COMMAND', '/usr/sbin/sendmail -bs');
PHP built-in mail function¶
This is the default configuration:
Sender Email Address¶
By default, emails will use the sender address
firstname.lastname@example.org. It’s not possible to reply to this
You can customize this address by changing the value of the constant
MAIL_FROM in your config file.
That can be useful if your SMTP server configuration doesn’t accept the default address.
If no emails are sent and you are sure that everything is configured correctly:
- Check your spam folder
- Enable the debug mode and check the debug file
data/debug.log, you should see the exact error
- Be sure that your server or your hosting provider allows you to send emails
- If you use SeLinux, allow PHP to send emails