yujunjun/strapi
1
0
Fork 0
mirror of https://github.com/strapi/strapi.git synced 2025-12-26 06:35:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update email.md (#7769)

Browse Source 
* Update email.md

to emphasize the part that developer need to pay attention to, especially the file name, and rewrite the part of the sentences on updating default sender email to make it works with the new email provider. Such that those who read this documentation could avoid hours of troubleshooting this configuration, (like what I had)

Signed-off-by: William Cheong Weelau <cheongweelau@gmail.com>

* Update email.md

Added the missing `:::` to close the newly added tip paragraph

Signed-off-by: William Cheong Weelau <cheongweelau@gmail.com>
This commit is contained in:
William Cheong Weelau 2020-09-14 15:32:44 +08:00 committed by GitHub
parent 5509d68c48
commit 74ed5a2e2d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/v3.x/plugins/email.md
View File

@ -96,7 +96,10 @@ The string after the last `@` represents your desired [semver](https://docs.npmj
### Configure your provider
After installing your provider you will need to add some settings in `config/plugins.js`. If this file doesn't exists, you'll need to create it. Check the README of each provider to know what configuration settings the provider needs.
After installing your provider you will need to add some settings in `config/plugins.js`.
If this file doesn't exists, you'll need to create it.
> ⚠️ Do note that filename has to come with correct spelling, plugin with 's' (plural). -> `plugins.js`
Check the README of each provider to know what configuration settings the provider needs.
Here is an example of a configuration made for the provider [strapi-provider-email-sendgrid](https://www.npmjs.com/package/strapi-provider-email-sendgrid).
@ -124,7 +127,11 @@ If you're using a different provider depending on your environment, you can spec
:::
::: tip
When testing the new email provider with one the two templates created during strapi setup, the shipper email used is the one on the template, which is no-reply@strapi.io and it has to be modified to the email used with your email provider, otherwise it will fail the test.
Only one email provider will be active at all time. If the email provider setting isn't picked up by strapi, verify you have put the file `plugins.js` in the correct folder, and with correct filename. The selection of email provider is done via configuration file only.
:::
::: tip
When testing the new email provider with those two email templates created during strapi setup, the *shipper email* on the template, with default no-reply@strapi.io need to be updated in according to your email provider, otherwise it will fail the test.
More info here: [Configure templates Locally](http://localhost:1337/admin/plugins/users-permissions/email-templates)
:::