Aller au contenu

Notifications Postmark

Aperçu

Postmark est un service de livraison d’e-mails transactionnels avec une API HTTP JSON. Pour l’utiliser avec Apprise :

  1. Rendez-vous sur https://account.postmarkapp.com/ et connectez-vous (ou créez un compte).
  2. Créez un Serveur (ou sélectionnez-en un existant) depuis le tableau de bord Postmark.
  3. Dans les paramètres du serveur, cliquez sur API Tokens dans la barre latérale gauche.
  4. Copiez le Server API Token affiché sur cette page. Ce jeton est utilisé comme APIToken dans votre URL Apprise.
  5. Assurez-vous que votre adresse d’expédition est vérifiée. Rendez-vous sur Sender Signatures et ajoutez votre domaine d’envoi ou une adresse d’expéditeur spécifique. Postmark rejettera les e-mails provenant d’expéditeurs non vérifiés.

La syntaxe valide est la suivante :

  • postmark://{APIToken}:{FromEmail}
  • postmark://{APIToken}:{FromEmail}/{ToEmail}
  • postmark://{APIToken}:{FromEmail}/{ToEmail1}/{ToEmail2}/{ToEmailN}
VariableRequisDescription
APIToken*OuiLe Server API Token trouvé sur la page API Tokens de votre serveur Postmark.
FromEmail*OuiUne adresse e-mail ou un domaine d’expéditeur vérifié. Postmark rejette les e-mails provenant d’expéditeurs non vérifiés.
ToEmailNonUne ou plusieurs adresses e-mail destinataires placées dans le chemin URL. Si omis, la notification est envoyée à FromEmail.
toNonDestinataires supplémentaires sous forme de liste séparée par des virgules (?to=a@example.com,b@example.com).
nameNonNom d’affichage de l’expéditeur (?name=Alice).
ccNonDestinataires en copie, séparés par des virgules (?cc=cc@example.com). Les destinataires nommés sont pris en charge : ?cc=Alice<cc@example.com>.
bccNonDestinataires en copie cachée, séparés par des virgules (?bcc=bcc@example.com).
replyNonAdresse de réponse, avec nom d’affichage optionnel (?reply=support@example.com ou ?reply=Support<support@example.com>).
formatNonRemplace le format du corps par défaut. Définissez text pour envoyer du texte brut au lieu de HTML.
VariableDescription
overflowCe 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.
formatCe 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é.
verifyLes 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.
ctoSignifie 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.
rtoSignifie 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.
emojisActive 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.
tzIdentifie 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.

Envoyer une notification de base à soi-même (expéditeur et destinataire identiques) :

Fenêtre de terminal
apprise -vv -t "Titre de Test" -b "Message de Test" \
postmark://APIToken:user@example.com

Envoyer depuis une adresse vers un destinataire unique :

Fenêtre de terminal
apprise -vv -t "Deploiement Termine" -b "La publication s'est terminee avec succes." \
postmark://APIToken:alerts@example.com/ops@example.com

Envoyer a plusieurs destinataires avec CC, BCC et un nom d’expéditeur personnalisé :

Fenêtre de terminal
apprise -vv -t "Rapport d'Incident" -b "Voir les journaux ci-joints pour plus de details." \
"postmark://APIToken:alerts@example.com/oncall@example.com/dev@example.com?cc=lead@example.com&bcc=manager@example.com&name=Systeme+d+Alertes"

Envoyer avec une pièce jointe :

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

Envoyer en texte brut au lieu de HTML :

Fenêtre de terminal
apprise -vv -t "Alerte Texte Brut" -b "Quelque chose s'est produit." \
"postmark://APIToken:user@example.com?format=text"
Questions ou commentaires ?

Documentation

Vous avez repéré une faute de frappe ou une erreur ? Signalez-la ou proposez une correction .

Problèmes Techniques

Vous rencontrez un problème avec le code ? Ouvrez un ticket sur GitHub :

Conçu avec amour depuis le Canada