summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorFrederic Guillot <fred@kanboard.net>2015-06-13 13:17:16 -0400
committerFrederic Guillot <fred@kanboard.net>2015-06-13 13:17:16 -0400
commitf2abf339120751f11f729606b46927332f886a1d (patch)
tree46976ea48e812b18903b2bde2d84ab113bc0708f /docs
parent7ba9b2d9b9b8426aacabcb7e3e4a0c08d2be5444 (diff)
Add Sendgrid as mail transport
Diffstat (limited to 'docs')
-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`.