Sintaxis de Liquid admitida para plantillas de correo electrónico

Una lista de etiquetas, filtros y variables comunes de Liquid admitidos en las plantillas de correo electrónico.

Para obtener una visión general de la sintaxis de Liquid, lee la introducción a LiquidJS. Incluye un breve resumen de los dos tipos de marcado de Liquid:

• Salidas, que generan HTML.

  La sintaxis de las salidas consiste en una variable o un valor y una lista opcional de filtros entre {{ y }}. Por ejemplo, {{ user.name }}.

• Etiquetas, que controlan el renderizado de la plantilla e implementan lógica.

  La sintaxis de las etiquetas consiste en un nombre de etiqueta y argumentos opcionales entre {% y %}. Por ejemplo, {% if user_metadata.lang == 'it' %} Ciao! {% endif %}.

Esta página enumera las etiquetas, los filtros y las variables admitidos en las plantillas de correo electrónico.

​

Etiquetas

Todas las plantillas de correo electrónico admiten las siguientes etiquetas de Liquid:

Categoría	Etiquetas
Iteración	for, cycle, tablerow
Flujo de control	if, unless, elsif, else, case
Variable	assign, increment, decrement
Archivo	include, layout
Lenguaje	raw, comment

Puede consultar descripciones y ejemplos de las etiquetas de Liquid en la página de etiquetas de LiquidJS.

​

etiqueta debug

Para facilitar la depuración y el desarrollo, nuestra etiqueta personalizada {% debug %} genera un resumen de las variables de plantilla disponibles en su plantilla en el momento de la renderización.

​

Filtros

Todas las plantillas de correo electrónico admiten los siguientes filtros de Liquid:

Categoría	Filtros
Matemáticos	plus, minus, modulo, times, floor, ceil, round, divided_by, abs, at_least, at_most
Cadena	append, prepend, capitalize, upcase, downcase, strip, lstrip, rstrip, strip_newlines, split, replace, replace_first, remove, remove_first, truncate, truncatewords
HTML/URI	escape, escape_once, url_encode, url_decode, strip_html, newline_to_br
Array	slice, map, sort, sort_natural, first, last, join, reverse, size
Fecha	date
Varios	default

Puede consultar descripciones y ejemplos de filtros de Liquid en la página de filtros de LiquidJS.

​

Variables generales

Las siguientes variables están disponibles en los campos Dirección del remitente, Asunto y Mensaje de todas las plantillas (a menos que se indique lo contrario).

Para usar propiedades no confiables en las plantillas de correo electrónico, escápalas con el filtro escape (por ejemplo, {{ user.name | escape }}).

• El objeto application, con acceso a las propiedades estándar del cliente, como application.name y application.client_metadata

• La selección de idioma request_language para los usuarios

• connection.name

• En la plantilla de correo electrónico de inscripción en MFA, la variable connection.name no está disponible.

• Información relacionada con el Tenant definida en Configuración del Tenant:

  • tenant, que es el nombre sin procesar del inquilino
  • friendly_name
  • support_email
  • support_url

• Las siguientes variables de user:

  • user.email
  • user.email_verified
  • user.picture (no confiable)
  • user.nickname (no confiable)
  • user.given_name (no confiable)
  • user.family_name (no confiable)
  • user.name (no confiable)
  • user.app_metadata, atributos del usuario que pueden afectar su funcionalidad principal, como el funcionamiento de una aplicación o a qué puede acceder el usuario, incluidos su plan de soporte, roles de seguridad y grupos de control de acceso
  • user.user_metadata (no confiable si contiene información proporcionada por el usuario), atributos del usuario que no afectan su funcionalidad principal, incluidas sus preferencias

En la plantilla de correo electrónico de OTP sin contraseña, solo está disponible la propiedad email del objeto user.

