> For the complete documentation index, see [llms.txt](https://hub.equipme.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://hub.equipme.io/equipme/settings-1/email-notifications/mail-template-variables.md).

# Mail template variables

### What are variables?

When you create emails in equipme, you can use variables to automatically insert dynamic information.

Instead of writing everything manually, variables act as placeholders. When the email is sent, they are replaced with real data such as names, services, prices or links.

This allows you to keep your templates flexible while still showing the right information in every situation.

### Working with lists

When a variable contains multiple entries, it behaves as a list.

To display all entries, you need to loop through the list:

```
{{#each Items}}
- {{ServiceName}}
{{/each}}
```

This will output each item with its corresponding values.

***

### Using conditions

In some cases, a variable might not always contain a value.\
To avoid errors during rendering, you should use a condition.

```
{{#if Options}}
{{Options}}
{{/if}}
```

`Options` represents additional information attached to a service, such as selected configurations or add-ons.\
These values are optional and may not always be present.

This condition ensures that the value is only used when it exists.

{% hint style="info" %}
⚠️ **Important**\
If a variable like `Options` is used without a condition and no data is available, the email rendering will fail and the email will not be sent.\
The content will not simply be left empty.
{% endhint %}

***

### Example

To display cancelled services:

```
{{#each CancelledItems}}
- {{ServiceName}}
{{/each}}
```

If you also want to display additional information only when it exists, you can combine both:

```
{{#each CancelledItems}}
- {{ServiceName}}
{{#if Options}} {{Options}} {{/if}}
{{/each}}
```

This allows you to keep your templates clean while still handling optional data correctly.

***

#### Good to know

* Variables only show values if data exists
* Empty variables will not be rendered
* List variables require a loop

***

### General variables

Variables that are available across multiple email templates.

#### Variables

| Description               | Variable                 |
| ------------------------- | ------------------------ |
| Full name                 | `FullName`               |
| Language                  | `ln`                     |
| Email subject             | `Subject`                |
| Supplier name             | `supplierName`           |
| Primary color             | `primaryColor`           |
| Header image              | `headerImage`            |
| Header image width        | `headerImageWidth`       |
| Header image height       | `headerImageHeight`      |
| Logo (default)            | `NormalLogoLink`         |
| Logo width (default)      | `NormalLogoWidth`        |
| Logo height (default)     | `NormalLogoHeight`       |
| Logo (contrast)           | `ContrastLogoLink`       |
| Logo width (contrast)     | `ContrastLogoWidth`      |
| Logo height (contrast)    | `ContrastLogoHeight`     |
| Imprint link              | `imprintLink`            |
| Privacy policy link       | `privacyPolicyLink`      |
| Terms and conditions link | `termsAndConditionsLink` |

***

### Address variables

#### Variables

| Description  | Variable         |
| ------------ | ---------------- |
| Address name | `addressName`    |
| Street       | `addressStreet`  |
| Postal code  | `addressCode`    |
| City         | `addressCity`    |
| Country      | `addressCountry` |

***

## Order Authorization Reminder Mail

Reminder for pending approvals.

### Variables

| Description        | Variable               |
| ------------------ | ---------------------- |
| Full name          | `FullName`             |
| Customer name      | `CustomerName`         |
| Number of services | `OrderedServicesCount` |
| One time total     | `OneTimePrice`         |
| Recurring total    | `RecurringPrice`       |
| Link               | `Link`                 |

***

## Fulfillment Status Changed Mail

Sent when fulfillment status changes.

### Variables

| Description        | Variable                  |
| ------------------ | ------------------------- |
| Full name          | `FullName`                |
| Customer name      | `customerName`            |
| Employee           | `customerEmployee`        |
| New status         | `newStatus`               |
| Link               | `link`                    |
| Number of services | `orderedServicesCount`    |
| Items list         | `Items[]`                 |
| Instance ID        | `Items[].InstanceId`      |
| Order ID           | `Items[].OrderId`         |
| Product name       | `Items[].ProductName`     |
| Options            | `Items[].OptionsString`   |
| Quantity           | `Items[].Quantity`        |
| Employee           | `Items[].EmployeeName`    |
| Employees string   | `Items[].EmployeesString` |
| Category           | `Items[].NodeName`        |
| Recurring price    | `Items[].RecurringPrice`  |
| One time price     | `Items[].OneTimePrice`    |
| Image              | `Items[].ImageUrl`        |
| Order reference    | `Items[].OrderReference`  |
| Order date         | `Items[].OrderDate`       |

***

## Order Cancelled Mail

Sent when an order is cancelled.

### Variables

| Description   | Variable              |
| ------------- | --------------------- |
| Full name     | `FullName`            |
| Customer name | `customerName`        |
| Link          | `link`                |
| Items         | `Items[]`             |
| Service name  | `Items[].ServiceName` |
| Quantity      | `Items[].Quantity`    |

***

## Cart Items Pending Mail

Sent when items remain in the cart.

### Variables

| Description     | Variable                 |
| --------------- | ------------------------ |
| Full name       | `FullName`               |
| Customer name   | `customerName`           |
| Link            | `link`                   |
| Items           | `items`                  |
| Service name    | `items[].ServiceName`    |
| Quantity        | `items[].Count`          |
| Location        | `items[].Location`       |
| Recurring total | `items[].TotalRecurring` |
| One time total  | `items[].TotalOnce`      |

***

## New Ticket Mail

Sent when a ticket is created.

### Variables

| Description     | Variable         |
| --------------- | ---------------- |
| Full name       | `FullName`       |
| Link            | `Link`           |
| Initiator email | `InitiatorEmail` |
| Initiator name  | `InitiatorName`  |
| Service name    | `ServiceName`    |
| Service item    | `ServiceItem`    |
| Title           | `Headline`       |
| Description     | `Description`    |
| Priority        | `Priority`       |
| Reference       | `Reference`      |

***

## Ticket Updated Mail

Sent when a ticket is updated.

### Variables

| Description | Variable    |
| ----------- | ----------- |
| Full name   | `FullName`  |
| Link        | `Link`      |
| Updated by  | `UpdatedBy` |
| Comment     | `Comment`   |
| Status      | `Status`    |

***

## Ticket Closed Mail

Sent when a ticket is closed.

### Variables

| Description | Variable     |
| ----------- | ------------ |
| Full name   | `FullName`   |
| Link        | `Link`       |
| Resolution  | `Resolution` |

***

## Invitation Mail

Sent when a user is invited.

### Variables

| Description     | Variable      |
| --------------- | ------------- |
| Full name       | `FullName`    |
| Invitation link | `Link`        |
| Company name    | `CompanyName` |
| Role            | `Role`        |

***

## Password Reset Mail

Sent when a password reset is requested.

### Variables

| Description | Variable   |
| ----------- | ---------- |
| Full name   | `FullName` |
| Reset link  | `Link`     |

***

## Employee Status Change Mail

Sent when employee status changes.

### Variables

| Description      | Variable                 |
| ---------------- | ------------------------ |
| Full name        | `FullName`               |
| Employee name    | `EmployeeName`           |
| Department       | `EmployeeDepartment`     |
| Groups           | `EmployeeGroups`         |
| Manager          | `EmployeeManagers`       |
| Location         | `EmployeeLocation`       |
| Supervisor       | `EmployeeSupervisor`     |
| Status           | `EmployeeStatus`         |
| Previous status  | `EmployeePreviousStatus` |
| Offboarding date | `OffboardingDate`        |

***

## Expiration Reminder Customer Mail

Sent to customers about expiring services.

### Variables

| Description           | Variable                          |
| --------------------- | --------------------------------- |
| Full name             | `FullName`                        |
| Customer name         | `CustomerName`                    |
| Days until expiration | `ThresholdInDays`                 |
| Expiration date       | `ExpirationDateString`            |
| Is affected user      | `ReceiverIsAffectedUser`          |
| Cancelled items       | `CancelledItems`                  |
| Service               | `CancelledItems[].Service`        |
| Total                 | `CancelledItems[].Total`          |
| Users                 | `CancelledItems[].Users`          |
| Link                  | `CancelledItems[].DetailPageLink` |
| Expiring items        | `ExpiringItems`                   |
| Service               | `ExpiringItems[].Service`         |
| Total                 | `ExpiringItems[].Total`           |
| Users                 | `ExpiringItems[].Users`           |
| Link                  | `ExpiringItems[].DetailPageLink`  |

***

## Expiration Reminder Supplier Mail

Sent to suppliers.

### Variables

| Description     | Variable                         |
| --------------- | -------------------------------- |
| Full name       | `FullName`                       |
| Customer groups | `CustomerItems`                  |
| Customer name   | `CustomerItems[].CustomerName`   |
| Cancelled items | `CustomerItems[].CancelledItems` |
| Expiring items  | `CustomerItems[].ExpiringItems`  |

***

## Invoice Mail

Sent when an invoice is generated.

### Variables

| Description    | Variable        |
| -------------- | --------------- |
| Full name      | `FullName`      |
| Customer name  | `CustomerName`  |
| Invoice number | `InvoiceNumber` |
| Invoice date   | `InvoiceDate`   |
| Total amount   | `TotalAmount`   |
| Link           | `Link`          |

***


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://hub.equipme.io/equipme/settings-1/email-notifications/mail-template-variables.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.