Email templates Admin

How templates work

Each email template has a slug that identifies it in the code. One version is stored per language (English, Russian and Armenian). Some templates are created at start-up; others are created on first use. If a version does not exist for the client's language, the email is sent in English.

Creating a version for a slug and language that already exists returns EMAIL_TEMPLATE_ALREADY_EXISTS. A template that does not exist returns EMAIL_TEMPLATE_NOT_FOUND.

✓

Templates you have edited are never overwritten on upgrade. Your changes are safe.

The Email Templates screen

Go to Settings → Email Templates. Subtitle: "Email Templates."

Columns: Name, Subject, Languages, Edit.

Edit a template

1. Find the template row and click Edit.

2. Select the language tab you want to edit. A tab marked as missing has no stored version; saving it creates one.

3. Edit the Subject, Description and Body (HTML).

4. Click Save.

Placeholders

Placeholders use the Liquid template language. A variable is written as {{ name }} or {{ object.field }}, with names in lowercase and underscores. Every template has access to the brand and site variables:

{{ brand.primary }}       — primary brand colour
{{ brand.primary_dark }}  — dark variant of the primary colour
{{ brand.on_primary }}    — text colour on the primary background
{{ brand.accent }}        — accent colour
{{ brand.logo_url }}      — URL of the brand logo
{{ site.name }}           — the name of the site

Example using a condition and a loop:

{% if invoice.total > 0 %}
  <p>Invoice #{{ invoice.id }} for {{ invoice.total }} {{ invoice.currency }}</p>
{% endif %}

{% for item in items %}
  <li>{{ item.name }}</li>
{% endfor %}

Templates and their placeholders

Account

Name	Type	Default	Description
welcome	string	—	Sent to a new client after account creation. Placeholders: client.email
user-invite	string	—	Sent when a user is invited to a client account. Placeholders: invite_link, client_name, first_name
user-email-verification	string	—	Local accounts only. Sent to verify a new email address. Placeholders: verification_link
user-password-reset	string	—	Local accounts only. Sent when a password reset is requested. Placeholders: reset_link
user-email-change	string	—	Local accounts only. Sent to confirm an email address change. Placeholders: confirmation_link
user-email-changed-notice	string	—	Local accounts only. Sent to the old address after an email address is changed. Placeholders: new_email

Billing

Name	Type	Default	Description
invoice-created	string	—	Sent to the client when an invoice is created. Placeholders: invoice.id, invoice.total, invoice.currency
payment-received	string	—	Sent to the client when a payment is recorded. Placeholders: invoice.id, invoice.total, invoice.transaction_id
invoice-renewal-reminder	string	—	Sent when a renewal reminder is due. Placeholders: invoice.id, invoice.total, invoice.currency, invoice.due_date, invoice.url
gateway-payment-stalled-admin	string	—	Sent to staff when a gateway payment has been pending too long. Placeholders: invoice.id, client.id, module, pending_hours
gateway-payment-credited-admin	string	—	Sent to staff when a gateway payment took money the invoice could not record and the amount was added to the client credit balance or held for manual resolution. Placeholders: invoice.id, client.id, module, reference, amount, currency, credited
gateway-payment-without-reference-admin	string	—	Sent to staff when a gateway reports a payment as paid but sends no payment reference. Nothing is recorded; the operator must find and record it by hand. Placeholders: invoice.id, client.id, module, amount, currency

Services

Name	Type	Default	Description
service-provisioned	string	—	Sent to the client when a service is provisioned. Placeholders: service.id, service.provisioning_ref, service.domain, service.username
service-termination-failed-admin	string	—	Sent to staff when service termination fails. Placeholders: service.id, reason

Support tickets

Name	Type	Default	Description
ticket-created	string	—	Sent to the department when a ticket is opened. Placeholders: ticket.id, ticket.subject
ticket-replied	string	—	Sent to the client (staff reply) or department (client reply). Placeholders: ticket.id, ticket.subject
ticket-closed	string	—	Sent to the client when a ticket is closed. Placeholders: ticket.id, ticket.subject

Domains

Name	Type	Default	Description
domain-registered	string	—	Sent to the client when a domain is registered. Placeholders: domain.id, domain.name, domain.registrar, domain.expires_at
domain-transferred	string	—	Sent to the client when a domain transfer completes. Placeholders: domain.id, domain.name, domain.registrar, domain.expires_at
domain-renewed	string	—	Sent to the client when a domain is renewed. Placeholders: domain.id, domain.name, domain.new_expires_at
domain-expiring	string	—	Sent as a domain approaches its expiry date. Placeholders: domain.id, domain.name, domain.expires_at, domain.days_until_expiry
domain-expired	string	—	Sent when a domain passes its expiry date. Placeholders: domain.id, domain.name, domain.linked_service_id
domain-registration-failed	string	—	Sent to the client when domain registration fails. Placeholders: domain.name, invoice.id
domain-registration-failed-admin	string	—	Sent to staff when domain registration fails. Placeholders: domain.name, client.id, invoice.id, reason
domain-renewal-failed-admin	string	—	Sent to staff when domain renewal fails. Placeholders: domain.name, client.id, invoice.id, reason

Mail delivery

Templates are sent through the SMTP settings configured in the Configuration reference.

Clients can see the emails sent to them in the Emails section of the client portal.