Skip to content

Commit 637d0c1

Browse files
authored
docs: Update use SendGrid as Email Provider instead of SMTP Server (#643)
* docs: Update use SendGrid as Email Provider instead of SMTP Server * docs: fix link detected
1 parent adc9c33 commit 637d0c1

File tree

2 files changed

+32
-18
lines changed

2 files changed

+32
-18
lines changed

docs/provider/email/sendgrid.md

Lines changed: 32 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,50 @@
11
---
22
title: SendGrid
3-
description: Using SendGrid as the SMTP server
3+
description: Using SendGrid as an Email Provider
44
keywords: [email, SendGrid]
55
authors: [UsherFall]
66
---
77

8-
In this guide, we will be using SendGrid as the SMTP server.
8+
In this guide, we will use SendGrid as an email provider.
99

10-
### Step 1: Create API key for your SendGrid account
10+
## Step 1: Create an API Key for Your SendGrid Account
1111

12-
Expand the **Settings** from the left navigation bar, click on the **API Keys** option from this list. Here, you will see all of your API keys if you have generated any in the past. To generate a new one, you need to click on **Create API Key** and pay attention to the permissions.
12+
Expand **Settings** from the left navigation bar, then click on **API Keys**. Here, you will see all previously generated API keys. To create a new one, click on **Create API Key** and configure the necessary permissions.
1313

1414
![sendgrid_apikey](/img/providers/sendgrid_apikey.png)
1515

16-
### Step 2: Sender Verification
16+
## Step 2: Sender Verification
1717

18-
Refer to the document to verify your email sender, you can choose **Single Sender Verification** or **Domain Authentication**: [Sender Identity](https://docs.sendgrid.com/for-developers/sending-email/sender-identity)
18+
To verify your email sender, choose between **Single Sender Verification** or **Domain Authentication** by referring to the official documentation:
19+
[Sender Identity](https://docs.sendgrid.com/for-developers/sending-email/sender-identity)
1920

20-
### Step 3: Configure Casdoor email Provider
21+
## Step 3: Configure Casdoor as an Email Provider
2122

22-
Now create an email provider in Casdoor. Fill in the required fields below:
23+
Create a SendGrid email provider in Casdoor and fill in the following fields:
2324

24-
| Required fields | Remark |
25-
|-----------------|---------------------------|
26-
| Username | Enter "apikey" |
27-
| Password | Your SendGrid's API key |
28-
| From Address | Your verified sender |
29-
| Host | Enter "smtp.sendgrid.net" |
30-
| Port | Default is 465 |
25+
### Required Fields
3126

32-
![sendgrid_provider](/img/providers/sendgrid_provider.png)
27+
| Field | Description |
28+
|--------------|--------------------------------------------|
29+
| Secret Key | Your SendGrid API key |
30+
| From Address | Your verified email address (or domain) |
3331

34-
Click on the `Test SMTP Connection` button. If you see `provider: SMTP connected successfully`, it means that your Casdoor service can access the SendGrid service.
32+
### Default Fields
3533

36-
Next, click on the `Send Testing Email` button. If you see `Email sent successfully`, it means that the test email has been sent successfully from the `From` address to the `Test Email`.
34+
| Field | Description |
35+
|---------|--------------------------------------|
36+
| Endpoint | Default: `/v3/mail/send` |
37+
| Host | Default: `https://api.sendgrid.com` |
38+
39+
### Email Fields
40+
41+
| Field | Description |
42+
|--------------|-------------------------------------------|
43+
| From Name | The display name of the email sender |
44+
| Email Title | The subject of the email |
45+
| Email Content | Supports HTML templates |
46+
| Test Email | The recipient's email address for testing |
47+
48+
![sendgrid_email_provider_fields](/img/providers/sendgrid_email_provider_fields.png)
49+
50+
Finally, click on the **Send Testing Email** button and check your `Test Email` address for the test email.
225 KB
Loading

0 commit comments

Comments
 (0)