Email templates

Appwrite sends transactional emails on your behalf for account management flows such as email verification, password recovery, and magic URL sign-in. Email templates let you customize the subject, message body, sender identity, and reply-to address of each of these emails, with a separate version for every locale you support.

Manage in the Console

To edit email templates from the Appwrite Console:

1. Navigate to your project.
2. Open the Auth section and select the Templates tab.
3. Under Email templates, expand the template you want to edit, such as Verification or Reset password.
4. Choose a Template language, then edit the sender name, sender email, reply-to address, subject, and message. Use the variable chips ({{user}}, {{project}}, {{redirect}}) to insert dynamic values into the subject and message.
5. Click Update to save the template for the selected language.

Manage with a Server SDK

You can also manage email templates programmatically using a Server SDK.

List email templates

You can paginate the result with the limit and offset queries. See Queries for the query syntax.

import { Client, Project } from 'node-appwrite';

const client = new Client()
    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
    .setProject('<YOUR_PROJECT_ID>') // Your project ID
    .setKey('<YOUR_API_KEY>'); // Your API key

const project = new Project(client);

const result = await project.listEmailTemplates({
    queries: [], // optional
    total: false // optional
});

Get an email template

Retrieve a single template by its type and, optionally, locale. If you omit the locale, the fallback locale en is returned.

import { Client, Project, ProjectEmailTemplateId, ProjectEmailTemplateLocale } from 'node-appwrite';

const client = new Client()
    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
    .setProject('<YOUR_PROJECT_ID>') // Your project ID
    .setKey('<YOUR_API_KEY>'); // Your API key

const project = new Project(client);

const result = await project.getEmailTemplate({
    templateId: ProjectEmailTemplateId.Verification,
    locale: ProjectEmailTemplateLocale.En // optional
});

Update an email template

Customize a template's subject, message, and sender identity for a given type and locale. Every field is optional, so you can change only the values you need. The subject and message accept the {{user}}, {{project}}, and {{redirect}} variables, which Appwrite replaces when sending the email.

import { Client, Project, ProjectEmailTemplateId, ProjectEmailTemplateLocale } from 'node-appwrite';

const client = new Client()
    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
    .setProject('<YOUR_PROJECT_ID>') // Your project ID
    .setKey('<YOUR_API_KEY>'); // Your API key

const project = new Project(client);

const result = await project.updateEmailTemplate({
    templateId: ProjectEmailTemplateId.Verification,
    locale: ProjectEmailTemplateLocale.En, // optional
    subject: '<SUBJECT>', // optional
    message: '<MESSAGE>', // optional
    senderName: '<SENDER_NAME>', // optional
    senderEmail: 'email@example.com', // optional
    replyToEmail: 'email@example.com', // optional
    replyToName: '<REPLY_TO_NAME>' // optional
});

Template types

Each email template is identified by a templateId. The available types map to the account management emails Appwrite sends:

Locales

Templates are stored per locale, so you can send the right copy to each audience. Pass the locale parameter to read or write the version for a specific language. If you omit it, Appwrite uses the fallback locale en. Locale codes follow the ISO 639-1 standard with optional region suffixes, such as en, fr, de, or pt-br.

Benefits

• On-brand emails. Replace the default sender name, address, subject, and message so account emails match your product instead of generic Appwrite copy.
• Localized messaging. Maintain a separate version of each template per locale and reach every user in their own language.
• Repeatable provisioning. Script template content as code and apply the same configuration across dev, staging, and production projects without clicking through the Console.