DocumentationSDK sur GitHub

Documentation Référence

Paramètres de l’éditeur

Configurez la création des emails et reliez la sauvegarde, la personnalisation et l’envoi à votre application.

Sur cette page

Documentation

Dans le tableau de bord, ouvrez les paramètres d’un éditeur. Le bouton d’information de chaque réglage affiche l’aide. Enregistrez l’éditeur pour appliquer vos modifications.

Conditions d’affichage

Proposez des règles nommées pour afficher une section ou une mise en page complète en colonnes à certains destinataires. Définissez les règles ici, puis sélectionnez une mise en page dans l’éditeur et choisissez Afficher si dans ses options.

Renseignez la syntaxe d’ouverture et de fermeture comprise par votre outil d’envoi. L’exemple utilise Liquid : adaptez-le à votre plateforme. Weavour conserve ces chaînes sans les interpréter.

  • L’ID est un identifiant stable, par exemple free_account. Le nom apparaît dans le sélecteur ; la catégorie et la description sont facultatives.
  • Ajoutez jusqu’à 100 définitions. Les deux champs de syntaxe sont obligatoires. Utilisez des directives de modèle plutôt que des balises HTML.
  • Une mise en page imbriquée exige que toutes les règles parentes soient vraies. Les scénarios d’aperçu sont des exemples et ne modifient pas les exports habituels.
  • Avant l’envoi, évaluez la syntaxe exportée dans votre plateforme ou appelez le rendu du document sauvegardé avec des conditionValues booléens, indexés par ID. Fournissez un résultat pour chaque règle atteignable.
  • Conservez l’enveloppe complète de onDocumentChange et rechargez-la avec emailDocument. Les documents conditionnels nécessitent schemaVersion: 2, le SDK 0.1.6 et un éditeur hébergé compatible.
typescript
editor.updateConfig({
  displayConditions: [{
    id: 'free_account', label: 'Free accounts', category: 'Account',
    before: "{% if account.plan == 'free' %}", after: '{% endif %}',
  }],
});
const output = await editor.exportHTML();
// Evaluate the host syntax before delivering HTML and plain text.
console.log(output.displayConditions, output.displayConditionIssues);
// Persist onDocumentChange envelopes; reopen with emailDocument.

Champs de personnalisation

Définissez les variables de texte et de lien propres à chaque destinataire, comme un prénom ou une URL de compte. Les auteurs les insèrent par leur nom sans saisir votre syntaxe.

  • Attribuez un ID stable, un nom lisible et le jeton exact attendu par votre plateforme d’envoi.
  • Choisissez Texte pour le contenu ou URL pour une destination. La description et la valeur d’exemple facilitent le choix et l’aperçu.
  • Les définitions sauvegardées et celles du SDK sont fusionnées par ID. Les champs déjà insérés conservent leur syntaxe à la sauvegarde et à l’export.
  • Remplacez les jetons dans votre chaîne d’envoi ou fournissez mergeValues au rendu du document sauvegardé.
typescript
// Run on your mounted editor instance.
editor.updateConfig({
  mergeTags: [
    { id: 'first_name', label: 'First name', token: '{{first_name}}', kind: 'text', sampleValue: 'Alex' },
    { id: 'account_url', label: 'Account URL', token: '{{account_url}}', kind: 'url', sampleValue: 'https://example.com/account' },
  ],
});

const output = await editor.exportHTML();
console.log(output.mergeTags, output.mergeTagIssues);
// Exports retain literal tokens. Resolve recipient values before delivery.

Sauvegarde automatique et brouillons

Activez la sauvegarde hébergée pour conserver les brouillons et leur historique dans Weavour. Si vous la désactivez, votre application doit sauvegarder le document versionné complet.

  • Conservez le draftId sur votre fiche applicative. Rouvrez-le avec la même clé d’éditeur et le même périmètre userId et organizationId.
  • Pour reprendre un brouillon, transmettez draftId seul, sans contenu initial ni emailDocument.
  • Attendez flushAutosave() et traitez les échecs avant de quitter la page, puis appelez destroy(). Un événement de modification ou un export HTML ne confirme pas une sauvegarde.
  • L’historique conserve 30 jours de versions. Une restauration crée une nouvelle version.

Blocs d’organisation

Les auteurs peuvent enregistrer une mise en page complète comme bloc réutilisable par leur organisation, avec ses mises en page imbriquées, images et conditions.

  • Fournissez userId et organizationId au montage pour accéder à la bibliothèque de blocs.
  • Les ID d’organisation sont propres à votre espace client. Réutilisez le même ID pour les éditeurs d’une même organisation.
  • Un bloc inséré devient une copie indépendante. Modifier la bibliothèque ne change pas les emails existants.
  • Les administrateurs gèrent les blocs enregistrés depuis Blocs d’organisation dans le tableau de bord.

Modèles

Activez le sélecteur pour commencer à partir des modèles inclus, de l’espace client ou des utilisateurs accessibles dans le périmètre courant.

  • Les administrateurs gèrent les modèles et les publient pour toutes les organisations ou pour une sélection.
  • Un modèle utilisateur est privé au couple organisation/utilisateur, ou à l’utilisateur en contexte personnel. Le partage est explicite.
  • Créer un email à partir d’un modèle produit une copie indépendante. Modifier la source exige les droits correspondants et l’action Enregistrer le modèle.
  • Masquer le sélecteur conserve l’email courant et les modèles sauvegardés.

Audit des emails

Affichez une note de contenu et des constats exploitables sous le canevas. Les auteurs ouvrent le rapport et accèdent aux éléments à corriger.

  • Les contrôles portent sur le contenu, l’accessibilité, les images, les liens et les risques courants de rendu.
  • L’audit fonctionne sans IA. Sa note et ses contrôles ne figurent pas dans l’email exporté.
  • La désactivation arrête les contrôles en arrière-plan et masque l’audit sans modifier l’email.
  • Testez l’email final personnalisé dans les clients de messagerie visés avant l’envoi.

Blocs disponibles

Choisissez les contenus et mises en page que les auteurs peuvent insérer. Adaptez la palette au parcours de votre application.

  • La sélection filtre la palette d’insertion. Tout décocher masque toutes ses entrées.
  • Modifier la liste ne supprime aucun bloc des emails sauvegardés.
  • Une préférence SDK allowedBlocks explicite remplace la sélection enregistrée. Omettez-la pour conserver les valeurs du tableau de bord.

Apparence et langue

Adaptez les contrôles de l’éditeur à votre application avec le thème, les couleurs, la police, la densité et les arrondis. Vérifiez le résultat dans l’aperçu.

  • Partez d’un mode clair ou sombre, puis ajustez les couleurs en gardant les textes, contrôles et indicateurs de focus lisibles.
  • La langue concerne l’interface. Les auteurs peuvent rédiger leurs emails dans une autre langue.
  • Les changements préservent le brouillon et sa mise en page. Les valeurs du thème fournies par le SDK sont prioritaires et modifiables à chaud.
Besoin d’aide ? Contactez-nous