Syntaxe Liquid prise en charge pour les modèles de courriel

Liste des balises, filtres et variables Liquid courants pris en charge dans les modèles de courriel.

Pour avoir un aperçu de la syntaxe Liquid, consultez l’introduction à LiquidJS. Elle présente brièvement les deux types de balisage de Liquid :

• Sorties, qui génèrent du HTML.

  La syntaxe des sorties consiste en une variable ou une valeur, ainsi qu’une liste facultative de filtres, le tout entouré de {{ et }}. Par exemple, {{ user.name }}.

• Balises, qui contrôlent le rendu du modèle et implémentent la logique.

  La syntaxe des balises consiste en un nom de balise et des arguments facultatifs entourés de {% et %}. Par exemple, {% if user_metadata.lang == 'it' %} Ciao! {% endif %}.

Cette page répertorie les balises, les filtres et les variables pris en charge dans les modèles de courriel.

​

Balises

Tous les modèles de courriel prennent en charge les balises Liquid suivantes :

Catégorie	Balises
Itération	for, cycle, tablerow
Flux de contrôle	if, unless, elsif, else, case
Variable	assign, increment, decrement
Fichier	include, layout
Langage	raw, comment

Vous pouvez consulter la description et des exemples des balises Liquid sur la page des balises de LiquidJS.

​

balise debug

Pour faciliter le débogage et le développement, notre balise personnalisée {% debug %} affiche un résumé des variables de modèle disponibles dans votre modèle au moment du rendu.

​

Filtres

Tous les modèles de courriel prennent en charge les filtres Liquid suivants :

Catégorie	Filtres
Mathématiques	plus, minus, modulo, times, floor, ceil, round, divided_by, abs, at_least, at_most
Chaînes	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
Tableaux	slice, map, sort, sort_natural, first, last, join, reverse, size
Date	date
Divers	default

Vous pouvez consulter des descriptions et des exemples de filtres Liquid sur la page des filtres de LiquidJS.

​

Variables générales

Les variables suivantes sont disponibles dans les champs Adresse de l’expéditeur, Objet et Message de chaque modèle (sauf indication contraire).

Pour utiliser des propriétés non fiables dans les modèles de courriel, échappez-les à l’aide du filtre escape (par exemple, {{ user.name | escape }}).

• L’objet application, avec accès aux propriétés client standard comme application.name et application.client_metadata

• request_language, la langue sélectionnée pour les utilisateurs

• connection.name

• Dans le modèle de courriel d’inscription à la MFA, la variable connection.name n’est pas disponible.

• Informations liées au locataire définies dans les Paramètres du locataire :

  • tenant, qui correspond au nom du locataire tel quel
  • friendly_name
  • support_email
  • support_url

• Les variables user suivantes :

  • user.email
  • user.email_verified
  • user.picture (non fiable)
  • user.nickname (non fiable)
  • user.given_name (non fiable)
  • user.family_name (non fiable)
  • user.name (non fiable)
  • user.app_metadata, attributs utilisateur qui peuvent avoir une incidence sur les fonctionnalités de base d’un utilisateur, par exemple le fonctionnement d’une application ou ce à quoi l’utilisateur peut accéder, y compris son plan de soutien, ses rôles de sécurité et ses groupes de contrôle d’accès
  • user.user_metadata (non fiable s’il contient des renseignements fournis par l’utilisateur), attributs utilisateur qui n’ont pas d’incidence sur les fonctionnalités de base d’un utilisateur, y compris ses préférences

Dans le modèle de courriel Passwordless OTP, seule la propriété email de l’objet user est disponible.

• Lorsqu’un utilisateur se connecte par l’intermédiaire d’une organisation, les variables supplémentaires suivantes sont disponibles :

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

• Plusieurs variables de domaines personnalisés :

  • custom_domain.domain, le nom de domaine personnalisé utilisé (p. ex., login.example.com)
  • custom_domain.domain_metadata, les champs de métadonnées du domaine personnalisé (paires clé-valeur) que vous pouvez utiliser pour personnaliser le contenu du courriel en fonction du domaine

Lorsque vous utilisez plusieurs domaines personnalisés, Auth0 utilise automatiquement le domaine personnalisé approprié pour les liens dans les courriels. Vous pouvez utiliser ces variables pour personnaliser le contenu du courriel en fonction du domaine personnalisé qui a déclenché l’envoi du courriel.

Exemple : personnaliser l’image de marque du courriel en fonction des métadonnées du domaine personnalisé :

{% 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 %}

Exemple : Incluez des renseignements d’assistance propres au domaine :

{% if custom_domain.domain_metadata.support_email %}
  <p>Besoin d'aide ? Contactez-nous à {{ custom_domain.domain_metadata.support_email }}</p>
{% else %}
  <p>Besoin d'aide ? Contactez-nous à {{ support_email }}</p>
{% endif %}

Pour utiliser des domaines personnalisés dans les courriels, assurez-vous d’avoir :

1. configuré et vérifié vos domaines personnalisés
2. activé Utiliser le domaine personnalisé dans les courriels dans Tableau de bord > Image de marque > Domaines personnalisés
3. défini un domaine personnalisé par défaut si vous utilisez plusieurs domaines personnalisés

​

Variables Redirect To

Dans les modèles de courriel comportant un champ d’URL Redirect To, seules les trois variables suivantes sont prises en charge :

• application.name (ou son synonyme client.name)

• application.clientID

• application.callback_domain (ou son synonyme client.callback_domain), qui contient l’origine de la première URL de la liste Allowed Callback URL de l’application. Comme il s’agit d’une origine, elle comprend aussi le protocole (par exemple https://), en plus du domaine.

  Le domaine de rappel vous permet de rediriger les utilisateurs vers un chemin de l’application à l’origine de l’action au moyen d’une syntaxe comme {{ application.callback_domain }}/result_page.

​

Variables spécifiques au modèle

En plus des variables Liquid communes accessibles dans tous les modèles de courriel, les modèles de courriel suivants comportent des variables supplémentaires.

​

Variables du modèle de courriel pour compte bloqué

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

​

Variables du modèle de courriel pour le changement de mot de passe (code)

• code, le code de changement de mot de passe

​

Variables du modèle de courriel de réinitialisation du mot de passe (lien)

• url, le lien de réinitialisation du mot de passe

​

Variables du modèle de courriel pour l’inscription à la MFA

• link, le lien d’inscription à la MFA.

​

Variables du modèle de courriel Passwordless OTP

• send, avec une valeur de link, link_ios, link_android ou code, selon le type de courriel Passwordless demandé
• code, avec le code à usage unique permettant d’accéder à l’application
• link, avec le lien sur lequel l’utilisateur peut cliquer pour accéder à l’application (uniquement pour les courriels Passwordless de type lien)
• operation, avec une valeur de change_email pour une opération de modification de courriel Passwordless

​

Variables du modèle de courriel d’invitation de l’utilisateur

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

​

Variables du modèle de courriel de vérification (code)

• code, le code de vérification

​

Variables du modèle de courriel de vérification (lien)

• url, le lien de vérification