Skip to Content
Admin ConsoleEmail Templates

Email Templates

Auris sends transactional emails for key authentication events such as email verification, password resets, magic link logins, and tenant invitations. The Console provides a built-in template editor that lets you customize the content, layout, and branding of every email type without writing code or managing external email services.

All templates use HTML with a variable substitution system. You edit the HTML directly, preview the rendered result in real time, and send test emails to verify delivery and appearance before saving.

Access the template editor via Console -> Settings -> Email Templates.

Template Types

Auris includes six transactional email templates, each triggered by a specific authentication event:

Template TypeTriggerDescription
verificationUser signs upEmail verification link sent after account creation to confirm the email address
password_resetUser requests password resetContains a time-limited link to set a new password
magic_linkUser requests magic link loginOne-time login link sent to the user’s email address
invitationAdmin invites a userInvitation to join a tenant or organization, with an accept link
welcomeUser completes first loginWelcome message sent after the user’s first successful authentication
mfa_notificationMFA enrollment or method changeNotification when a user enrolls in MFA, changes their MFA method, or disables MFA

Each template can be edited independently. Changes apply to all applications within the tenant.

If you have not customized a template, Auris uses a default template with the Auris branding. Customizing any template replaces the default entirely for that template type.

Using the Template Editor

Select a template type

Open Settings -> Email Templates and click on the template you want to customize. The six template types are displayed as cards showing the template name, trigger event, and last-modified timestamp.

Edit the HTML template

The editor opens a code panel with syntax highlighting for HTML. Write or paste your HTML email template. The editor supports standard HTML and inline CSS, which is recommended for maximum email client compatibility.

<div style="font-family: Arial, sans-serif; max-width: 600px; margin: 0 auto;">
  <div style="background-color: {{brandColor}}; padding: 24px; text-align: center;">
    <img src="{{logoUrl}}" alt="{{companyName}}" style="height: 40px;" />
  </div>
  <div style="padding: 32px;">
    <h1>Verify your email</h1>
    <p>Hi {{userName}},</p>
    <p>Click the button below to verify your email address.</p>
    <a href="{{actionUrl}}" style="display: inline-block; padding: 12px 24px;
       background-color: {{brandColor}}; color: #ffffff; text-decoration: none;
       border-radius: 6px;">Verify Email</a>
  </div>
</div>

Insert template variables

Use double curly braces to insert dynamic values. The editor provides an Insert Variable dropdown that lists all available variables for the selected template type. Click a variable to insert it at the cursor position.

Preview the rendered email

Click Preview to see the rendered HTML with sample data populated into all template variables. The preview panel appears side-by-side with the editor and updates as you type. Use the device toggle to preview desktop and mobile layouts.

Send a test email

Click Send Test and enter a recipient email address. Auris renders the template with sample data and sends it through the configured SMTP server. Use this to verify that the email renders correctly in real email clients and that delivery works end-to-end.

Save the template

Click Save to persist your changes. The template takes effect immediately for all future emails of that type.

Email clients have inconsistent HTML and CSS support. Use inline CSS, table-based layouts for complex structures, and test across multiple clients (Gmail, Outlook, Apple Mail) before saving production templates.

Template Variables

Common Variables

These variables are available in all template types:

VariableDescriptionExample Value
{{userName}}The user’s display name (first name, or full name if available)Marco
{{userEmail}}The user’s email address[email protected]
{{tenantName}}The name of the Auris tenantAcme Corp
{{companyName}}The company name configured in branding settingsAcme Corporation
{{logoUrl}}The logo URL configured in branding settingshttps://cdn.example.com/logo.png
{{brandColor}}The primary brand color configured in branding settings#4f46e5
{{currentYear}}The current year for copyright notices2026

Per-Template Variables

Additional variables are available depending on the template type:

TemplateVariableDescription
verification{{actionUrl}}The email verification link
verification{{expiresIn}}Human-readable expiry duration (for example, “24 hours”)
password_reset{{actionUrl}}The password reset link
password_reset{{expiresIn}}Human-readable expiry duration (for example, “1 hour”)
password_reset{{ipAddress}}The IP address that requested the reset
magic_link{{actionUrl}}The magic link login URL
magic_link{{expiresIn}}Human-readable expiry duration (for example, “15 minutes”)
invitation{{actionUrl}}The invitation accept link
invitation{{inviterName}}The name of the admin who sent the invitation
invitation{{roleName}}The role the user will be assigned upon accepting
invitation{{expiresIn}}Human-readable expiry duration (for example, “7 days”)
welcome{{loginUrl}}The login page URL for the tenant
mfa_notification{{mfaMethod}}The MFA method affected (for example, “TOTP”, “SMS”, “WebAuthn”)
mfa_notification{{mfaAction}}The action that occurred (for example, “enrolled”, “changed”, “disabled”)
mfa_notification{{ipAddress}}The IP address where the MFA change was made

If a variable is not available for a given template type or the value is empty, it renders as an empty string. The preview panel highlights any unrecognized variables in red so you can catch typos before saving.

SMTP Configuration

Auris requires an SMTP server to send transactional emails. Configure SMTP settings at Console -> Settings -> SMTP.

FieldRequiredDescription
SMTP HostYesThe hostname of your SMTP server (for example, smtp.mailgun.org)
SMTP PortYesThe port number (common values: 587 for STARTTLS, 465 for TLS, 25 for unencrypted)
UsernameYesSMTP authentication username
PasswordYesSMTP authentication password
From AddressYesThe sender email address (for example, [email protected])
From NameYesThe sender display name (for example, Acme Auth)
EncryptionYesTLS (implicit, port 465) or STARTTLS (explicit, port 587)

Enter SMTP credentials

Fill in all required fields with your SMTP provider’s credentials.

Send a test email

Click Send Test Email to verify the connection. Auris sends a simple test message to the address you specify.

Save

Click Save to persist the SMTP configuration. All transactional emails will use this SMTP server.

If SMTP is not configured or the credentials are invalid, Auris cannot send any transactional emails. Authentication flows that require email delivery (verification, password reset, magic links, invitations) will fail. Always verify SMTP connectivity before going to production.

Customization Tips

  • Brand colors: Use the {{brandColor}} variable to pull colors from your branding settings automatically. This keeps emails consistent with your Console branding configuration.
  • Logo: Upload your logo in Settings -> Branding and reference it with {{logoUrl}} in templates.
  • Footer text: Include your company address and unsubscribe language in the template footer to comply with anti-spam regulations.
  • Responsive design: Use a single-column layout with max-width: 600px for best results across desktop and mobile email clients.
  • Plain text fallback: Auris automatically generates a plain-text version from your HTML template. No separate plain-text template is needed.

API Reference

Email templates can also be managed programmatically via the REST API.

GET/api/email-templates
PUT/api/email-templates/:type
POST/api/email-templates/preview
POST/api/email-templates/test

Permissions

PermissionDescription
manage:email_templatesRequired to view, edit, preview, and test email templates. Also required for SMTP configuration changes.
LicensingSession Management