Lister les templates d’email

GET /api/email/templates

Liste les templates d’email.

En-têtes de requête:

• Authorization – Les identifiants de l’utilisateur.

Paramètres:

• limit (int) – Le nombre maximum de résultats souhaités (défaut: 20)

• offset (int) – Le numéro du premier résultat souhaité (défaut: 0)

• sortby ([name+|name-]) – Le paramètre selon lequel les règles seront triées (défaut: name+)

Status Codes:

• 200 OK – La liste de template a été renvoyée avec succès.

• 400 Bad Request – Requête invalide.

• 401 Unauthorized – Authentification d’utilisateur invalide.

Tableau d’objets JSON de réponse:

• name (string) – Le nom du template.

• subject (string) – Le sujet de l’email.

• mimeType (string) – Le type MIME de l’email. Typiquement soit « text/plain » ou « text/html ».

• body (string) – Le template du corps de l’email.

• attachments (array) – La liste des fichiers à joindre à l’email.

Exemple de requête

GET https://my_waarp_transfer.net/api/email/templates HTTP/1.1
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==

Exemple de réponse

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 731

[{
  "name": "alerte_erreur",
  "subject": "Alerte erreur de transfert",
  "mimeType": "text/plain",
  "body": "!! ALERTE !!

    Le transfert n°#TRANSFERID# du fichier #TRUEFILENAME#
    a échoué le #DATE# à #HOUR#
    avec le code #ERRORCODE# et le message \"#ERRORMSG#\".

    Waarp",
  "attachments": ["transfer.log"]
}, {
  "name": "notif_fin_transfert",
  "subject": "Notification de fin de transfer",
  "mimeType": "text/plain",
  "body": "Notification:

    Le transfert n°#TRANSFERID# du fichier #TRUEFILENAME#
    s'est terminé sans erreur le #DATE# à #HOUR#.

    Waarp"
}]