summaryrefslogtreecommitdiff
path: root/docs/email-configuration.markdown
diff options
context:
space:
mode:
Diffstat (limited to 'docs/email-configuration.markdown')
-rw-r--r--docs/email-configuration.markdown20
1 files changed, 19 insertions, 1 deletions
diff --git a/docs/email-configuration.markdown b/docs/email-configuration.markdown
index 0d16a2fb..c66996c6 100644
--- a/docs/email-configuration.markdown
+++ b/docs/email-configuration.markdown
@@ -22,6 +22,7 @@ There are several email transports available:
- PHP native mail function
- Mailgun
- Postmark
+- Sendgrid
Server settings
---------------
@@ -93,7 +94,7 @@ define('MAILGUN_API_TOKEN', 'YOUR_API_KEY');
define('MAILGUN_DOMAIN', 'YOUR_DOMAIN_CONFIGURED_IN_MAILGUN');
// Be sure to use the sender email address configured in Mailgun
-define('MAIL_FROM', 'sender-address-configured-in-postmark@example.org');
+define('MAIL_FROM', 'sender-address-configured-in-mailgun@example.org');
```
### Postmark HTTP API
@@ -116,6 +117,23 @@ define('POSTMARK_API_TOKEN', 'COPY HERE YOUR POSTMARK API TOKEN');
define('MAIL_FROM', 'sender-address-configured-in-postmark@example.org');
```
+### Sendgrid HTTP API
+
+You can use the HTTP API of Sendgrid to send emails.
+
+Configuration:
+
+```php
+// We choose "sendgrid" as mail transport
+define('MAIL_TRANSPORT', 'sendgrid');
+
+// Sendgrid username
+define('SENDGRID_API_USER', 'YOUR_SENDGRID_USERNAME');
+
+// Sendgrid password
+define('SENDGRID_API_KEY', 'YOUR_SENDGRID_PASSWORD');
+```
+
### The sender email address
By default, emails will use the sender address `notifications@kanboard.local`.