Pular para o conteúdo principal
As mensagens de e-mail padrão enviadas pelo Vantage incluem informações específicas da ABBYY, como endereços de e-mail de suporte ao cliente da ABBYY, avisos relacionados ao GDPR da ABBYY e rodapés com direitos autorais da ABBYY. Você pode modificar os modelos desses e-mails para incluir informações próprias e adaptá-los à sua empresa.

​
Modelos de Email Disponíveis

Vantage oferece os seguintes modelos de email:
Modelo de EmailIDCulturaParâmetros do Modelo de AssuntoParâmetros do Modelo de Corpo
Email de convite enviado ao administrador do tenant de um tenant recém-criadoE6F03F64-B982-49C6-B336-251CA6C45FFEenproductNameuserName - o nome do usuário para o qual o email está sendo enviado, productName - o nome do produto, invitationUri - o link de convite para criar uma conta
Email de convite enviado ao tenant recém-criado6C5DBE28-0A2C-4EB7-82DC-04173DC75418enproductNameuserName - o nome do usuário para o qual o email está sendo enviado, productName - o nome do produto, invitationUri - o link de convite para criar uma conta
Email com um link de redefinição de senha solicitado por um usuário na página de login do Vantage701B077A-20EA-42B8-A71E-AB3EA5996039enN/AdisplayName - nome de exibição opcional fornecido durante o registro, callbackUrl - o link para redefinir a senha, expireHours - o número de horas até o link expirar
Email sobre uma exportação de skill bem-sucedida para uma pasta compartilhadaB5A03F64-B982-49C6-B336-251CA6C45FFEenN/AuserName - o endereço de email do usuário, skillName - a skill que está sendo exportada, folderPath - o caminho para a pasta compartilhada
Email sobre uma exportação de skill malsucedida para uma pasta compartilhadaF3C4BD68-B9FF-439F-A719-5B4F62263C4EenN/AuserName - o email do usuário, skillName - a skill que está sendo exportada, errorMessage - o corpo da mensagem de erro

​
Alterando um modelo de e-mail

Para alterar um modelo de e-mail, siga estas etapas:
  1. Obter acesso ao serviço de e-mail do Vantage
  2. Obter os detalhes do modelo de e-mail
  3. Atualizar o modelo de e-mail

​
Como obter acesso ao serviço de e-mail do Vantage

Para obter acesso ao serviço de e-mail:
  1. Obtenha acesso à API do serviço de e-mail por meio de http://localhost:8080 ou outra porta:
kubectl -n abbyy-vantage port-forward $(kubectl get service -n abbyy-vantage --selector='app.kubernetes.io/name=mail' -o name) 8080:80
Exemplo de saída no terminal: 
Forwarding from 127.0.0.1:8080 -> 8080
Forwarding from [::1]:8080 -> 8080

​
Obtendo detalhes do modelo de e-mail

Para obter o código de marcação (markup) de um modelo de e-mail existente, envie uma solicitação GET ao recurso templates (http://localhost:8080) da seguinte forma: 
GET http://localhost:8080/api/v1/templates/{templateId}
Exemplo de resposta: 
{
  "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"
}
A resposta não incluirá os anexos, que serão adicionados ao modelo de e-mail. Eles devem ser especificados e podem, adicionalmente, ser modificados ao atualizar o modelo.

​
Atualizar um Modelo de E-mail

Para substituir um modelo de e-mail, envie uma requisição PUT para o recurso de modelos: 
PUT http://localhost:8080/api/v1/templates/{templateId}
Corpo da requisição: 
{
  "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"
    }
  ]
}

​
Elementos do Template

FieldTypeDescription
templateIdGUIDIdentificador do modelo de e-mail a ser modificado
culturestringIdioma do modelo. Atualmente, somente o inglês (en) é suportado
subjectTemplatestringModelo de texto do assunto do e-mail. Consulte a seção anterior para saber como obter o valor atual
bodyTemplatestringModelo do corpo do e-mail. Consulte a seção anterior para saber como obter o valor atual
attachments[].contentTypestringTipo MIME do anexo (por exemplo, image/png)
attachments[].contentIdstringIdentificador único do anexo
attachments[].fileNamestringNome do arquivo do anexo, que pode ser usado no corpo como CID
attachments[].contentbase64stringArquivo de anexo codificado em formato base64
Os parâmetros subjectTemplate e bodyTemplate devem permanecer inalterados. Não os adicione, remova ou modifique.
Sempre inclua todos os anexos, mesmo que você não pretenda modificá-los. A solicitação substitui completamente o modelo de e-mail.

​
Anexos padrão

Cada modelo de e-mail do Vantage contém estas quatro imagens anexas:
CIDMIME TypeImagem
logo-vantage-logo-normal.pngimage/pngLogotipo do ABBYY Vantage
600-px-copy-6.pngimage/pngImagem decorativa de cabeçalho
[email protected]image/png
[email protected]image/png

​
Exemplo de solicitação

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

​
Convertendo arquivos para Base64

Para obter a representação em string Base64 de um arquivo, execute o seguinte comando: 
[Convert]::ToBase64String([IO.File]::ReadAllBytes("caminho completo para o arquivo"))