> ## 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.

# Modèles d'e-mail

> Personnalisez les modèles d'e-mail envoyés aux utilisateurs par la version auto-hébergée d'ABBYY Vantage, notamment l'objet, le corps du message et les paramètres du modèle, afin de refléter l'identité visuelle de votre entreprise.

Les e-mails par défaut envoyés par Vantage contiennent des informations propres à ABBYY, telles que les adresses e-mail du support client d'ABBYY, les mentions RGPD d'ABBYY et des pieds de page portant les mentions de copyright d'ABBYY. Vous pouvez modifier les modèles de ces e-mails pour y inclure vos propres informations et les adapter à votre entreprise.

<div id="available-email-templates">
  ## Modèles d’e-mail disponibles
</div>

Vantage propose les modèles d’e-mail suivants :

| Modèle d’e-mail                                                                                                         | ID                                     | Culture | Paramètres du modèle d’objet | Paramètres du modèle de corps                                                                                                                                                                               |
| ----------------------------------------------------------------------------------------------------------------------- | -------------------------------------- | ------- | ---------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| E-mail d’invitation envoyé à l’administrateur du tenant d’un tenant nouvellement créé                                   | `E6F03F64-B982-49C6-B336-251CA6C45FFE` | en      | `productName`                | `userName` - le nom de l’utilisateur auquel l’e-mail est envoyé, `productName` - le nom du produit, `invitationUri` - le lien d’invitation permettant de créer un compte                                    |
| E-mail d’invitation envoyé au tenant nouvellement créé                                                                  | `6C5DBE28-0A2C-4EB7-82DC-04173DC75418` | en      | `productName`                | `userName` - le nom de l’utilisateur auquel l’e-mail est envoyé, `productName` - le nom du produit, `invitationUri` - le lien d’invitation permettant de créer un compte                                    |
| E-mail contenant un lien de réinitialisation du mot de passe demandé par un utilisateur sur la page de login de Vantage | `701B077A-20EA-42B8-A71E-AB3EA5996039` | en      | N/A                          | `displayName` - nom d’affichage facultatif fourni lors de l’inscription, `callbackUrl` - le lien permettant de réinitialiser le mot de passe, `expireHours` - le nombre d’heures avant l’expiration du lien |
| E-mail concernant l’exportation réussie d’une compétence vers un dossier partagé                                        | `B5A03F64-B982-49C6-B336-251CA6C45FFE` | en      | N/A                          | `userName` - l’adresse e-mail de l’utilisateur, `skillName` - la compétence en cours d’exportation, `folderPath` - le chemin du dossier partagé                                                             |
| E-mail concernant l’échec de l’exportation d’une compétence vers un dossier partagé                                     | `F3C4BD68-B9FF-439F-A719-5B4F62263C4E` | en      | N/A                          | `userName` - l’adresse e-mail de l’utilisateur, `skillName` - la compétence en cours d’exportation, `errorMessage` - le corps du message d’erreur                                                           |

<div id="modifying-an-email-template">
  ## Modifier un modèle d’e-mail
</div>

Pour modifier un modèle d’e-mail, suivez ces étapes :

1. [Accéder au Vantage Mail Service](#getting-access-to-the-vantage-mail-service)
2. [Obtenir les détails du modèle d’e-mail](#getting-the-email-template-details)
3. [Mettre à jour le modèle d’e-mail](#updating-an-email-template)

<div id="getting-access-to-the-vantage-mail-service">
  ## Accéder au service Vantage Mail Service
</div>

Pour accéder au Vantage Mail Service :

1. Accédez à l’API du Vantage Mail Service via `http://localhost:8080` ou un autre port :

```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
```

Exemple de sortie du terminal :

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

<div id="getting-the-email-template-details">
  ## Récupérer les détails du modèle d’e-mail
</div>

Pour récupérer le balisage d’un modèle d’e-mail existant, envoyez une requête GET à la ressource templates (`http://localhost:8080`) comme suit :

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

Exemple de réponse :

```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 réponse ne contiendra pas les pièces jointes, celles-ci étant plutôt placées dans le modèle d’e-mail. Elles doivent être spécifiées et peuvent également être modifiées lors de la mise à jour du modèle.
</Note>

<div id="updating-an-email-template">
  ## Mise à jour d’un modèle d’e-mail
</div>

Pour remplacer un modèle d’e-mail, envoyez une requête PUT à la ressource templates :

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

Corps de la requête :

```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">
  ### Éléments du Template
</div>

| Champ                       | Type         | Description                                                                                                        |
| --------------------------- | ------------ | ------------------------------------------------------------------------------------------------------------------ |
| `templateId`                | GUID         | Identifiant du modèle d’e-mail à modifier                                                                          |
| `culture`                   | string       | Langue du Template. Actuellement, seul l’anglais (`en`) est pris en charge                                         |
| `subjectTemplate`           | string       | Template du texte d’en-tête de l’e-mail. Voir la section précédente pour savoir comment obtenir la valeur actuelle |
| `bodyTemplate`              | string       | Template du corps de l’e-mail. Voir la section précédente pour savoir comment obtenir la valeur actuelle           |
| `attachments[].contentType` | string       | Type MIME de la pièce jointe (par exemple, `image/png`)                                                            |
| `attachments[].contentId`   | string       | Identifiant unique de la pièce jointe                                                                              |
| `attachments[].fileName`    | string       | Nom du fichier de la pièce jointe ; peut être utilisé dans le corps comme CID                                      |
| `attachments[].content`     | base64string | Fichier de pièce jointe encodé au format base64                                                                    |

<Note>
  Les paramètres des templates du sujet et du corps doivent rester inchangés. Ne les ajoutez pas, ne les supprimez pas et ne les modifiez pas.
</Note>

<Note>
  Incluez toujours toutes les pièces jointes, même si vous n’avez pas l’intention de les modifier. La requête remplace entièrement le modèle d’e-mail.
</Note>

<div id="default-attachments">
  ### Pièces jointes par défaut
</div>

Chaque modèle d’e-mail Vantage contient ces quatre images en pièce jointe :

| CID                            | Type MIME | Image                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| ------------------------------ | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `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="logo 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="image d’en-tête décorative" />                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| `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">
  ### Exemple de requête
</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">
  ### Conversion de fichiers au format Base64
</div>

Pour obtenir la représentation d’un fichier sous forme de chaîne Base64, exécutez la commande suivante :

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