Ce guide est destiné aux utilisateurs de l’outil en ligne de commande, d’aide à l’analyse des communications et des expertises à l’intérieur d’équipe de collaborateurs. Cet outil permet l'analyse des communications par email. Il utilise les données des mails afin d'en extraire des informations pertinentes. Ces informations extraites serviront à la rédaction d’un rapport d'analyse des échanges par emails des collaborateurs. Le guide a pour but d’aider les utilisateurs à prendre en main le logiciel.

Le logiciel possède plusieurs fonctionnalités :

• Lister tous les mails présents dans la boîte mail
• Extraire les contacts du collaborateur en format VCARD
• Indiquer le nombre d'e-mails échangé sur une période de temps
• Etablir un graphique du nombre d'échange entre les collaborateurs
• Lister les buzzy days, c’est-à-dire entre 22h00 et 8h00 la semaine et le week-end
• Réaliser un top 10 des interlocuteurs avec qui le collaborateur échange le plus de mails
• Réaliser un top 10 des objets des mails les plus utilisés
• Rechercher des mails selon différents critères (adresse mail, nom, prénom, objet

**Contenu du logiciel : **

**Le logiciel est composé des fichiers suivants : **

• Un fichier projet.js
• Un fichier parser.js
• Les dossiers contenant les données des boites mail

**Utilisation du logiciel **

• Pour utiliser le logiciel, placez-vous dans le dossier contenant les fichiers cités précédemment.
• Ensuite, ouvrez une invite de commande.
• Tapez chacune des instructions suivantes dans le terminal afin d’installer différents modules pour utiliser pleinement le logiciel :

• npm install colors : ce module permet au terminal d’utiliser du texte en couleur
• npm install caporal : intalle un cadre complet pour la création d'applications de ligne de commande (cli) avec node.js.
• npm install vega : c’est une grammaire de visualisation, un format déclaratif pour créer, enregistrer et partager des conceptions de visualisation interactives.
• npm install vega-lite : Vega-Lite fournit une grammaire de niveau supérieur pour l'analyse visuelle qui génère des spécifications Vega complètes.

1. Commandes générales

Pour utiliser les commandes du logiciel, la syntaxe est la suivante :
node projet.js <commande> <nom de la boite mail à analyser> <option(s)>

Les options globales du logiciel sont :

-h, --help Affiche l’aide du logiciel c’est-à-dire son utilisation et toutes les commandes possibles
Exemple : node projet.js -h

help <commande> Affiche l’aide pour une commande spécifiques c’est-à-dire son utilisation, ses arguments et ses options
Exemple : node projet.js help list

-V, --version Affiche la version du logiciel
Exemple : node projet.js -V

--no-color Désactive les couleurs dans le terminal
Exemple : node projet.js --no-color

--quiet Active le mode silencieux, affiche seulement les messages d’avertissements et d’erreurs
Exemple : node projet.js--quiet

-v, --verbose Mode détaillé, produit également des messages de débogage
Exemple : node projet.js --verbose

2. Commandes du logiciel

• list : Cette commande permet de réaliser différents types de listes grâce à cinq options :

o -s ou --showSymbols : Extrait et affiche, sous forme de liste les données pertinentes des mails suivantes : chemin du mail, ID du mail, Date, destinataire du mail, Expediteur du mail, l’objet et son contenu
Exemple : node projet.js list campbell-l -s
o -b ou --showBusyDay : Affiche la liste des jours où des mails ont été échangés en dehors des horaires de travail, c’est-à-dire entre 22h00 et 8h00 dans la semaine et le weekend
Exemple : node projet.js list arnold-j -b
o -iou --showTopInterloc : Affiche le top 10 des interlocuteurs avec qui le collaborateur échange le plus de mails
Exemple : node projet.js list campbell-l -i
o -o ou --showTopObjet : Affiche le top 10 des termes les plus utilisés dans les objets des mails pour une boîte mail donnée
Exemple : node projet.js list campbell-l -o

• contact : Extraire les contacts d’un collaborateur en fichier vCard
Exemple : node projet.js contact arnold-j

• count : Indique le nombre d’e-mails échangés sur une période de temps. La commande doit être rentrer dans cette ordre : count adresse_mail -d1 date_début -d2 date_fin. Les options pour cette commande sont :
-d1 ou --date1 JJ/MM/AAAA qui permet de rentrer le début de la période
-d2 ou --date2 JJ/MM/AAAA qui permet de rentrer la fin de la période
Attention: il faut que la date1 soit une date antérieure à la date2
Exemples : sarah-joy.hunter@enron.com La recherche se fait sur toute la boîte mail jusqu'à aurjourd'hui.
sarah-joy.hunter@enron.com -d1 12/10/1999 -d2 15/05/2019 La recherche se fait entre la date d1 et la date d2.
sarah-joy.hunter@enron.com -d1 23/08/2003 La recherche se fait à partir de la date d1 jusqu'à aujourd'hui.
sarah-joy.hunter@enron.com -d2 11/03/2007 La recherche se fait sur tout la boîte mail jusqu'à la date d2.

• diagram : Créer un graphique au format svg en nuage de points indiquant le nombre de mails échangés entre collaborateurs pour une boite mail donnée.
Attention il faut rajouter _sent_mail collé au <nom de="" la="" boite="" mail="" à="" analyser=""> pour que la commande fonctionne correctement.
Exemple : node projet.js diagram campbell-l\_sent_mail</nom>

• show : permet de faire une recherche de mails avec cinq critères différents (adresse mail, nom, prénom, objet, mail) mais on ne peut rechercher qu’avec quatre critères au maximum. Les critères sont donc cumulables et peuvent se mettre dans n’importe quel ordre. Par exemple, la recherche peut se faire par quatre noms ou bien deux noms et 1 adresse mail. Cette commande affiche tous les mails qui correspondent au moins à un critère.
Les options pour cette commande sont donc :
o -a : premier critère recherché
o -b : deuxième critère recherché
o -c : troisième critère recherché
o -d : quatrième critère recherché
Exemple : node projet.js show arnold-j -a sarah-joy.hunter@enron.com -c "Server Agreement Amendment Language"