Guide utilisateur

Guide de démarrage utilisatueur

Pré-requis:
D'abord il faut installer nodejs sur votre machine puis utiliser le framework caporal pour faire tourner le projet.
Il faut aussi installer :
+ caporal
+ colors
+ vega
+ vega-lite
+ vcards-js
+ svg2png
+ pm
+ recursive-readdir
+ recursive-readdir-sync
Pour le installer, faites exécuter les commandes suivantes : npm install < nom_du_package >

Lancer le programme
Entrer "node app.js" pour avoir accès à toutes les commandes et leurs utilisations.

Générer la liste des boites mails d'un ou des collaborateurs
Cette commande permet d'afficher le liste des boites mails d'un ou plusieurs collaborateurs.
La commande :
node app.js listeboitesmailde <boitemail></boitemail>

filtrer les messages
Cette commande permet de filtrer les recherches par une expression choisie par l'utilisateur. Elle parcourt les mails du destinataire choisi et permet de trouver les mails contenant la recherche.
La commande :
node app.js filtrerpar <boitemail> <option_chosie> <recherche>
avec les options suivantes:
-m, --email
-n, --nom
-d, --date
-t --terme
-c --affichagecompact
-e, --exporthtml</recherche></option_chosie></boitemail>

Afficher le nombre de messages échangés
Cette commlande permet d’afficher le nombre total de mails échangés d'un collaborateur.
La commande :
node app.js nbrmailechange <boitemail>
options disponibles:
-d, --date
-e, --exporthtml</boitemail>

BuzzyDays : afficher la liste de tous les mails envoyés
Cette commande permet d’afficher la liste de tous les mails envoyés entre 22h et 8h du matin ou les weekends.
La commande :
node app.js buzzyday <boitemail> <option_chosie>
option disponible:
-e, --exporthtml</option_chosie></boitemail>

Afficher le top10 des top interlocuteurs
Cette commande permet d’afficherAfficher le top 10 des interlocuteurs pour un collaborateur choisi.
La commande :
node app.js topinterlocuteur <boitemail>
option disponible:
-e, --exporthtml</boitemail>

Afficher le top 10 des termes les plus utilisés
Cette commande permet d’afficher le top 10 des termes les plus utilisés par un collaborateur choisi.
La commande :
node app.js toptermes <boitemail>
option disponible:
-e, --exporthtml</boitemail>

Obtenir le nombre d’échange entre les collaborateurs de manière visuelle
Cette commande permet d'obtenir le nombre d’échange entre les collaborateurs de manière visuelle pour un collaborateur choisi.
La commande :
node app.js graphique <boitemail> <format_souhaité>
option disponible:
-e, --exporthtml
formats disponibles:
svg et png</format_souhaité></boitemail>

exporter les contact
Cette commande permet d’exporter tous les contact trouvés dans un fichier au format vCard.
La commande :
node app.js exportcontact <boitemail>
option disponible:
-e, --exporthtml</boitemail>