diff --git a/docs/provider/email.md b/docs/provider/email.md index af512cd99..0e901cde4 100644 --- a/docs/provider/email.md +++ b/docs/provider/email.md @@ -17,3 +17,29 @@ authors: [kininaru] ![Email Config](/img/providers/emailconfig.png) 4. Fill customized `Email Title` and `Email Content` and save. + +## Example + +Here we use MailHog as the SMTP server. [MailHog](https://github.com/mailhog/MailHog) is an email-testing tool with a fake SMTP server underneath. + +1. Deploy the MailHog service. + +Here the IP address for the MailHog service is `192.168.24.128`, and the SMTP service port is `1025`. + +![mailhog config](/img/providers/mailhog_conf.png) + +2. Create a Email provider. + +Fill the necessary information and save. + +![mailhog email provider](/img/providers/mailhog_email_provider_conf.png) + +3. Sending Test Email. + +First, click on the `Test SMTP Connection` button, if you see `provider: SMTP connected successfully`, it means that your Casdoor service can access the MailHog service. + +Second, click on the `Send Testing Email` button, if you see `Email sent successfully`, it means that the test email has been successfully sent from the `From address` to the `Test Email`. + +![mailhog send test email](/img/providers/mailhog_send_test_email.png) + +![mailhog recv test email](/img/providers/mailhog_recv_test_email.png) diff --git a/static/img/providers/mailhog_conf.png b/static/img/providers/mailhog_conf.png new file mode 100644 index 000000000..da53ab7ff Binary files /dev/null and b/static/img/providers/mailhog_conf.png differ diff --git a/static/img/providers/mailhog_email_provider_conf.png b/static/img/providers/mailhog_email_provider_conf.png new file mode 100644 index 000000000..e960674ca Binary files /dev/null and b/static/img/providers/mailhog_email_provider_conf.png differ diff --git a/static/img/providers/mailhog_recv_test_email.png b/static/img/providers/mailhog_recv_test_email.png new file mode 100644 index 000000000..91fd30fb7 Binary files /dev/null and b/static/img/providers/mailhog_recv_test_email.png differ diff --git a/static/img/providers/mailhog_send_test_email.png b/static/img/providers/mailhog_send_test_email.png new file mode 100644 index 000000000..676e1b6da Binary files /dev/null and b/static/img/providers/mailhog_send_test_email.png differ