> ## Documentation Index
> Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Templates de correo electrónico

> Personalice las Templates de correo electrónico que ABBYY Vantage autoalojado envía a los usuarios, incluidos el asunto, el cuerpo y los parámetros del Template, para adaptarlas a la identidad de marca de su empresa.

Los textos predeterminados de los correos electrónicos que envía Vantage incluyen información específica de ABBYY, como direcciones de correo de soporte al cliente de ABBYY, avisos del RGPD de ABBYY y pies de página con avisos de copyright de ABBYY. Puede modificar las Templates de estos correos electrónicos para incluir sus propios datos y adaptarlas específicamente a su empresa.

<div id="available-email-templates">
  ## Templates de correo electrónico disponibles
</div>

Vantage ofrece las siguientes Templates de correo electrónico:

| Template de correo electrónico                                                                                                      | ID                                     | Cultura | Parámetros del Template del asunto | Parámetros del Template del cuerpo                                                                                                                                                                       |
| ----------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------- | ------- | ---------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Correo electrónico de invitación enviado al Administrador del tenant de un tenant de nueva creación                                 | `E6F03F64-B982-49C6-B336-251CA6C45FFE` | en      | `productName`                      | `userName` - el nombre del usuario al que se envía el correo electrónico, `productName` - el nombre del producto, `invitationUri` - el enlace de invitación para crear una cuenta                        |
| Correo electrónico de invitación enviado al tenant de nueva creación                                                                | `6C5DBE28-0A2C-4EB7-82DC-04173DC75418` | en      | `productName`                      | `userName` - el nombre del usuario al que se envía el correo electrónico, `productName` - el nombre del producto, `invitationUri` - el enlace de invitación para crear una cuenta                        |
| Correo electrónico con un enlace para restablecer la contraseña que un usuario solicitó en la página de inicio de sesión de Vantage | `701B077A-20EA-42B8-A71E-AB3EA5996039` | en      | N/A                                | `displayName` - nombre para mostrar opcional proporcionado durante el registro, `callbackUrl` - el enlace para restablecer la contraseña, `expireHours` - el número de horas hasta que el enlace caduque |
| Correo electrónico sobre la exportación correcta de una skill a una carpeta compartida                                              | `B5A03F64-B982-49C6-B336-251CA6C45FFE` | en      | N/A                                | `userName` - la dirección de correo electrónico del usuario, `skillName` - la skill que se está exportando, `folderPath` - la ruta de la carpeta compartida                                              |
| Correo electrónico sobre un error al exportar una skill a una carpeta compartida                                                    | `F3C4BD68-B9FF-439F-A719-5B4F62263C4E` | en      | N/A                                | `userName` - el correo electrónico del usuario, `skillName` - la skill que se está exportando, `errorMessage` - el texto del mensaje de error                                                            |

<div id="modifying-an-email-template">
  ## Modificar un Template de correo electrónico
</div>

Para modificar un Template de correo electrónico, sigue estos pasos:

1. [Obtener acceso al servicio de correo de Vantage](#getting-access-to-the-vantage-mail-service)
2. [Obtener los detalles del Template de correo electrónico](#getting-the-email-template-details)
3. [Actualizar el Template de correo electrónico](#updating-an-email-template)

<div id="getting-access-to-the-vantage-mail-service">
  ## Acceso al servicio de correo de Vantage
</div>

Para acceder al servicio de correo:

1. Acceda a la API del servicio de correo a través de `http://localhost:8080` u otro puerto:

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

Salida de ejemplo de la terminal:

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

<div id="getting-the-email-template-details">
  ## Obtener los detalles de la plantilla de correo electrónico
</div>

Para obtener el marcado de una plantilla de correo electrónico existente, envía una solicitud GET al recurso templates (`http://localhost:8080`) de la siguiente manera:

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

Ejemplo de respuesta:

```json theme={null}
{
  "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"
}
```

<Note>
  La respuesta no incluirá los archivos adjuntos, sino que se agregarán a la plantilla de correo electrónico. Deben especificarse y también pueden modificarse al actualizar la plantilla.
</Note>

<div id="updating-an-email-template">
  ## Actualizar una plantilla de correo electrónico
</div>

Para reemplazar una plantilla de correo electrónico, envía una solicitud PUT al recurso templates:

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

Cuerpo de la solicitud:

```json theme={null}
{
  "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"
    }
  ]
}
```

<div id="template-elements">
  ### Elementos de Template
</div>

| Campo                       | Tipo         | Descripción                                                                                                                                         |
| --------------------------- | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| `templateId`                | GUID         | Identificador de la plantilla de correo electrónico que se va a modificar                                                                           |
| `culture`                   | string       | Idioma de Template. Actualmente, solo se admite inglés (en)                                                                                         |
| `subjectTemplate`           | string       | Plantilla del texto del encabezado del correo electrónico. Consulte la sección anterior para obtener información sobre cómo obtener el valor actual |
| `bodyTemplate`              | string       | Plantilla del cuerpo del correo electrónico. Consulte la sección anterior para obtener información sobre cómo obtener el valor actual               |
| `attachments[].contentType` | string       | Tipo MIME del archivo adjunto (por ejemplo, `image/png`)                                                                                            |
| `attachments[].contentId`   | string       | Identificador único del archivo adjunto                                                                                                             |
| `attachments[].fileName`    | string       | Nombre de archivo del archivo adjunto; puede usarse en el cuerpo como CID                                                                           |
| `attachments[].content`     | base64string | Archivo adjunto codificado en formato base64                                                                                                        |

<Note>
  Los parámetros de las plantillas del asunto y del cuerpo deben permanecer sin cambios. No los agregue, elimine ni modifique.
</Note>

<Note>
  Incluya siempre todos los archivos adjuntos, incluso si no tiene previsto modificarlos. La solicitud reemplaza por completo la plantilla de correo electrónico.
</Note>

<div id="default-attachments">
  ### Archivos adjuntos predeterminados
</div>

Todas las plantillas de correo electrónico de Vantage incluyen estas cuatro imágenes adjuntas:

| CID                            | Tipo MIME | Imagen                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| ------------------------------ | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `logo-vantage-logo-normal.png` | image/png | <img src="https://mintcdn.com/abbyy/fPfipzT-K9Hr52Ze/images/vantage/tenant-admin/logo-vantage.svg?fit=max&auto=format&n=fPfipzT-K9Hr52Ze&q=85&s=3c5d6adea6cb0c60626d6bb935948421" alt="logotipo de ABBYY Vantage" width="159" height="24" data-path="images/vantage/tenant-admin/logo-vantage.svg" /> |
| `600-px-copy-6.png`            | image/png | <img src="https://mintlify.s3.us-west-1.amazonaws.com/abbyy/images/vantage/self-hosted/misc-p01-044.png" alt="Imagen decorativa de encabezado" />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| `16-headset-16@2x.png`         | image/png | <Icon icon="headset" />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| `16-global-outline-16@2x.png`  | image/png | <Icon icon="globe" />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |

<div id="sample-request">
  ### Ejemplo de solicitud
</div>

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

```json theme={null}
{
  "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..."
    }
  ]
}
```

<div id="converting-files-to-base64">
  ### Convertir archivos a Base64
</div>

Para obtener la cadena en base64 que representa un archivo, ejecute el siguiente comando:

```powershell theme={null}
[Convert]::ToBase64String([IO.File]::ReadAllBytes("full path to file"))
```