Guide du programmeur

Guide du programmeur

Organisation du code

AnalystEmail.js : regroupe toutes les fonctions permettant d’appeler les fonctions qui réalisent les différentes spécifications et qui affichent les résultats.

email.js : correspond à la classe email contenant le parser.

listeEmail.js : regroupe toutes les fonctions permettant de créer une liste d’emails et de réaliser les différentes spécifications.

README.txt : contient les informations sur l'installation et les fonctionnalités du programme.

Fonctionnalité des commandes

Connaître le top 10 des objets : Une liste d’email est créée dans AnalystEmail.js qui va ensuite appeler la fonction getTopObj dans listeEmail.js pour récupérer le top10 des objets les plus utilisés pour une boîte donnée. Pour ce faire il faut compter les occurrences de chaque objet puis les classer par ordre croissant et enfin récupérer les dix premiers.

Connaître le top 10 des collaborateurs : Une liste d’email est créée dans AnalystEmail.js qui va ensuite appeler la fonction getTopContact dans listeEmail.js pour récupérer les dix emails les plus utilisés pour une boîte donnée. Pour ce faire il faut compter les occurrences de chaque email puis les classer par ordre croissant et enfin récupérer les dix premiers.

Connaître le nombre d’email échangé pendant une période : Une liste d’email est créée dans AnalystEmail.js qui va ensuite appeler la fonction countByDate dans listeEmail.js pour récupérer le nombre de mail échangé pour une boîte donnée. Pour ce faire la fonction incrémente un compteur pour chaque mail se trouvant entre la date de début et de fin de comptage.

Liste des emails de type BuzzyDays : Agit de la même manière que précédemment, on ajoute uniquement des horaires en plus des jours dans le critère de comptage.

Exporter un graphique : AnalystEmail.js va appeler la fonction createGraphNbExchanges qui va créer un graphique avec Vegalite et l’exporter dans le répertoire du logiciel.

Récupérer un ’email : En fonction de l’option choisit, la liste des emails va être parcouru pour récupérer les emails qui possède soit le même objet, le même nom ou le même surnom en utilisant la fonction findBy dans listeEmail.js.

Exporter un email : Une instance de l’email a exporté est créée puis on appelle la fonction extractEmail de la classe email. La fonction va récupérer les informations sur l’email au format json et les concaténer dans un fichier texte qui sera ensuite exporté dans le répertoire du logiciel.

Récupérer le carnet d’adresse d’un collaborateur : On appelle la fonction getAdressBook dans listeEmail qui va parcourir tous les emails d’un collaborateur et ajouter les informations sur les contacts, au format vCard à la variable listAdress.