Documentation en ligne

Envoyer un courriel

Généralités

Comme son nom l'indique, l'action « Courriel » a pour effet d'envoyer d'un courriel.

Édition

Les étapes d'édition de l'action « Courriel » sont les suivantes :

  1. Pointer, au sein de la liste déroulante une fonction destinée à recevoir le message. Un envoi multi-destinataires est possible en cliquant sur « Ajouter un rôle » ;
  2. Saisir le « Sujet » du courriel, qui peut comporter des variables selon la syntaxe des templates ;
  3. Saisir le « Corps » du courriel. Le corps de l'email, en texte brut, peut comporter des variables et des conditions d'affichage décrites dans la syntaxe des templates ;
  4. Il est possible d'optimiser la mise en forme du message

L'envoi à une adresse spécifique est également possible après choix « Autre : » situé à la fin de la liste du choix du destinataire. Il est possible d'indiquer directement une adresse, ou d'utiliser un template (par exemple {{form_var_destinataire}}).

Il est possible d'inclure dans un courriel une commande afin d'afficher un bouton d'action au sein du courriel dans le but de provoquer un « Saut manuel » dans le cours du workflow, pour ceci se référer au descriptif de l'action « Saut manuel ».

Envoi d'un courriel à l'usager demandeur

Lorsque l'action est paramétrée pour envoyer un courriel à l'usager, c'est-à-dire au demandeur de la démarche, l'adresse de destination utilisée est :

  • soit le courriel saisi dans le formulaire, dans le premier champ « courriel » avec pré-remplissage depuis le champ utilisateur courriel ;
  • soit le courriel renseigné dans le profil du compte si le champ n'est pas renseigné.

Il est donc important de prévoir un champ « courriel » avec pré-remplissage pour les formulaires pouvant être complétés sans compte usager.

D'une façon générale, il est préférable de toujours afficher un tel champ « courriel » dans les formulaires afin de signaler au demandeur qu'il sera informé de la suite du traitement de sa demande au travers de cette adresse. Il pourra, à ce moment de la saisie, corriger cette adresse le cas échéant.

Ajout de fichiers attachés

Si le workflow dispose de champs de traitement de type fichiers, alors ils sont sélectionnables en dessous du corps du message, pour être envoyés en tant que fichiers attachés au message. Il est possible d'en sélectionner plusieurs, en cliquant sur « Ajouter un fichier attaché ».

Si le workflow ne dispose d'aucun champ de traitement de type fichier, alors cette possibilité est cachée dans les paramètres supplémentaires (visibles en cliquant sur la ligne « + »). Il faut alors indiquer les fichiers attachés sous forme de variables, plus exactement sous forme d'expressions en langage Python qui doivent représenter des fichiers. Cela sera :

  • form_var_identifiantdufichier_raw pour un fichier du formulaire dont l'identifiant est «identifiantdufichier»; on préférera éventuellement la forme vars().get('form_var_identifiantdufichier_raw') afin que cela fonctionne même si la variable n'existe pas
  • form_attachments.identifiantdufichier pour un fichier ajouté par les actions « Créer un document » ou «  Fichier joint ». Là aussi, si on n'est pas sûr que le fichier existe, on utilisera du code Python à tolérance de panne : getattr(vars().get('form_attachments'), 'identifiantdufichier', None). Si le fichier n'a pas été joint à l'historique, il n'est pas disponible directement, il faut passer par une donnée de traitement.

Mettre des « boutons d'action » dans un courriel

Il est possible d'insérer, dans un courriel envoyé, des boutons d'action, c'est-à-dire des boutons qui apparaîtront dans le corps du message et permettront au lecteur de réaliser une action en cliquant dessus. Pour insérer, par exemple, un bouton « Valider », on mettra dans le modèle du courriel :

{% action_button "terminer" label="Valider" delay=7 %}

Dans cet exemple, « terminer » désigne l'identifiant d'une action de saut manuel (il faut donc mettre un identifiant sur cette action au préalable) pointant vers le statut Terminer.

« delay » est facultatif est indique une durée de validité en jour. Si ce paramètre n'est pas présent, le bouton expire après trois jours.

Nota : si vous déclarez plusieurs boutons sur la même ligne, ceux-ci seront affichés verticalement et non pas côte à côte.

Optimiser la mise en forme du message

Le message est saisi sous forme de texte brut. Il sera transformé en format HTML. Il est également possible d'utiliser le langage ReStructuredText pour améliorer la mise en forme.

Saut de ligne

Pour forcer le saut de ligne, il suffit de laisser une ligne vide entre deux parties de texte. Vous obtenez alors 2 paragraphes distincts, séparés par une ligne vide.

Si vous souhaitez avoir un retour à la ligne sans ligne vide, utilisez le symbole | (avec une ligne vide au-dessus et en dessous du paragraphe concerné) :

| ce texte
| apparaîtra sur plusieurs lignes
| même s'il n'y a pas de lignes vides pour marquer le retour à la ligne.

 

Gras et italique

Mettre un texte entre 2 asterisques le rendra en italique, entre 4 asterisques le rendra en gras.

*italique* => italique

**gras** => gras

Titres

Il faut souligner le texte d'un titre pour le mettre en forme.

titre de niveau 1
=================

titre de niveau 2
-----------------

Hyperliens

Les url seront automatiquement traduites en liens, comme http://www.test.fr

Pour donner un libellé autre qu'une URL à un lien, il faut utiliser la syntaxe suivante

Ceci est un `lien vers le site d'Entr'ouvert <https://www.entrouvert.com/>`_.

qui donnera :

Ceci est un lien vers le site d'Entr'ouvert.

Listes

Le schéma suivant :

* une liste
 - sous liste item 1
  + sous sous liste
  + sous sous liste 2
  + sous sous liste 3
 - sous liste item 2
* ensuite
 - autre sous liste 
* enfin

donnera

  • une liste
    • sous liste item 1
      • sous sous liste
      • sous sous liste 2
      • sous sous liste 3
    • sous liste item 2
  • ensuite
    • autre sous liste
  • enfin

Il est également possible d'utiliser une liste numérotée :

1. premièrement...
2. deuxièmement...
3. troisièmement...

Pour les listes ou les titres, il doit y avoir un saut de ligne au-dessus et en dessous du texte concerné pour que la mise en forme soit effective.

Dernière mise à jour le 3 juillet 2019 15:13 — Éditer