E-Mail-Vorlagen - ABBYY Documentation

Die standardmäßig von Vantage versendeten E-Mail-Texte enthalten ABBYY-spezifische Informationen wie E-Mail-Adressen des ABBYY-Kundensupports, DSGVO-Hinweise von ABBYY und Fußzeilen mit ABBYY-Urheberrechtshinweisen. Sie können die Vorlagen dieser E-Mails anpassen, um Ihre eigenen Angaben einzufügen und sie auf Ihr Unternehmen zuzuschneiden.

Verfügbare E-Mail-Vorlagen

Vantage bietet die folgenden E-Mail-Vorlagen:

E-Mail-Vorlage	ID	Kultur	Parameter der Betreffvorlage	Parameter der Textvorlage
Einladungs-E-Mail, die an den Mandantenadministrator eines neu erstellten Mandanten gesendet wird	`E6F03F64-B982-49C6-B336-251CA6C45FFE`	en	`productName`	`userName` - 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 wird	`6C5DBE28-0A2C-4EB7-82DC-04173DC75418`	en	`productName`	`userName` - 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 Link zum Zurücksetzen des Kennworts, die von einem Benutzer auf der Vantage-Anmeldeseite angefordert wurde	`701B077A-20EA-42B8-A71E-AB3EA5996039`	en	N/A	`displayName` - optionaler Anzeigename des Benutzers, der bei der Registrierung angegeben wurde, `callbackUrl` - der Link zum Zurücksetzen des Kennworts, `expireHours` - die Anzahl der Stunden, bis der Link abläuft
E-Mail über einen erfolgreichen Skill-Export in einen freigegebenen Ordner	`B5A03F64-B982-49C6-B336-251CA6C45FFE`	en	N/A	`userName` - die E-Mail-Adresse des Benutzers, `skillName` - der Skill, der exportiert wird, `folderPath` - der Pfad zum freigegebenen Ordner
E-Mail über einen fehlgeschlagenen Skill-Export in einen freigegebenen Ordner	`F3C4BD68-B9FF-439F-A719-5B4F62263C4E`	en	N/A	`userName` - die E-Mail-Adresse des Benutzers, `skillName` - der Skill, der exportiert wird, `errorMessage` - der Text der Fehlermeldung

Ändern einer E-Mail-Vorlage

Gehen Sie wie folgt vor, um eine E-Mail-Vorlage zu ändern:

Zugriff auf den Vantage Mail-Service erhalten
Details zur E-Mail-Vorlage abrufen
Die E-Mail-Vorlage aktualisieren

Zugriff auf den Vantage Mail-Service

So erhalten Sie Zugriff auf den Mail-Service:

Greifen Sie über http://localhost:8080 oder einen anderen Port auf die Mail-Service-API zu:

kubectl -n abbyy-vantage port-forward $(kubectl get service -n abbyy-vantage --selector='app.kubernetes.io/name=mail' -o name) 8080:80

Beispielausgabe im Terminal:

Forwarding from 127.0.0.1:8080 -> 8080
Forwarding from [::1]:8080 -> 8080

Abrufen der Details einer E-Mail-Vorlage

Um das Markup für eine vorhandene E-Mail-Vorlage abzurufen, senden Sie wie folgt eine GET-Anfrage an die Templates-Ressource (http://localhost:8080):

GET http://localhost:8080/api/v1/templates/{templateId}

Beispielantwort:

{
  "localizedTemplates": {
    "en": {
      "subjectTemplate": "Your invitation to {{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 enthält keine Anhänge; diese werden stattdessen in der E-Mail-Vorlage eingefügt. Sie müssen angegeben werden und können beim Aktualisieren der Vorlage zudem geändert werden.

Eine E-Mail-Vorlage aktualisieren

Um eine E-Mail-Vorlage zu ersetzen, senden Sie eine PUT-Anfrage an die Ressource templates:

PUT http://localhost:8080/api/v1/templates/{templateId}

Request-Body:

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

Template-Elemente

Feld	Typ	Beschreibung
`templateId`	GUID	Bezeichner der E-Mail-Vorlage, die geändert werden soll
`culture`	string	Sprache der Vorlage. Derzeit wird nur Englisch (en) unterstützt
`subjectTemplate`	string	Vorlage für den E-Mail-Betreff. Informationen dazu, wie Sie den aktuellen Wert abrufen, finden Sie im vorherigen Abschnitt
`bodyTemplate`	string	Vorlage für den E-Mail-Text. Informationen dazu, wie Sie den aktuellen Wert abrufen, finden Sie im vorherigen Abschnitt
`attachments[].contentType`	string	MIME-Typ des Anhangs (zum Beispiel `image/png`)
`attachments[].contentId`	string	Eindeutiger Bezeichner des Anhangs
`attachments[].fileName`	string	Dateiname des Anhangs; kann im Textkörper als CID verwendet werden
`attachments[].content`	base64string	In Base64 codierte Anhangdatei

Die Parameter für Betreffs- und Textvorlage müssen unverändert bleiben. Fügen Sie sie nicht hinzu, entfernen Sie sie nicht und ändern Sie sie nicht.

Schließen Sie immer alle Anhänge ein, auch wenn Sie sie nicht ändern möchten. Die Anfrage ersetzt die E-Mail-Vorlage vollständig.

Standardanhänge

Jede Vantage-E-Mail-Vorlage enthält diese vier Bildanhänge:

CID	MIME-Typ	Bild
`logo-vantage-logo-normal.png`	image/png
`600-px-copy-6.png`	image/png
`16-headset-16@2x.png`	image/png
`16-global-outline-16@2x.png`	image/png

Beispielanfrage

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": "16-headset-16@2x.png",
      "content": "iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAMAAABEpIrGAAAA..."
    },
    {
      "contentType": "image/png",
      "contentId": "df64ab94-9c7f-49d1-93bf-f7ba48eb2a98",
      "fileName": "16-global-outline-16@2x.png",
      "content": "iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAMAAABEpIrGAAAA..."
    }
  ]
}

Dateien in Base64 umwandeln

Führen Sie den folgenden Befehl aus, um die Base64-Darstellung einer Datei als string zu erhalten:

[Convert]::ToBase64String([IO.File]::ReadAllBytes("full path to file"))

​Verfügbare E-Mail-Vorlagen

​Ändern einer E-Mail-Vorlage

​Zugriff auf den Vantage Mail-Service

​Abrufen der Details einer E-Mail-Vorlage

​Eine E-Mail-Vorlage aktualisieren

​Template-Elemente

​Standardanhänge

​Beispielanfrage

​Dateien in Base64 umwandeln

Verfügbare E-Mail-Vorlagen

Ändern einer E-Mail-Vorlage

Zugriff auf den Vantage Mail-Service

Abrufen der Details einer E-Mail-Vorlage

Eine E-Mail-Vorlage aktualisieren

Template-Elemente

Standardanhänge

Beispielanfrage

Dateien in Base64 umwandeln