Message templates_

Appwrite uses emails to communicate with users to perform authentication and verification actions. Emails can be customized to fit your app's design and voice.

Each Appwrite project can have its own set of unique templates. Templates also support localization, so every template can be written in multiple languages and served depending on the configured locale.

Custom SMTP server

Appwrite Cloud has a default SMTP server to get you started. This SMTP server sends generic emails and doesn't allow customizing SMTP templates. To use custom SMTP templates, you will need to configure your own SMTP server.

Custom SMTP is available on Appwrite Cloud Pro and higher plans. You can connect a supported provider in one click, or enter the settings from any SMTP provider by hand.

One-click setup with Resend

On Appwrite Cloud, the SMTP tab starts with a One-click setup card. Connect a Resend account and Appwrite creates a sending-only API key for one of your verified domains, then fills in and enables the custom SMTP settings for you.

1. Navigate to your project's Settings.
2. Navigate to the SMTP tab.
3. Under One-click setup, click Connect with Resend.
4. Authorize Appwrite in Resend. You are returned to the same tab, and the Resend tile now shows Connected.
5. Select a verified Domain. Domains that are not yet verified in Resend are listed but can't be selected.
6. Enter a Sender name and a Sender email on the selected domain. Appwrite suggests noreply@<domain>.
7. Click Set up.

Appwrite creates an API key in your Resend account named Appwrite SMTP: <project name>. The key has sending-only permission and is restricted to the selected domain. Appwrite stores it as the SMTP password and writes the rest of the settings for you.

Custom SMTP is enabled as soon as the setup completes. Your existing reply-to email is kept. If you don't have a verified domain yet, add one in Resend's domains page and click Check again.

The connection lives on your Console account, not the project, so it shows as Connected in every project you open. Resend issues a short-lived access token that Appwrite stores on the linked identity of your Console account, and Appwrite asks you to Reconnect when it expires. To remove the connection, open the tile's menu and click Disconnect. Disconnecting removes the Resend identity from your Console account and doesn't change the SMTP settings already saved on your projects or revoke keys already in use.

Mailgun and SendGrid tiles appear as Coming soon. Click Notify me on either to be told when it ships.

Configure SMTP manually

There are many third-party SMTP providers like SendGrid and Mailgun. Before proceeding, pick an SMTP provider, create an account, and obtain Sender name, Sender email, Server host, Server port, Username, and Password.

1. Navigate to your project's Settings.
2. Navigate to the SMTP tab.
3. Under SMTP server, toggle Custom SMTP server.
4. Input Sender name, Sender email, Server host, Server port, Username, and Password from your provider.
5. Click Update.

Customize templates

You can customize email templates for each of your projects in the Appwrite Console.

1. In your project, navigate to the Auth service.
2. Under the Auth service, navigate to the Templates tab.
3. Expand the email template you want to edit.
4. Select the Template language. You can have a different template for each language your app supports.
5. Update the email template fields and click Update to save your changes.

Email templates

You can customize the email templates for account verification, magic-url authentication, password resets, and user invites.

Email template components

Each email template has the following components that you can customize.

Email template syntax

Variables can be used in email templates to dynamically construct unique emails for each reader. These variables can only be used in the Message field of the email template.

Email template examples

Here's an example of using these variables in a template.

<!doctype html>
<html>

<head>
    <!-- <style>
        ... your style here
    </style> -->
</head>

<body style="direction: ltr">

    <div style="max-width:650px; word-wrap: break-word; overflow-wrap: break-word;
  word-break: break-all; margin:0 auto;">
        <table style="margin-top: 32px">
            <tr>
                <td>
                    <h1>{{subject}}</h1>
                </td>
            </tr>
        </table>

        <table style="margin-top: 40px">
            <tr>
                <td>
                    <p>Hello </p>

                    <p>Follow this link to reset your {{project}} password.</p>

                    <a href="{{redirect}}" target="_blank" rel="noopener noreferrer">{{redirect}}</a>

                    <p><br />If you didn't ask to reset your password, you can ignore this message.</p>
                    <br />

                    <p>Thanks
                        <br />
                        {{project}} team</p>
                </td>
            </tr>
        </table>
    </div>

</body>

</html>

Localization

Each template can have multiple supported locales, displayed in different format and language. This can be configured under the Template language selector of each template.

You can send messages in different languages by setting the locale with client.setLocale() in the SDKs or the X-Appwrite-Locale HTTP header. View here the list of available locales.

For example, you can send an email verification in French.