Notifications Brevo

Aperçu

• Source: https://www.brevo.com
• Prise en charge des images: Non
• Prise en charge des pièces jointes: Oui
• Limites de caractères des messages:
  • Corps: 32768
• Créer votre URL Apprise

Configuration du Compte

Brevo est une plateforme d’e-mail transactionnel qui expose une API HTTP JSON pour l’envoi de messages. Le plugin NotifyBrevo intègre cette API à Apprise avec un schéma d’URL cohérent avec d’autres fournisseurs d’e-mail comme SendGrid et Resend.

1. Rendez-vous sur https://www.brevo.com/ et connectez-vous à votre compte Brevo.
2. Accédez à SMTP & API dans votre compte, puis créez une Transactional email API key avec la permission d’envoyer des e-mails.
3. Copiez la API key générée. Elle sera utilisée comme partie APIToken de votre URL Apprise.
4. Assurez-vous d’avoir au moins une adresse d’expéditeur vérifiée, ou un domaine d’envoi authentifié, configuré dans Brevo. L’adresse From Email utilisée dans Apprise doit être un expéditeur valide, sinon Brevo rejettera la requête.
5. Construisez votre URL brevo:// à l’aide de la syntaxe ci-dessous, en remplaçant la clé API, l’adresse d’expédition et les destinataires cibles.
6. Utilisez cette URL dans votre fichier de configuration Apprise ou dans vos appels CLI.

⚠️ Brevo peut vous envoyer un e-mail de confirmation, subject: Security Alert: Verify a new IP, indiquant que Someone tried to use your organization account and make an API call with an IP address you have never used before. We wanted to check this activity with you.. Vous devrez alors utiliser le lien de confirmation pour approuver l’adresse IP concernée. À partir de ce moment, Apprise devrait fonctionner sans interruption.

---

Syntaxe

La syntaxe valide est la suivante :

• Expéditeur unique, destinataire par défaut, auto-notification. Notez que le champ From Email doit déjà être un Verified Sender chez Brevo pour que cette syntaxe fonctionne.

  • brevo://APIToken:FromEmail

• Destinataires explicites :

  • brevo://APIToken:FromEmail/ToEmail
  • brevo://APIToken:FromEmail/ToEmail1/ToEmail2/ToEmailN

• Paramètres supplémentaires :

  • ?to=extra1@example.com,extra2@example.com
  • ?cc=cc1@example.com,cc2@example.com
  • ?bcc=bcc1@example.com,bcc2@example.com
  • ?reply=Reply Name <reply@example.com>

Le modèle d’URL du plugin est :

• brevo://{apikey}:{from_email}
• brevo://{apikey}:{from_email}/{targets}

Détail des Paramètres

Variable	Requis	Description
APIToken	Oui	Clé API transactionnelle Brevo, valeur de l’en-tête api-key.
FromEmail	Oui	Adresse e-mail d’expéditeur vérifiée dans Brevo, sender.email.
ToEmail	Non	Une ou plusieurs adresses e-mail destinataires dans le chemin URL.
to	Non	Destinataires supplémentaires sous forme de liste séparée par des virgules dans la chaîne de requête.
cc	Non	Destinataires en copie, séparés par des virgules.
bcc	Non	Destinataires en copie cachée, séparés par des virgules.
reply	Non	En-tête Reply-To, facultativement avec un nom d’affichage.
format	Non	Remplace le format par défaut, html ou text, de manière cohérente avec le noyau Apprise.

Paramètres Globaux

Variable	Description
overflow	Ce paramètre peut être défini sur split, truncate ou upstream. Il détermine la manière dont Apprise remet le message que vous lui transmettez. Par défaut, il vaut upstream. 👉 upstream : ne fait aucune modification et transmet le message exactement tel qu’il a été reçu au service. 👉 truncate : veille à ce que le message tienne dans la limite amont documentée par le service. Si plus d’informations sont fournies que la limite définie, l’excédent est tronqué. 👉 split : similaire à truncate, sauf que si le message dépasse la limite amont documentée par le service, il est découpé en plusieurs morceaux plus petits puis envoyés séquentiellement.
format	Ce paramètre peut être défini sur text, html ou markdown. Certains services prennent en charge plusieurs formats de publication du contenu. La valeur par défaut varie selon le service choisi et peut correspondre à l’un de ces trois formats. Vous pouvez facultativement forcer cette option pour vous écarter du comportement par défaut. Si le service ne prend pas en charge plusieurs formats de transmission, ce champ est ignoré.
verify	Les requêtes externes vers des emplacements sécurisés, par exemple via https, utilisent des certificats. Par défaut, Apprise vérifie la validité de ces certificats ; si ce n’est pas le cas, aucune notification n’est envoyée à la source. Dans certains cas, un utilisateur ne dispose pas d’une autorité de certification pour valider la clé ou fait simplement confiance à la source ; dans ce cas, vous pouvez définir ce drapeau sur no. Par défaut, il vaut yes.
cto	Signifie Socket Connect Timeout. Il s’agit du nombre de secondes pendant lesquelles Requests attend que votre client établisse une connexion avec une machine distante, ce qui correspond à l’appel connect() sur la socket. La valeur par défaut est de 4.0 secondes.
rto	Signifie Socket Read Timeout. Il s’agit du nombre de secondes pendant lesquelles le client attend que le serveur envoie une réponse. La valeur par défaut est de 4.0 secondes.
emojis	Active la prise en charge des emojis, par exemple :+1: qui sera traduit en 👍. Par défaut, cette option vaut no. Remarque : selon la configuration côté serveur, l’administrateur peut désactiver globalement la prise en charge des emojis ; mais par défaut, ce n’est pas le cas.
tz	Identifie le fuseau horaire de la base IANA que vous souhaitez utiliser. Par défaut, celui-ci est détecté à partir de la configuration du serveur qui exécute Apprise. Vous pouvez le définir sur des valeurs comme America/Toronto, ou sur tout autre fuseau correctement formaté correspondant à votre région.

Exemples

Envoyer une notification Brevo simple à vous-même, From et To identiques :

apprise -vv -t "Titre de Test" -b "Message de Test" \
   brevo://APIToken:user@example.com

Envoyer un e-mail de user@example.com à un destinataire unique :

apprise -vv -t "Deploiement Termine" -b "La publication s'est terminee avec succes." \
    brevo://APIToken:user@example.com/ops@example.com

Envoyer à plusieurs destinataires avec CC, BCC et un en-tête Reply-To :

apprise -vv -t "Rapport d'Incident" -b "Voir les journaux ci-joints pour plus de details." \
   "brevo://APIToken:alerts@example.com/oncall@example.com?to=dev1@example.com,dev2@example.com&cc=teamlead@example.com&bcc=manager@example.com&reply=Support%20Desk%20<support@example.com>"

Envoyer avec une pièce jointe :

apprise -vv -t "Rapport Nocturne" -b "Le dernier rapport est joint." \
   --attach /path/to/report.pdf   \
   brevo://APIToken:reports@example.com/recipient@example.com