Soumission par mail

Soumission par mail
Guide de mise en place
Version 1.2 - 18/09/2012
Pages : 2 de 16
Table des Matières
1. Contexte..................................................................................................................4
2. Vocabulaire...............................................................................................................4
3. Lancement d'une procédure AlarmTILT.........................................................................5
3.1 Utilisation...........................................................................................................5
3.2 Format du mail....................................................................................................5
3.2.1 Entêtes........................................................................................................5
3.2.2 Corps du message........................................................................................5
3.2.2.1 Corps de message structuré.....................................................................5
3.2.2.2 Corps de message non-structuré...............................................................6
3.3 Exemple 1: Déclenchement de Procédure sans paramètre particulier..........................6
3.4 Exemple 2: Déclenchement de Procédure avec paramètres.......................................7
3.5 Exemple 3: Déclenchement de procédure avec des destinations................................7
4. Envoi de message à des contacts AlarmTILT.................................................................8
4.1 Utilisation...........................................................................................................8
4.2 Format du mail....................................................................................................8
4.2.1 Entêtes........................................................................................................8
4.2.2 Corps du message........................................................................................8
4.3 Exemple: Envoi d'un message simple.....................................................................9
5. Envoi de message à une adresse externe.....................................................................9
5.1 Utilisation...........................................................................................................9
5.2 Format de mail..................................................................................................10
5.2.1 Entêtes......................................................................................................10
5.2.2 Corps du message.......................................................................................10
5.3 Exemples..........................................................................................................11
5.3.1 Envoi de Notification VOIX (VOICE)...............................................................11
5.3.2 Envoi de notification EMAIL..........................................................................11
5.3.3 Envoi de Notification SMS.............................................................................11
6. Lancement rapide d'un message AlarmTILT.................................................................12
6.1 Utilisation..........................................................................................................12
6.2 Format de mail..................................................................................................12
6.2.1 Entêtes......................................................................................................12
6.2.2 Corps du message.......................................................................................12
6.3 Exemples..........................................................................................................12
7. Surveillance de connectivité......................................................................................13
7.1 Utilisation..........................................................................................................13
7.2 Format de mail..................................................................................................13
7.2.1 Entêtes......................................................................................................13
7.2.2 Corps du message.......................................................................................13
7.3 Exemples..........................................................................................................13
8. Fichiers attachés......................................................................................................14
8.1 Lancement de procédure avec fichier attaché........................................................14
8.2 Envoi d'un message simple avec fichier attaché.....................................................14
8.3 Envoi de notification avec fichier attaché ..............................................................15
9. Recommandations globales.......................................................................................15
10. Suivi d'envoi..........................................................................................................15
Pages : 3 de 16
1. Contexte
Ce document décrit l'utilisation de mail comme interface vers les services AlarmTILT.
Trois types de services sont utilisables avec cette interface :
lancement d'une de vos procédures AlarmTILT avec des paramètres simples,
envoi de message à vos contacts AlarmTILT,
envoi de message à une liste de destinations libres (destinations non référencées explicitement
en tant que contact dans l'annuaire), sur un média spécifique,
envoi de message à des contacts AlarmTILT prédéfinis,
surveillance de connectivité
2. Vocabulaire
Quelques termes utilisés tout au long de ce document:
Token Utilisateur
un code identifiant un utilisateur AlarmTILT
Token de Procédure
un code identifiant une procédure AlarmTILT
Paramètre de Procédure
variable définie dans le formulaire de la procédure.
Destinations
Le nom d'un contact AlarmTILT
une adresse libre.
Nom de contact AlarmTILT
le nom d'un contact (contact, groupe ou sélection dynamique) dans la vue “Annuaire”.
Pages : 4 de 16
3. Lancement d'une procédure AlarmTILT
3.1 Utilisation
Contexte : lancement d'une procédure avec paramètres via un mail structuré de façon à pouvoir
définir la valeur de chaque paramètre de la procédure.
Dans le cas ou seule la destination du mail peut être paramétrée, il est possible d'utiliser un mail non
structuré et d'utiliser les paramètres standard dans la définition de la procédure : “subject” pour le sujet
du mail et “body” pour le corps du mail.
L'adresse mail de destination à utiliser est spécifique à un utilisateur. Cet mail est affiché dans les
menus “Déclencheurs Externes”/”Procédures” dans la vue détail d'une procédure. Cette vue présente
également l'ensemble des comptes pouvant utiliser le mail comme déclencheur. Dans le cas ou le mail
n'apparaît pas, un bouton permet de créer cette adresse. L'adresse mail est formatée de la sorte :
[email protected]
3.2 Format du mail
Le format utilisé est basé sur la norme standard RFC 5322 – avec les spécificités suivantes :
3.2.1 Entêtes
De:
Sans objet
A: ou Copie: ou Copie [email protected]
Cachée:
Sujet:
Si le mail est structuré : sans objet
Si le mail n'est PAS structuré : utilisé comme un paramètre “subject”
3.2.2 Corps du message
Le corps du message peut être structuré pour correspondre aux paramètres de la procédure ou être
non structuré.
3.2.2.1 Corps de message structuré
Il consiste soit en :
un simple message text dans le cas d'un mail simple non MIME
une partie “text/plain” dans le cas d'un message MIME. La première partie “text/plain” trouvée
est prise en considération.
Le corps du message inclut les paramètres de la procédure (donc les destinations). Pour définir un
paramètre, on utilise le nom du paramètre entouré de crochet [], puis la valeur du paramètre est définie
à partir de la ligne suivante.
Pages : 5 de 16
Le paramètre [destinations] est composé de une ou plusieurs lignes avec le nom d'un contact
AlarmTILT par ligne.
La liste de ces paramètres est obligatoirement entourée de [begin] au tout début et [end] à la fin.
Exemple
Voici un exemple du corps d'un mail pour une procédure avec les paramètres suivants:
Contacts.S001 contiendra les destinations à alerter au cours de l'exécution de la 1ère étape de
la procédure,
paramName1 comme un paramètre texte,
paramName2 comme un paramètre texte,
paramName3 comme un paramètre texte sur plusieurs lignes
[begin]
[Contacts.S001]
FirstName1 LastName1
FirstName2 LastName2
FirstName3 LastName3
[paramName1]
paramValue1
[paramName2]
paramValue2
[paramName3]
paramValueTextMultiline paramValueTextMultiline
paramValueTextMultiline paramValueTextMultiline paramValueTextMultiline
[end]
3.2.2.2 Corps de message non-structuré
Si le mail ne contient aucun texte défini avec une section entourée par [begin] et [end] , le corps du
message est considéré comme la valeur d'une variable nommée BODY et le contenu du sujet du mail
sera le contenu de la variable SUBJECT.
3.3 Exemple 1: Déclenchement de Procédure sans paramètre particulier
Contexte:
Le mail généré ne peut pas être modifié,
ou la procédure n'a pas besoin de paramètres.
From: [email protected]
To: [email protected]
Subject: The System - task 125 has finished
Dear user,
Your task 125 has successfully finished.
Sincerely,
The System.
Pages : 6 de 16
3.4 Exemple 2: Déclenchement de Procédure avec paramètres
Contexte:
Le mail peut être paramétré et la procédure a inclus les variables « tasknumber »,
« taskstatus » et « author » au sein de son formulaire de lancement.
Les destinations sont prédéfinies au sein de chaque étape de la procédure.
From: [email protected]
To: [email protected]
Subject: ...
[begin]
[tasknumber]
125
[taskstatus]
finished
[author]
The System
[end]
3.5 Exemple 3: Déclenchement de procédure avec des destinations
Contexte:
Le mail peut être paramétré et la procédure a inclus les variables « tasknumber », « taskstatus »
Les destinations sont prédéfinies au sein de chaque étape de la procédure, mais peuvent être
modifiées éventuellement au déclenchement de la procédure (une variable « Contacts.Snnn » est
dans ce cas présente dans la définition du formulaire de lancement)
From: [email protected]
To: [email protected]
Subject: ...
[begin]
[Contacts.S001]
Duke Nukem
Ally Mc Beal
SWAT TEAM
[tasknumber]
125
[taskstatus]
finished
[author]
The System
[end]
Pages : 7 de 16
4. Envoi de message à des contacts AlarmTILT
4.1 Utilisation
Contexte : l'envoi de message à un contact AlarmTILT sur un canal ou média spécifique avec un sujet
et un corps de message défini.
L'adresse mail de déclenchement à utiliser est affichée dans le modules “Déclencheurs
Externes”/”Message et notification” accessible par votre accès administrateur. Cette vue liste les
utilisateurs autorisés et leur adresse de déclenchement associées. L'adresse mail de déclenchement est
formatée de la façon suivante :
[email protected]
4.2 Format du mail
Le format utilisé est basé sur la norme standard RFC 5322 – avec les spécificités suivantes :
4.2.1 Entêtes
De:
Sans objet
Pour: ou Copie à: ou
Copie cachée à:
[email protected]
Sujet:
Sans objet
4.2.2 Corps du message
Ci dessous le tableau des paramètres pour le corps du message :
Nom du paramètre
Description
Valeurs possibles
Requis
destinations
Destinataires
Chaque ligne correspond toujours
au label d'un contact
AlarmTILT
subject
Sujet du message
Une ligne de texte
toujours
body
Corps du message
Texte multi-ligne
toujours
Un paramètre est déclaré grâce à l'utilisation de son nom entouré de crochets. La valeur associé
débute à la ligne suivante.
Dans “[destinations]”, chaque ligne correspond à un contact AlarmTILT.
“[begin]” et “[end]” sont requis pour encadrer les paramètres soumis.
Pages : 8 de 16
4.3 Exemple: Envoi d'un message simple
Contexte:
Un envoi de message à des contacts AlarmTILT,
Le corps du message peut être paramétré.
From: [email protected]
To: [email protected]
Subject: ...
Body:
[begin]
[destinations]
Duke Nukem
Ally Mc Beal
[subject]
The System - task 125 has finished
[body]
Dear user,
Your task 125 has successfully finished.
Sincerely,
The System.
[end]
5. Envoi de message à une adresse externe
5.1 Utilisation
La principale utilisation est l'envoi de message à une ou plusieurs adresses (numéro de téléphone,
mail,...) via un canal d'acheminement spécifique (sms, voice,...) avec un sujet (si besoin) et un corps de
message. Ce mode d'utilisation permet de notifier des personnes non présentes dans l'annuaire
AlarmTILT.
L'adresse mail de déclenchement à utiliser est affichée dans le modules “Déclencheurs
Externes”/”Message et notification” accessible par votre accès administrateur. Cette vue liste les
utilisateurs autorisés et leur adresse de déclenchement associées. L'adresse mail de déclenchement est
formatée de la façon suivante :
[email protected]
Pages : 9 de 16
5.2 Format de mail
Le format utilisé est basé sur la norme standard RFC 5322 – avec les spécificités suivantes :
5.2.1 Entêtes
De:
Sans objet
A: ou Copie à: ou
Copie caché à:
[email protected]
Sujet:
Sans objet
5.2.2 Corps du message
Nom du
paramètre
Description
Valeurs possibles
Requis
media
Le canal ou média à utiliser
pour envoyer le message
VOICE
toujours
SMS
EMAIL
language
FR
EN
Si le média est de type
VOICE : Obligatoire.
DE
NL
Sans objet sinon.
destinations
Destination du message
Chaque ligne correspond à
une adresse de destination.
toujours
subject
Sujet du message
Une ligne de texte
Si le média est de type
EMAIL : Obligatoire.
Sans objet sinon.
body
Corps du message
Texte multi-ligne
toujours
NB: si le média est de type
VOICE, il est possible d'utiliser
des balises spécifiques voir le
document “AlarmTILT
Webservice” dans la section
“Extended Support for Voice
Notification”.
Pages : 10 de 16
5.3 Exemples
5.3.1 Envoi de Notification VOIX (VOICE)
From: [email protected]
To: [email protected]
Subject: ...
[begin]
[media]
VOICE
[language]
FR
[destinations]
35206485XXXX
[body]
paramValueTextMultiline paramValueTextMultiline
paramValueTextMultiline paramValueTextMultiline paramValueTextMultiline
[end]
5.3.2 Envoi de notification EMAIL
From: [email protected]
To: [email protected]
Subject: ...
[begin]
[media]
EMAIL
[destinations]
[email protected]
[subject]
subject value
[body]
paramValueTextMultiline paramValueTextMultiline
paramValueTextMultiline paramValueTextMultiline paramValueTextMultiline
[end]
5.3.3 Envoi de Notification SMS
From: [email protected]
To: [email protected]
Subject: ...
[begin]
[media]
SMS
[destinations]
[email protected]
[body]
paramValueTextMultiline paramValueTextMultiline
paramValueTextMultiline paramValueTextMultiline paramValueTextMultiline
[end]
Pages : 11 de 16
6. Lancement rapide d'un message AlarmTILT
6.1 Utilisation
Dans certains cas, le contenu du mail ne peut être paramétré. L'utilisation de la fonctionnalité
“lancement rapide” est adaptée à ce contexte. Elle permet de pouvoir prédéfinir les destinations dans
l'interface web AlarmTILT et utilise le corps du texte comme variable “body” ainsi que le sujet du mail
comme variable “subject”.
L'adresse mail de déclenchement à utiliser est affichée dans le modules “Déclencheurs
Externes”/”Message et notification” accessible par votre accès administrateur. Cette vue liste les
utilisateurs autorisés et leur adresse de déclenchement associées. L'adresse mail de déclenchement est
formatée de la façon suivante :
[email protected]
Si aucune destination n'est prédéfinie, le destinataire par défaut est l'utilisateur propriétaire du mail
de déclenchement.
6.2 Format de mail
Le format utilisé est basé sur la norme standard RFC 5322 – avec les spécificités suivantes :
6.2.1 Entêtes
De:
Sans objet
A: ou Copie à: ou
Copie caché à:
[email protected]
Sujet:
le contenu du sujet du mail sera le contenu de la variable SUBJECT
6.2.2 Corps du message
Le corps du message est considéré comme la valeur d'un variable nommé BODY.
6.3 Exemples
From: [email protected]
To: [email protected]
Subject: The System - task 125 has finished
Dear user,
Your task 125 has successfully finished.
Sincerely,
The System.
Pages : 12 de 16
7. Surveillance de connectivité
7.1 Utilisation
La surveillance de connectivité est une fonctionnalité qui permet de vérifier la connectivité grâce à
l'envoi régulier de mail. Le système attend au minimum 1 mail par heure pour considérer la connectivité
comme bonne. Dans le cas contraire une notification est déclenchée. De même lors du retour à un état
stable, une notification est déclenchée pour vous avertir du retour à la normale.
L'adresse mail de déclenchement à utiliser est affichée dans le modules “Déclencheurs
Externes”/”Clients de communication” accessible par votre accès administrateur. Cette vue liste les
différentes connectivités que vous surveillez. Il est possible d'en ajouter (menu de gauche), de les
éditer, de les activer ou désactiver.
L'adresse mail de notification est formatée de la façon suivante :
[email protected]
7.2 Format de mail
Le format utilisé est basé sur la norme standard RFC 5322 – avec les spécificités suivantes :
7.2.1 Entêtes
De:
Sans objet
A: ou Copie à: ou
Copie caché à:
[email protected]
Sujet:
Sans objet
7.2.2 Corps du message
Sans objet.
7.3 Exemples
From: [email protected]
To: [email protected]
Subject: a useless subject
a useless body text
Pages : 13 de 16
8. Fichiers attachés
Les fichiers attachés sont supportés. Si le corps du message contient une section entourée de [begin]
et [end], les noms de fichiers attachés doivent être spécifiés dans les paramètres. Sinon tous les fichiers
attachés seront associés à l'étape 1 de la procédure (attachments.S001).
8.1 Lancement de procédure avec fichier attaché
Contexte:
Le message peut être paramétré et la procédure a des paramètres définis,
La procédure a des destinations définies par défaut,
L'étape 1 traite les fichiers attachés.
From: [email protected]
To: [email protected]
Subject: ...
[begin]
[tasknumber]
125
[taskstatus]
finished
[author]
The System
[attachments.S001]
test1.pdf
[end]
8.2 Envoi d'un message simple avec fichier attaché
En assumant que le mail contient un fichier attaché nommé test1.pdf.
From: [email protected]
To: [email protected]
Subject: ...
Body:
[begin]
[attachments]
test1.pdf
[destinations]
Duke Nukem
Ally Mc Beal
[subject]
The System - task 125 has finished
[body]
Dear user,
Your task 125 has successfully finished.
Sincerely,
The System.
[end]
Pages : 14 de 16
8.3 Envoi de notification avec fichier attaché
En assumant que le mail contient un fichier attaché nommé test1.pdf.
From: [email protected]
To: [email protected]
Subject: ...
[begin]
[media]
EMAIL
[language]
FR
[destinations]
[email protected]
[subject]
sujet test
[attachments]
test1.pdf
[body]
body test
test
test
[end]
9. Recommandations globales
Le mail soumis doit être aussi simple que possible (le plain/text est préférable au html) avec un
contenu de taille raisonnable.
Un mail de taille supérieure à 5 Mo est rejeté sans préavis.
Un mail envoyé du même émetteur plus de 10 fois endéans 60 secondes est considéré comme abusif
et est rejeté sans préavis.
Un mail envoyé du même domaine plus de 100 fois endéans 90 secondes est considéré comme
abusif et est rejeté sans préavis.
10. Suivi d'envoi
Le système supporte le DSN (delivery status notification). Vous pouvez ainsi recevoir un statut de
réception de la part de notre serveur mail, positif ou négatif suivant le contexte. Ce rapport indique
uniquement si la distribution du mail à notre serveur s'est effectuée avec succès mais n'indique pas
d'erreur de traitement dû à une mauvaise identification ou des paramètres défectueux ou de façon plus
générale une mauvais configuration du contenu du mail.
Dans le cas d'envoi abusif, la notification de réception sera négative.
Pages : 15 de 16
Pour plus d'informations
M-PLIFY S.A.
21, Rue Glesener
L-1631 Luxembourg
[email protected]
+352 261846 121
Pages : 16 de 16