• Cuando un usuario inicia sesión a través de una Organización, están disponibles las siguientes variables adicionales:

  • organization.id
  • organization.display_name
  • organization.name
  • organization.metadata
  • organization.branding.logo_url
  • organization.branding.colors.primary
  • organization.branding.colors.page_background

• Varias variables de dominios personalizados:

  • custom_domain.domain, el nombre de dominio personalizado que se está usando (por ejemplo, login.example.com)
  • custom_domain.domain_metadata, los campos de metadatos del dominio personalizado (pares clave-valor) que puedes usar para personalizar el contenido del correo electrónico en función del dominio

Al usar varios dominios personalizados, Auth0 usa automáticamente el dominio personalizado adecuado para los enlaces de correo electrónico. Puedes usar estas variables para personalizar el contenido del correo electrónico según qué dominio personalizado haya desencadenado el correo.

Ejemplo: Personaliza la marca del correo electrónico según los metadatos del dominio personalizado:

{% if custom_domain.domain_metadata.brand == "BrandA" %}
  <h1 style="color: #0000FF;">Welcome to Brand A</h1>
{% elsif custom_domain.domain_metadata.brand == "BrandB" %}
  <h1 style="color: #FF0000;">Welcome to Brand B</h1>
{% else %}
  <h1>Welcome</h1>
{% endif %}

Ejemplo: Incluya información de soporte específica del dominio:

{% if custom_domain.domain_metadata.support_email %}
  <p>Need help? Contact us at {{ custom_domain.domain_metadata.support_email }}</p>
{% else %}
  <p>Need help? Contact us at {{ support_email }}</p>
{% endif %}

Para usar dominios personalizados en los correos electrónicos, asegúrate de haber:

1. Configurado y verificado tus dominios personalizados
2. Habilitado Usar dominio personalizado en los correos electrónicos en Dashboard > Marca > Dominios personalizados
3. Establecido un dominio personalizado predeterminado si usas varios dominios personalizados

​

Variables de Redirect To

En las plantillas de correo electrónico con un campo de URL Redirect To, solo se admiten estas tres variables:

• application.name (o su sinónimo client.name)

• application.clientID

• application.callback_domain (o su sinónimo client.callback_domain), que contiene el origen de la primera URL de la lista de URL de callback permitidas de la aplicación. Se trata de un origen y, por lo tanto, incluye el protocolo (como https://) además del dominio.

  El dominio de callback le permite redirigir a los usuarios a una ruta de la aplicación que desencadenó la acción mediante una sintaxis como {{ application.callback_domain }}/result_page.

​

Variables específicas de la plantilla

Además de las variables comunes de Liquid disponibles en todas las plantillas de correo electrónico, las siguientes plantillas de correo electrónico disponen de variables adicionales.

​

Variables de la plantilla de correo electrónico para cuenta bloqueada

• user.source_ip
• user.city
• user.country

​

Variables de la plantilla de correo electrónico para cambiar la contraseña (code)

• code, el code para cambiar la contraseña

​

Variables de la plantilla de correo electrónico para cambiar la contraseña (enlace)

• url, el enlace para restablecer la contraseña

​

Variables de la plantilla de correo electrónico para la inscripción en MFA

• link, el enlace para la inscripción en MFA.

​

Variables de la plantilla de correo electrónico de OTP sin contraseña

• send, con un valor de link, link_ios, link_android o code, según el tipo de correo electrónico sin contraseña que se solicite
• code, con el code de un solo uso para acceder a la aplicación
• link, con el enlace en el que el usuario puede hacer clic para acceder a la aplicación (solo para correos electrónicos sin contraseña de tipo enlace)
• operation, con un valor de change_email para una operación sin contraseña de cambio de correo electrónico

​

Variables de la plantilla de correo electrónico para invitación de usuarios

• inviter.name
• roles.id
• roles.name
• roles.description

​

Variables de la plantilla del correo electrónico de verificación (code)

• code, el code de verificación

​

Variables de la plantilla del correo electrónico de verificación (enlace)

• url, el enlace de verificación