Passer au contenu principal
Le contenu des e‑mails par défaut envoyés par Vantage contient des informations spécifiques à ABBYY, comme les adresses e‑mail du support client ABBYY, les notifications relatives au RGPD d’ABBYY et des pieds de page avec les droits d’auteur d’ABBYY. Vous pouvez modifier les modèles de ces e‑mails pour y inclure vos propres informations et les adapter spécifiquement à votre entreprise.

​
Modèles d’e-mail disponibles

Vantage propose les modèles d’e-mail suivants :
Modèle d’e-mailIDCultureParamètres du modèle d’objetParamètres du modèle de corps
E-mail d’invitation envoyé à l’administrateur d’un tenant nouvellement crééE6F03F64-B982-49C6-B336-251CA6C45FFEenproductNameuserName - le nom de l’utilisateur à qui l’e-mail est envoyé, productName - le nom du produit, invitationUri - le lien d’invitation pour créer un compte
E-mail d’invitation envoyé au tenant nouvellement créé6C5DBE28-0A2C-4EB7-82DC-04173DC75418enproductNameuserName - le nom de l’utilisateur à qui l’e-mail est envoyé, productName - le nom du produit, invitationUri - le lien d’invitation pour créer un compte
E-mail contenant un lien de réinitialisation de mot de passe demandé par un utilisateur sur la page de connexion Vantage701B077A-20EA-42B8-A71E-AB3EA5996039enN/AdisplayName - nom d’affichage facultatif fourni lors de l’inscription, callbackUrl - le lien pour réinitialiser le mot de passe, expireHours - le nombre d’heures avant l’expiration du lien
E-mail concernant l’exportation réussie d’une compétence vers un dossier partagéB5A03F64-B982-49C6-B336-251CA6C45FFEenN/AuserName - l’adresse e-mail de l’utilisateur, skillName - la compétence en cours d’exportation, folderPath - le chemin d’accès au dossier partagé
E-mail concernant l’exportation échouée d’une compétence vers un dossier partagéF3C4BD68-B9FF-439F-A719-5B4F62263C4EenN/AuserName - l’adresse e-mail de l’utilisateur, skillName - la compétence en cours d’exportation, errorMessage - le corps du message d’erreur

​
Modification d’un modèle d’e-mail

Pour modifier un modèle d’e-mail, procédez comme suit :
  1. Accéder au service de messagerie Vantage
  2. Obtenir les détails du modèle d’e-mail
  3. Mettre à jour le modèle d’e-mail

​
Accéder au service de messagerie Vantage

Pour accéder au service de messagerie :
  1. Accédez à l’API du service de messagerie via http://localhost:8080 ou un autre port :
kubectl -n abbyy-vantage port-forward $(kubectl get service -n abbyy-vantage --selector='app.kubernetes.io/name=mail' -o name) 8080:80
Exemple de sortie de terminal : 
Forwarding from 127.0.0.1:8080 -> 8080
Forwarding from [::1]:8080 -> 8080

​
Récupération des détails d’un modèle d’e-mail

Pour récupérer le balisage d’un modèle d’e-mail existant, envoyez une requête GET vers la ressource templates (http://localhost:8080) comme suit : 
GET http://localhost:8080/api/v1/templates/{templateId}
Exemple de réponse : 
{
  "localizedTemplates": {
    "en": {
      "subjectTemplate": "Votre invitation à {{productName}}",
      "bodyTemplate": "<body>...</body>"
    }
  },
  "id": "<templateId>",
  "createTime": "2022-04-06T07:23:52.903261+00:00",
  "updateTime": "2022-04-06T07:23:53.137142+00:00"
}
La réponse ne contiendra pas les pièces jointes, qui seront à la place ajoutées au modèle d’e-mail. Elles doivent être indiquées et peuvent également être modifiées lors de la mise à jour du modèle.

​
Mettre à jour un modèle d’e-mail

Pour remplacer un modèle d’e-mail, envoyez une requête PUT vers la ressource templates : 
PUT http://localhost:8080/api/v1/templates/{templateId}
Corps de requête : 
{
  "culture": "en",
  "subjectTemplate": "subject template",
  "bodyTemplate": "body template",
  "attachments": [
    {
      "contentType": "attachment MIME",
      "contentId": "guid",
      "fileName": "image name used in body as cid",
      "content": "file content in base64 string"
    }
  ]
}

​
Éléments du modèle

FieldTypeDescription
templateIdGUIDIdentifiant du modèle d’e-mail à modifier
culturestringLangue du modèle. Actuellement, seul l’anglais (en) est pris en charge
subjectTemplatestringModèle de texte de l’objet de l’e-mail. Voir la section précédente pour savoir comment obtenir la valeur actuelle
bodyTemplatestringModèle de corps de l’e-mail. Voir la section précédente pour savoir comment obtenir la valeur actuelle
attachments[].contentTypestringType MIME de la pièce jointe (par exemple, image/png)
attachments[].contentIdstringIdentifiant unique de la pièce jointe
attachments[].fileNamestringNom de fichier de la pièce jointe, qui peut être utilisé dans le corps en tant que CID
attachments[].contentbase64stringFichier de pièce jointe encodé au format base64
Les paramètres subjectTemplate et bodyTemplate doivent rester inchangés. Ne les ajoutez pas, ne les supprimez pas et ne les modifiez pas.
Incluez toujours toutes les pièces jointes, même si vous ne prévoyez pas de les modifier. La requête remplace complètement le modèle d’e-mail.

​
Pièces jointes par défaut

Chaque modèle d’e-mail Vantage contient les quatre images jointes suivantes :
CIDType MIMEImage
logo-vantage-logo-normal.pngimage/pngLogo ABBYY Vantage
600-px-copy-6.pngimage/pngImage décorative d’en-tête
[email protected]image/png
[email protected]image/png

​
Exemple de requête

PUT http://localhost:8080/api/v1/templates/E6F03F64-B982-49C6-B336-251CA6C45FFE

{
  "culture": "en",
  "subjectTemplate": "Your {{productName}} account information",
  "bodyTemplate": "<body><table ...>...<img ... src=\"cid:logo-vantage-logo-normal.png\" alt=\"ABBYY Vantage\" />...Dear {{userName}},...</body>",
  "attachments": [
    {
      "contentType": "image/png",
      "contentId": "4dcc3114-b7ff-48b5-902a-8fbd673d6acd",
      "fileName": "logo-vantage-logo-normal.png",
      "content": "iVBORw0KGgoAAAANSUhEUgAAALoAAAAcCAMAAADhlVUwAAAA..."
    },
    {
      "contentType": "image/png",
      "contentId": "e243efa2-55ed-4f07-a1e0-27d55460decc",
      "fileName": "600-px-copy-6.png",
      "content": "iVBORw0KGgoAAAANSUhEUgAAAlgAAACkCAMAAAB8d6ClAAAA..."
    },
    {
      "contentType": "image/png",
      "contentId": "d57f26bb-43b6-41a3-b356-3f53dfbd28d7",
      "fileName": "[email protected]",
      "content": "iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAMAAABEpIrGAAAA..."
    },
    {
      "contentType": "image/png",
      "contentId": "df64ab94-9c7f-49d1-93bf-f7ba48eb2a98",
      "fileName": "[email protected]",
      "content": "iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAMAAABEpIrGAAAA..."
    }
  ]
}

​
Conversion de fichiers au format Base64

Pour obtenir la représentation sous forme de chaîne Base64 d’un fichier, exécutez la commande suivante : 
[Convert]::ToBase64String([IO.File]::ReadAllBytes("full path to file"))