Notifications SendGrid

Aperçu

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

La creation d’un compte SendGrid est gratuite et peut se faire depuis leur page principale.

Une fois votre compte cree et l’acces a votre tableau de bord obtenu, vous devez vous assurer d’avoir correctement authentifie vos domaines chez eux. Cette operation se fait dans la section Sender Authentication de votre tableau de bord, accessible via Settings > Sender Authentication.

La derniere etape consiste a generer une API Key disposant au minimum de la permission Mail Send. Cela peut egalement etre fait depuis la section API Keys de votre tableau de bord, accessible via Settings > API Keys.

Syntaxe

La syntaxe valide est la suivante :

• sendgrid://{apikey}:{from_email}
• sendgrid://{apikey}:{from_email}/{to_email}
• sendgrid://{apikey}:{from_email}/{to_email1}/{to_email2}/{to_email3}

La prise en charge des modeles est egalement disponible. Il vous suffit d’indiquer dans l’URL l’UUID qui lui a ete assigne :

• sendgrid://{apikey}:{from_email}/{to_email}?template={template_uuid}

Si vous souhaitez tirer parti des variables dynamic_template_data, creez simplement des arguments prefixes par un plus, +, par exemple :

• sendgrid://{apikey}:{from_email}/{to_email}?template={template_uuid}&+{sub1}=value&+{sub2}=value2

Détail des Paramètres

Variable	Obligatoire	Description
apikey	Oui	API Key que vous avez generee depuis votre tableau de bord SendGrid.
from_email	Oui	Adresse e-mail identifiant l’origine du message, c’est-a-dire l’adresse From. Cette adresse doit appartenir a un domaine deja authentifie avec votre compte SendGrid, voir Domain Authentication.
to_email	Non	Adresse e-mail identifiant la destination du message, c’est-a-dire l’adresse To. Si aucune valeur n’est fournie, from_email est utilise a la place.
template	Non	Vous pouvez facultativement specifier l’UUID d’un modele dynamique SendGrid deja genere comme base pour l’e-mail.
cc	Non	Partie Carbon Copy, CC:, de l’e-mail. Elle est entierement facultative. Il faut noter que SendGrid rejette immediatement les e-mails dont la liste cc contient une adresse deja presente dans les listes to ou bcc. Pour eviter ces problemes, Apprise elimine automatiquement et silencieusement ces doublons lorsqu’ils sont detectes.
bcc	Non	Partie Blind Carbon Copy, BCC:, de l’e-mail. Elle est entierement facultative. Il faut noter que SendGrid rejette immediatement les e-mails dont la liste bcc contient une adresse deja presente dans les listes to ou cc. Pour eviter ces problemes, Apprise elimine automatiquement et silencieusement ces doublons lorsqu’ils sont detectes. Si une meme adresse est detectee a la fois dans CC et BCC, elle est conservee dans BCC et supprimee automatiquement de CC.

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.
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é. L’appel global notify() retourne quand même True 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.

Données de Modèle Dynamiques

Les modeles vous permettent de definir des {{variables}} qui seront remplacees dynamiquement lors de l’envoi de l’e-mail. Vous pouvez identifier et definir ces variables avec Apprise en ajoutant simplement un plus, +, devant n’importe quel parametre precise dans votre URL.

Considerez le modele suivant : d-e624763c71314ea2a1fae38d7fa64a4a

This is a test email about {{what}}.

You can take a mapped variable on a SendGrid template
and easily swap it with whatever you want using {{app}}.

Dans l’exemple ci-dessus, nous avons defini les variables suivantes : what et app.

Une URL Apprise peut ressembler a ceci :
sendgrid://myapikey:noreply@example.com?template=d-e624763c71314ea2a1fae38d7fa64a4a&+what=templates&+app=Apprise

L’URL ci-dessus produirait le resultat suivant :

This is a test email about templates.

You can take a mapped variable on a SendGrid template
and easily swap it with whatever you want using Apprise.

Exemples

Envoyer une notification SendGrid :

# Supposons que notre {apikey} soit abcd123-xyz
# Supposons que notre domaine authentifie soit example.com, et que nous voulions
# definir notre {from_email} sur noreply@example.com
# Supposons que notre {to_email} soit someone@microsoft.com
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   sendgrid:///abcd123-xyz:noreply@example.com/someone@microsoft.com