Zum Hauptinhalt springen
Standardtexte für E-Mails, die von Vantage gesendet werden, enthalten ABBYY-spezifische Informationen, wie zum Beispiel E-Mail-Adressen des ABBYY-Kundensupports, DSGVO-Hinweise von ABBYY und Fußzeilen mit ABBYY-Urheberrechten. Sie können die Vorlagen für diese E-Mails anpassen, um Ihre eigenen Angaben aufzunehmen und sie auf Ihr Unternehmen zuzuschneiden.

​
Verfügbare E-Mail-Vorlagen

Vantage bietet die folgenden E-Mail-Vorlagen:
E-Mail-VorlageIDCultureSubject Template ParametersBody Template Parameters
Einladungs-E-Mail, die an den Mandantenadministrator eines neu erstellten Mandanten gesendet wirdE6F03F64-B982-49C6-B336-251CA6C45FFEenproductNameuserName - der Name des Benutzers, an den die E-Mail gesendet wird, productName - der Name des Produkts, invitationUri - der Einladungslink zum Erstellen eines Kontos
Einladungs-E-Mail, die an den neu erstellten Mandanten gesendet wird6C5DBE28-0A2C-4EB7-82DC-04173DC75418enproductNameuserName - der Name des Benutzers, an den die E-Mail gesendet wird, productName - der Name des Produkts, invitationUri - der Einladungslink zum Erstellen eines Kontos
E-Mail mit einem Link zum Zurücksetzen des Passworts, die von einem Benutzer auf der Vantage-Anmeldeseite angefordert wurde701B077A-20EA-42B8-A71E-AB3EA5996039enN/AdisplayName - optionaler Anzeigename, der während der Registrierung angegeben wurde, callbackUrl - der Link zum Zurücksetzen des Passworts, expireHours - die Anzahl der Stunden, bis der Link abläuft
E-Mail über einen erfolgreichen Skill-Export in einen freigegebenen OrdnerB5A03F64-B982-49C6-B336-251CA6C45FFEenN/AuserName - die E-Mail-Adresse des Benutzers, skillName - der Skill, der exportiert wird, folderPath - der Pfad zu dem freigegebenen Ordner
E-Mail über einen fehlgeschlagenen Skill-Export in einen freigegebenen OrdnerF3C4BD68-B9FF-439F-A719-5B4F62263C4EenN/AuserName - die E-Mail-Adresse des Benutzers, skillName - der Skill, der exportiert wird, errorMessage - der Text der Fehlermeldung

​
Ändern einer E-Mail-Vorlage

Um eine E-Mail-Vorlage zu ändern, gehen Sie wie folgt vor:
  1. Zugriff auf den Vantage Mail Service erhalten
  2. Details der E-Mail-Vorlage abrufen
  3. E-Mail-Vorlage aktualisieren

​
Zugriff auf den Vantage Mail-Service

So erhalten Sie Zugriff auf den Mail-Service:
  1. Rufen Sie die Mail-Service-API über http://localhost:8080 oder einen anderen Port auf:
kubectl -n abbyy-vantage port-forward $(kubectl get service -n abbyy-vantage --selector='app.kubernetes.io/name=mail' -o name) 8080:80
Beispielausgabe des Terminals: 
Forwarding from 127.0.0.1:8080 -> 8080
Forwarding from [::1]:8080 -> 8080

​
Details einer E-Mail-Vorlage abrufen

Um das Markup für eine vorhandene E-Mail-Vorlage zu erhalten, senden Sie wie folgt eine GET-Anfrage an die Ressource templates (http://localhost:8080): 
GET http://localhost:8080/api/v1/templates/{templateId}
Beispielantwort: 
{
  "localizedTemplates": {
    "en": {
      "subjectTemplate": "Ihre Einladung zu {{productName}}",
      "bodyTemplate": "<body>...</body>"
    }
  },
  "id": "<templateId>",
  "createTime": "2022-04-06T07:23:52.903261+00:00",
  "updateTime": "2022-04-06T07:23:53.137142+00:00"
}
Die Antwort selbst enthält die Anhänge nicht; diese werden stattdessen in der E-Mail-Vorlage platziert. Sie müssen dort angegeben werden und können beim Aktualisieren der Vorlage zusätzlich geändert werden.

​
Aktualisieren einer E-Mail-Vorlage

Um eine E-Mail-Vorlage zu ersetzen, senden Sie einen PUT-Request an die Ressource „templates“: 
PUT http://localhost:8080/api/v1/templates/{templateId}
Anfragetext: 
{
  "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"
    }
  ]
}

​
Vorlagenelemente

FeldTypBeschreibung
templateIdGUIDBezeichner der zu aktualisierenden E-Mail-Vorlage
culturestringSprache der Vorlage. Derzeit ist nur Englisch (en) verfügbar
subjectTemplatestringVorlage für den E-Mail-Betreff. Informationen zum Abrufen des aktuellen Werts finden Sie im vorherigen Abschnitt
bodyTemplatestringVorlage für den E-Mail-Text. Informationen zum Abrufen des aktuellen Werts finden Sie im vorherigen Abschnitt
attachments[].contentTypestringMIME-Typ des Anhangs (zum Beispiel image/png)
attachments[].contentIdstringEindeutiger Bezeichner für den Anhang
attachments[].fileNamestringDateiname des Anhangs, kann im Nachrichtentext als CID verwendet werden
attachments[].contentbase64stringIm base64-Format codierte Anhangsdatei
Die Parameter für Betreff- und Textvorlage müssen unverändert bleiben. Fügen Sie keine Parameter hinzu, und entfernen oder ändern Sie keine vorhandenen.
Schließen Sie immer alle Anhänge ein, selbst wenn Sie nicht beabsichtigen, sie zu ändern. Die Anfrage ersetzt die E-Mail-Vorlage vollständig.

​
Standardanhänge

Jede E-Mail-Vorlage in Vantage enthält diese vier angehängten Bilder:
CIDMIME TypeBild
logo-vantage-logo-normal.pngimage/pngABBYY Vantage-Logo
600-px-copy-6.pngimage/pngDekoratives Kopfzeilenbild
[email protected]image/png
[email protected]image/png

​
Beispielanforderung

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..."
    }
  ]
}

​
Dateien in Base64 konvertieren

Um die Base64-String-Darstellung einer Datei zu erhalten, führen Sie den folgenden Befehl aus: 
[Convert]::ToBase64String([IO.File]::ReadAllBytes("full path to file"))