Aller au contenu

Notifications SendPulse

Aperçu

Une fois votre compte cree et l’acces a votre tableau de bord obtenu, vous devrez recuperer votre Client ID et votre Client Secret afin de construire les URL Apprise.

La syntaxe valide est la suivante :

  • sendpulse://{user}@{host}/{client_id}/{client_secret}
  • sendpulse://{user}@{host}/{client_id}/{client_secret}/{to_email}
  • sendpulse://{user}@{host}/{client_id}/{client_secret}/{to_email1}/{to_email2}/{to_email3}

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

  • sendpulse://{user}@{host}/{client_id}/{client_secret}/{to_email}?template={template_int}

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

  • sendpulse://{user}@{host}/{client_id}/{client_secret}/{to_email}?template={template_int}&+{sub1}=value&+{sub2}=value2
VariableObligatoireDescription
userOuiCombine a host, il construit l’adresse e-mail configuree avec votre compte SendPulse.
hostOuiCombine a user, il construit l’adresse e-mail configuree avec votre compte SendPulse.
client_idOuiClient ID associe a votre compte SendPulse.
client_secretOuiClient Secret associe a votre compte SendPulse.
fromNonPermet facultativement de definir l’expediteur de l’e-mail.
to_emailNonAdresse e-mail identifiant la destination du message, c’est-a-dire l’adresse To. Si aucune valeur n’est fournie, l’adresse de l’expediteur est utilisee a la place.
templateNonVous pouvez facultativement specifier l’entier identifiant un modele SendPulse deja genere comme base pour l’e-mail.
ccNonPartie Carbon Copy, CC:, de l’e-mail. Elle est entierement facultative.
bccNonPartie Blind Carbon Copy, BCC:, de l’e-mail. Elle est entierement facultative.

Apprise prend en charge les modeles SendPulse. Il suffit de definir ?template= ainsi que les arguments facultatifs que vous souhaitez transmettre. Vous pouvez identifier et definir ces variables dans Apprise en ajoutant simplement un plus, +, devant tout parametre precise dans votre URL.

Considerez le modele suivant : 1234

Une URL Apprise peut ressembler a ceci :
sendpulse://user@example.com?template=1234&+what=templates&+app=Apprise

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 SendPulse :

Fenêtre de terminal
# Supposons que notre {user} soit user@example.com
# Supposons que notre {client_id} soit client_id
# Supposons que notre {client_secret} soit client_secret
# Supposons que nous voulions envoyer un e-mail a target@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" \
sendpulse:///user@example.com/client_id/client_secret/target@example.com
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