Vai al contenuto principale
I testi delle email predefinite inviate da Vantage includono informazioni specifiche di ABBYY, come gli indirizzi email dell’assistenza clienti ABBYY, gli avvisi relativi al GDPR da parte di ABBYY e i piè di pagina con i diritti d’autore di ABBYY. È possibile modificare i modelli di queste email per includere i propri dati e renderli specifici per la propria azienda.

​
Modelli di email disponibili

Vantage offre i seguenti modelli di email:
Modello di emailIDCultureSubject Template ParametersBody Template Parameters
Email di invito inviata all’amministratore del tenant di un tenant appena creatoE6F03F64-B982-49C6-B336-251CA6C45FFEenproductNameuserName - il nome dell’utente a cui viene inviata l’email, productName - il nome del prodotto, invitationUri - il link di invito per creare un account
Email di invito inviata al tenant appena creato6C5DBE28-0A2C-4EB7-82DC-04173DC75418enproductNameuserName - il nome dell’utente a cui viene inviata l’email, productName - il nome del prodotto, invitationUri - il link di invito per creare un account
Email con un link di reimpostazione della password richiesto da un utente nella pagina di accesso di Vantage701B077A-20EA-42B8-A71E-AB3EA5996039enN/AdisplayName - nome utente visualizzato facoltativo fornito durante la registrazione, callbackUrl - il link per reimpostare la password, expireHours - il numero di ore fino alla scadenza del link
Email relativa a un’esportazione di Skill riuscita in una cartella condivisaB5A03F64-B982-49C6-B336-251CA6C45FFEenN/AuserName - l’indirizzo email dell’utente, skillName - la Skill che viene esportata, folderPath - il percorso alla cartella condivisa
Email relativa a un’esportazione di Skill non riuscita in una cartella condivisaF3C4BD68-B9FF-439F-A719-5B4F62263C4EenN/AuserName - l’email dell’utente, skillName - la Skill che viene esportata, errorMessage - il corpo del messaggio di errore

​
Modifica di un modello di email

Per modificare un modello di email, segui questi passaggi:
  1. Accedi al servizio di posta Vantage
  2. Recupera i dettagli del modello di email
  3. Aggiorna il modello di email

​
Accesso al servizio Mail di Vantage

Per accedere al servizio Mail:
  1. Accedi all’API del servizio Mail tramite http://localhost:8080 o un’altra porta:
kubectl -n abbyy-vantage port-forward $(kubectl get service -n abbyy-vantage --selector='app.kubernetes.io/name=mail' -o name) 8080:80
Esempio di output del terminale: 
Forwarding from 127.0.0.1:8080 -> 8080
Forwarding from [::1]:8080 -> 8080

​
Recuperare i dettagli del modello email

Per ottenere il markup di un modello email esistente, invia una richiesta GET alla risorsa templates (http://localhost:8080) come segue: 
GET http://localhost:8080/api/v1/templates/{templateId}
Esempio di risposta: 
{
  "localizedTemplates": {
    "en": {
      "subjectTemplate": "Il tuo invito per {{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 risposta non conterrà gli allegati, che invece verranno inseriti nel modello di email. Devono essere specificati e possono inoltre essere modificati quando si aggiorna il modello.

​
Aggiornamento di un modello di email

Per sostituire un modello di email, inviare una richiesta PUT alla risorsa templates: 
PUT http://localhost:8080/api/v1/templates/{templateId}
Corpo della richiesta: 
{
  "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"
    }
  ]
}

​
Elementi del template

FieldTypeDescription
templateIdGUIDIdentificatore del template di email da modificare
culturestringLingua del template. Attualmente è supportato solo l’inglese (en)
subjectTemplatestringTemplate del testo dell’oggetto dell’email. Vedi la sezione precedente per informazioni su come ottenere il valore corrente
bodyTemplatestringTemplate del corpo dell’email. Vedi la sezione precedente per informazioni su come ottenere il valore corrente
attachments[].contentTypestringTipo MIME dell’allegato (ad esempio, image/png)
attachments[].contentIdstringIdentificatore univoco dell’allegato
attachments[].fileNamestringNome del file allegato, può essere utilizzato nel corpo come CID
attachments[].contentbase64stringFile allegato codificato in formato base64
I parametri del template per l’oggetto e il corpo devono rimanere invariati. Non aggiungerli, rimuoverli o modificarli.
Includi sempre tutti gli allegati, anche se non intendi modificarli. La richiesta sostituisce completamente il template di email.

​
Allegati predefiniti

Ogni modello di email di Vantage contiene le seguenti quattro immagini allegate:
CIDMIME TypeImmagine
logo-vantage-logo-normal.pngimage/pngLogo ABBYY Vantage
600-px-copy-6.pngimage/pngImmagine decorativa di intestazione
[email protected]image/png
[email protected]image/png

​
Esempio di richiesta

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

​
Conversione dei file in Base64

Per ottenere la rappresentazione di un file come stringa Base64, esegui il comando seguente: 
[Convert]::ToBase64String([IO.File]::ReadAllBytes("percorso completo del file"))