Notifications MailerSend

Aperçu

• Source: https://www.mailersend.com
• Prise en charge des images: Non
• Prise en charge des pièces jointes: Oui
• Limites de caractères des messages:
  • Corps: 32768
• Format(s) de message pris en charge:
  • ✓HTML
  • TEXT
• Créer votre URL Apprise

Configuration du Compte

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

1. Rendez-vous sur https://www.mailersend.com/ et connectez-vous ou créez un compte gratuit.
2. Accédez à Settings -> API Tokens et cliquez sur Create Token. Donnez-lui un nom et accordez au moins la permission Email (envoi). Copiez le jeton généré : il s’agit de votre APIToken.
3. Vérifiez un domaine d’envoi dans Email -> Domains, ou ajoutez au moins une adresse d’expéditeur vérifiée. L’adresse From Email utilisée dans Apprise doit appartenir à un domaine vérifié dans MailerSend, sinon l’API rejettera la requête.
4. Construisez votre URL mailersend:// à l’aide de la syntaxe ci-dessous et ajoutez-la à votre configuration Apprise.

---

Syntaxe

La syntaxe valide est la suivante :

• Expéditeur unique, destinataire par défaut (envoi à soi-même) :

  • mailersend://APIToken:FromEmail

• Destinataire(s) explicite(s) :

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

• Destinataires supplémentaires et options dans la chaîne de requête :

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

Détail des Paramètres

Variable	Requis	Description
APIToken	Oui	Votre jeton API MailerSend avec au moins la permission d’envoi d’e-mails.
FromEmail	Oui	Adresse d’expéditeur vérifiée. Elle doit appartenir à un domaine vérifié dans MailerSend.
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.
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	Adresse e-mail de réponse (Reply-To).
format	Non	MailerSend envoie du HTML par défaut. Définissez cette valeur sur text pour envoyer un message en texte brut.

Paramètres Globaux

Variable	Description
overflow	Gère les messages qui dépassent la limite documentée d’un service. La valeur par défaut est upstream. 👉 upstream : envoie un seul message sans le découper ni le tronquer selon cette limite. 👉 truncate : conserve la partie qui tient dans la limite et supprime le reste. 👉 split : privilégie une coupure lisible, utilise une coupure stricte si nécessaire, puis envoie toutes les parties dans l’ordre. Le découpage d’un contenu non déclaré ou structuré reste une solution au mieux. Utilisez upstream si le corps doit rester intact.
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.
redirect	Par défaut, Apprise suit les redirections HTTP (réponses 3xx) émises par le serveur distant, conformément au comportement de la bibliothèque requests sous-jacente. Si vous souhaitez empêcher la transmission des en-têtes personnalisés et des identifiants vers des destinations différentes de l’URL d’origine, définissez cette option sur no. Par défaut, elle 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.
retry	Nombre de tentatives de remise supplémentaires après le premier échec, avant d’abandonner. Accepte un entier compris entre 0 et 10. La valeur par défaut est 0 (aucune nouvelle tentative — une seule tentative est effectuée). Lorsqu’il est combiné avec wait, Apprise marque une pause du nombre de secondes spécifié entre chaque tentative.
wait	Nombre de secondes à attendre entre les nouvelles tentatives. Accepte une valeur décimale comprise entre 0.0 et 20.0 ; les entiers sont automatiquement convertis en virgule flottante. La valeur par défaut est 0.5. Ce paramètre n’est utile que si retry est supérieur à zéro — un service avec retry=0 effectue exactement une tentative, quelle que soit la valeur de wait.
optional	Lorsqu’il est défini sur yes, un échec de remise pour ce service est silencieusement absorbé. Le résultat global de notify() est quand même considéré comme réussi même si ce point de terminaison était injoignable, à condition que tous les services requis (non optionnels) du même lot aient réussi. Ce drapeau ne saute pas la remise ni ne contourne la logique de nouvelles tentatives — toutes les tentatives configurées sont effectuées avant que l’échec soit absorbé. Par défaut, il vaut no, ce qui signifie que chaque échec est propagé à l’appelant.

Exemples

Envoyer une notification MailerSend simple à vous-même (From et To identiques) :

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

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

apprise -vv -t "Déploiement terminé" -b "La publication s'est terminée avec succès." \
    mailersend://APIToken:expediteur@example.com/destinataire@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 détails." \
   "mailersend://APIToken:alertes@example.com/oncall@example.com?to=dev1@example.com,dev2@example.com&cc=teamlead@example.com&bcc=manager@example.com&reply=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 \
   mailersend://APIToken:rapports@example.com/destinataire@example.com