Extensibilité d'EmailSender

Implémentez un fournisseur d'e-mails basé sur des scripts en enregistrant `runtime.scriptable.emailEngine.SendEmail`.

Ce que c’est

Utilisez ce point d’extensibilité lorsque vous souhaitez que The Wallet Crew envoie des e-mails via un fournisseur que vous contrôlez. Il s’agit d’une intégration au niveau du script. Cela vous permet de conserver les modèles et la logique de rendu de Wallet Crew, tout en déléguant l’« envoi » final à vos propres appels API.

Cette conception sépare le rendu de la livraison. Cela rend votre couche e-mail plus facile à tester et à remplacer. Cela rend aussi la gestion des cultures explicite, car l’appelant décide quelles cultures existent et comment les modèles sont résolus.

Comment SendEmail ça fonctionne

La plateforme appelle runtime.scriptable.emailEngine.SendEmail lorsqu’elle doit envoyer un e-mail et que le fournisseur de messagerie est défini sur script. La fonction reçoit l’adresse du destinataire, le nom du modèle, une charge utile de données et la liste des cultures prises en charge.

Le dernier paramètre, buildEmail, est une fonction de rappel fournie par la plateforme. Votre fournisseur l’appelle pour obtenir le contenu final rendu. Cette fonction de rappel renvoie un objet avec un Objet et une Body. Une fois que vous disposez de cette charge utile, votre script est responsable de l’envoi.

Implémentation de référence (signature)

/**
 * @typedef {Object} EmailData
 * @property {string} Subject - Ligne d'objet rendue.
 * @property {string} Body - Contenu du corps rendu.
 */

/**
 * Envoyer un e-mail en utilisant le nom de modèle et les données fournis.
 * L'appelant fournit les cultures prises en charge et un rappel
 * pour construire le contenu de l'e-mail rendu.
 *
 * @param {string} recipient - Adresse e-mail cible.
 * @param {string} emailTemplate - Nom du modèle à générer.
 * @param {Object.<string, any>} data - Données du modèle transmises au script.
 * @param {string[]} cultures - Noms de culture disponibles provenant du fournisseur de cultures.
 * @param {(templateName: string) => Promise<EmailData>} buildEmail
 * Fonction de rappel qui renvoie le contenu final de l'e-mail rendu.
 *
 * @returns {Promise<void>}
 */
async function sendEmail(recipient, emailTemplate, data, cultures, buildEmail){
   // appeler n’importe quelle API pour envoyer l’e-mail
}

export default function(context) {
  context.register('runtime.scriptable.emailEngine', {
    SendEmail: sendEmail 
  })
}

Activer le fournisseur d’e-mails par script

Passer au fournisseur d’e-mails par script est un changement de configuration. Cela indique à The Wallet Crew d’appeler votre SendEmail implémentation pour les e-mails sortants.

1

Modifiez /server/emails.yml

Ouvrez l’éditeur de configuration avancée, puis créez ou modifiez /server/emails.yml. Définissez le type de fournisseur sur script. Conservez ressources pointant vers votre répertoire de modèles d’e-mails.

fournisseur :
  type : script
ressources :
  - /locales/emails/

Notes sur les modèles et les cultures

Les modèles d’e-mail sont chargés à partir des chemins listés sous ressources. Veillez à ce que cela corresponde à l’emplacement de vos modèles HTML, car la fonction de rappel de rendu utilise ces modèles.

La gestion des cultures fait partie du contrat. La plateforme transmet un cultures tableau, mais votre fournisseur décide comment l’utiliser. En pratique, la plupart des configurations choisissent soit une seule culture par destinataire, soit reviennent à une culture par défaut lorsqu’aucun modèle spécifique n’existe.

Dépannage

Si les e-mails cessent d’être envoyés après l’activation du fournisseur par script, commencez par vérifier que /server/emails.yml est un YAML valide et enregistré dans le bon tenant. Puis confirmez que votre script est bien enregistré sous runtime.scriptable.emailEngine et exporte SendEmail.

Si vous voyez des erreurs côté fournisseur, consignez le nom du modèle et les choix de culture, mais évitez de consigner les corps rendus complets. Le contenu des e-mails peut contenir des données personnelles.

FAQ

S’agit-il d’un point de terminaison HTTP public ?

Non. Cette page documente une interface d’exécution de script que votre script de tenant implémente. Si vous souhaitez appeler une API HTTP externe, vous le faites depuis SendEmail.

Où se trouvent les modèles d’e-mail ?

Ils se trouvent dans les répertoires listés dans ressources. Par défaut, cela pointe vers /locales/emails/.

Peut-on combiner un fournisseur par script avec SendGrid ou Mailchimp ?

Pas en même temps pour un tenant donné. Le fournisseur actif est sélectionné dans /server/emails.yml.

Que devons-nous renvoyer depuis SendEmail?

Retournez normalement lorsque l’e-mail est accepté par votre fournisseur. Lancez une erreur lorsque l’envoi échoue, afin que la plateforme puisse l’afficher.

Quelle est la façon la plus rapide de valider la configuration ?

Activez le script fournisseur, déclenchez un seul e-mail transactionnel, puis vérifiez les journaux de votre fournisseur pour l’événement d’envoi.