.. _variables_email:

***********************************
Variables to use in email templates
***********************************

Use ``{{ variable_name }}`` to show variables in the email template.

By default all the public settings will be available to email template with prefix ``setting_``. Like if you have a
public setting with key ``site_title`` then ``setting_site_title`` will be available.

For user emails like forgot password or welcome emails, following variables will be there according to context:

+-------------------------------+-------------------------------------------------------+
| Code                          | Details                                               |
|                               |                                                       |
+===============================+=======================================================+
|``id``                         | User ID                                               |
+-------------------------------+-------------------------------------------------------+
|``name``                       | Name of the user                                      |
+-------------------------------+-------------------------------------------------------+
|``email``                      | User email                                            |
+-------------------------------+-------------------------------------------------------+
|``reset_code``                 | Password Reset Code                                   |
+-------------------------------+-------------------------------------------------------+
|``verification_code``          | Email verification code                               |
+-------------------------------+-------------------------------------------------------+

For emails related to sensor alerts like inactivity alert,  following variables will be there according to context:

+-------------------------------+-------------------------------------------------------+
| Code                          | Details                                               |
+===============================+=======================================================+
|``company_name``               | Sensor company name                                   |
+-------------------------------+-------------------------------------------------------+
|``sensor_name``                | Name of Sensor                                        |
+-------------------------------+-------------------------------------------------------+
|``sensor_type``                | Sensor Type                                           |
+-------------------------------+-------------------------------------------------------+
|``alert_name``                 | Alert Name                                            |
+-------------------------------+-------------------------------------------------------+
|``alert_text``                 | Alert Text                                            |
+-------------------------------+-------------------------------------------------------+
|``alert_id``                   | Sensor ID                                             |
+-------------------------------+-------------------------------------------------------+
|``sensor_status``              | Sensor Status                                         |
+-------------------------------+-------------------------------------------------------+
|``sensor_id``                  | Sensor ID                                             |
+-------------------------------+-------------------------------------------------------+
|``sensor_last_update``         | Sensor Last Update time UTC                           |
+-------------------------------+-------------------------------------------------------+
|``sensor_field``               | Field being compared. For emails of less then or      |
|                               | grater then alerts.                                   |
+-------------------------------+-------------------------------------------------------+
|``sensor_field_value``         | Field value. For emails of less then or grater then   |
|                               | alerts.                                               |
+-------------------------------+-------------------------------------------------------+