This repository was archived by the owner on Sep 29, 2023. It is now read-only.
Update SMTP template docs #368
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,76 @@ | ||||||
| <p>Appwrite uses emails messages to perform user invite, user verification, login, and reset password. Emails messages can be customized to fit your app's design and voice.</p> | ||||||
|
|
||||||
| <h2><a href="#customize" id="customize">Customize Templates</a></h2> | ||||||
| <p>You can customize email templates in the Appwrite console.</p> | ||||||
|
Member
There was a problem hiding this comment.
Suggested change
|
||||||
| <div class="notice"> | ||||||
| <h2>Custom SMTP Server Required</h2> | ||||||
| <p>The built-in email service does not support custom email templates. Configure a <a href="#smtp">custom SMTP server</a> to enable custom email templates.</p> | ||||||
|
gewenyu99 marked this conversation as resolved.
Outdated
|
||||||
| </div> | ||||||
| <ol class="margin-top margin-bottom-large text-size-normal"> | ||||||
| <li>In your project, navigate to the <b>Auth</b> service.</li> | ||||||
| <li>Under the <b>Auth</b> service, navigate to the <b>Templates</b> tab.</li> | ||||||
| <li>Expand the email template you want to edit.</li> | ||||||
| <li>Select the <b>Template language</b>. You can have a different template for each language your app supports.</li> | ||||||
| <li>Update the email template fields and click **Update** to save your changes.</li> | ||||||
| </ol> | ||||||
| <h2><a href="#email-templates" id="email-templates">Email Templates</a></h2> | ||||||
| <p>You can customize the email emplates for account verification, magic-url authentication, password resets, and user invites.</p> | ||||||
| <h3><a href="#email-template-components" id="email-template-components">Email Template Components</a></h3> | ||||||
| <p>Each email templates has the following components that you can customize.</p> | ||||||
| <h2 id="permission-types"><a href="/docs/permissions#permission-types">Permission Types</a></h2> | ||||||
| <p>In Client and Server SDKs, you will find a <b>Permission</b> class with helper methods for each role described below.</p> | ||||||
| <table class="full text-size-small"> | ||||||
| <thead> | ||||||
| <tr> | ||||||
| <td style="width: 200px">Component</td> | ||||||
| <td>Description</td> | ||||||
| </tr> | ||||||
| </thead> | ||||||
| <tbody> | ||||||
| <tr> | ||||||
| <td>Sender name</td> | ||||||
| <td>Readers will see this as display name of the sender.</td> | ||||||
|
gewenyu99 marked this conversation as resolved.
Outdated
|
||||||
| </tr> | ||||||
| <tr> | ||||||
| <td>Sender email</td> | ||||||
| <td>Readers will see this as the displayed email of the sender. This must be a valid email for the SMTP provider your configured.</td> | ||||||
| </tr> | ||||||
| <tr> | ||||||
| <td>Reply to</td> | ||||||
| <td>Readers will reply to this email adress instead of the sender address. You can leave this field empty if unused.</td> | ||||||
| </tr> | ||||||
| <tr> | ||||||
| <td>Subject</td> | ||||||
| <td>The title of the email.</td> | ||||||
| </tr> | ||||||
| <tr> | ||||||
| <td>Message</td> | ||||||
| <td>The body of the email. You can find the variables available in the <a href="#email-template-syntax">Email Template Syntax</a> section.</td> | ||||||
|
gewenyu99 marked this conversation as resolved.
Outdated
|
||||||
| </tr> | ||||||
| </tbody> | ||||||
| </table> | ||||||
| <h3><a href="#email-template-syntax" id="email-template-syntax">Email Template Syntax</a></h3> | ||||||
| <p>Variables can be used in email templates to dynamically format unique emails for each reader. These variables can only be accessed in the <b>Message</b> field of the email template.</p> | ||||||
|
gewenyu99 marked this conversation as resolved.
Outdated
|
||||||
|
|
||||||
| <table class="full text-size-small"> | ||||||
| <thead> | ||||||
| <tr> | ||||||
| <td style="width: 200px">Component</td> | ||||||
| <td>Description</td> | ||||||
| </tr> | ||||||
| </thead> | ||||||
| <tbody> | ||||||
| <tr> | ||||||
| <td><code>{{project}}</code></td> | ||||||
| <td>The project name.</td> | ||||||
| </tr> | ||||||
| <tr> | ||||||
| <td><code>{{team}}</code></td> | ||||||
| <td>Thee project team's name.</td> | ||||||
| </tr> | ||||||
| <tr> | ||||||
| <td><code>{{user}}</code></td> | ||||||
| <td>The name of the uer receiving the email.</td> | ||||||
| </tr> | ||||||
| </tbody> | ||||||
| </table> | ||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The page is mostly focused on emails, while we also support SMS templates and maybe other in the future, we need to make the docs more balanced. I would also mention you can customize them per project and for multiple languages at the top of the page linking to more information on how to manage localization in Appwrite.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I might even add a table of content for quick links to emails vs sms.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Localization might be worth its own section with a code example.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
😆 Some of these sections are new, for a while I thought SMS delivery wasn't going to be added yet.