Review the auth email template doc

This commit is contained in:
Jim LAURIE 2019-09-23 16:59:20 +02:00
parent 9155d34124
commit 088653a9b9
3 changed files with 23 additions and 16 deletions

View File

@ -343,6 +343,26 @@ Add the language translation in `packages/strapi-plugin-users-permissions/admin/
These two change will set up the popup message that appears in the UI. That's it, now you should be able to use your new provider.
## Email templates
## Templating emails
[See the documentation on GitHub](https://github.com/strapi/strapi/blob/master/packages/strapi-plugin-users-permissions/docs/email-templates.md)
By default, this plugin comes with only one template (reset password) for the moment. More templates will come later. The templates use Lodash' template() method to populate the variables.
You can update these template in the **Email Templates** tab in the admin panel.
### Reset Password
- `USER` (object)
- `username`
- `email`
- ...and every other fields that you added manually in the model.
- `TOKEN` corresponds to the token generated to be able to reset the password.
- `URL` is the link where the user will be redirected after clicking on it in the email.
### Email address confirmation
- `USER` (object)
- `username`
- `email`
- ...and every other fields that you added manually in the model.
- `CODE` corresponds to the CODE generated to be able confirm the user email.
- `URL` is the Strapi backend URL that confirm the code (by default `/auth/email-confirmation`).

View File

@ -210,7 +210,7 @@ class PopUpForm extends React.Component {
const params = {
link: (
<a
href="https://github.com/strapi/strapi/blob/master/packages/strapi-plugin-users-permissions/docs/email-templates.md"
href="https://github.com/strapi/strapi/blob/master/docs/3.0.0-beta.x/guides/authentication.md#templating-emails"
target="_blank"
rel="noopener noreferrer"
>

View File

@ -1,13 +0,0 @@
# Templating emails
By default, this plugin comes with only one template (reset password) for the moment. More templates will come later. The templates use Lodash' template() method to populate the variables.
### Reset Password
- `USER` (object)
- `username`
- `email`
- ...and every other fields that you added manually in the model.
- `TOKEN` corresponds to the token generated to be able to reset the password.
- `URL` is the link where the user will be redirected after clicking on it in the email.