Notifications Mailgun

Aperçu

• Source: https://www.mailgun.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

Vous pouvez creer un compte gratuitement sur leur site web, mais cette formule comporte des restrictions.

Pour chaque domaine que vous configurez chez eux, vous pourrez tous les retrouver dans votre tableau de bord une fois connecte. Voici un lien direct. Si vous utilisez un compte gratuit, vous pourrez au minimum y voir votre sandbox domain. Depuis cette page, vous pourrez aussi recuperer la cle API associee a chacun des domaines que vous avez configures.

Syntaxe

La syntaxe valide est la suivante :

• mailgun://{user}@{domain}/{apikey}/
• mailgun://{user}@{domain}/{apikey}/{email}/
• mailgun://{user}@{domain}/{apikey}/{email1}/{email2}/{emailN}/

Vous pouvez egalement preciser votre region si vous n’utilisez pas les serveurs americains, comme ceci :

• mailgun://{user}@{domain}/{apikey}/?region=eu

Vous pouvez aussi ajuster le nom associe a l’adresse e-mail From :

• mailgun://{user}@{domain}/{apikey}/?name=Luke%20Skywalker

Extensions d’Adresse Email

Si vous souhaitez utiliser des extensions, vous devrez echapper le caractere plus, +, avec %2B, comme ceci :
mailgun://{user}@{domain}/{apikey}/chris%2Bextension@example.com

Détail des Paramètres

Variable	Obligatoire	Description
apikey	Oui	Cle API associee au domaine depuis lequel vous souhaitez envoyer votre e-mail. Elle est disponible apres connexion a leur site web et acces au tableau de bord.
domain	Oui	Domaine depuis lequel vous souhaitez envoyer votre e-mail ; ce domaine doit etre enregistre et configure dans votre compte Mailgun.
user	Oui	L’utilisateur est associe au domaine precise dans l’URL afin de composer l’adresse e-mail From que vos destinataires verront.
email	Non	Vous pouvez specifier autant d’adresses e-mail que vous le souhaitez. Chaque adresse indiquee representera le champ To. Remarque : selon la configuration de votre compte, Mailgun peut restreindre l’envoi vers certaines adresses.
region	Non	Identifie la region du serveur auquel vous souhaitez acceder. Les options prises en charge sont eu et us. La valeur par defaut est us si rien n’est precise. Cela determine specifiquement quel serveur API sera utilise pour envoyer vos e-mails.
name	Non	Permet de definir le nom associe a l’adresse e-mail From lors de l’envoi de votre e-mail.
to	Non	Alias de la variable email. Vous pouvez enchainer autant d’adresses, To, que vous le souhaitez en les separant par des virgules et/ou des espaces.
cc	Non	Identifie les adresses a notifier en copie, Carbon Copy.
bcc	Non	Identifie les adresses a notifier en copie cachee, Blind Carbon Copy.

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 Mailgun a l’adresse e-mail bill.gates@microsoft.com

# Supposons que le {domain} configure dans notre compte Mailgun soit example.com
# Supposons que notre {apikey} soit 4b4f2918fd-dk5f-8f91f
# Supposons que notre {email} To soit bill.gates@microsoft.com
# Supposons que nous voulions envoyer depuis noreply@example.com
apprise -vv -t "Email Subject" -b "Message Corps du Message" \
   mailgun:///noreply@example.com/4b4f2918fd-dk5f-8f91f/bill.gates@microsoft.com