Quarotte_gl02 Files

### README - Ingeance Internet Format Message (RFC 5322) Parser - PROJET GL02

Description : Offer a mail parser implemented in Javascript for reading and processing the Internet Format Message (RFC 5322). This format allows to describe any list of Mail . The files are in text format and should respect grammar like RFC 5322. Short example :

Message-ID: 18021166.1075849629119.JavaMail.evans@thyme Date: Mon, 11 Dec 2000 04:14:00 -0800 (PST) From: walton.agnew@enron.com To: jennifer.medcalf@enron.com, sarah-joy.hunter@enron.com Subject: Dell and Continental Status Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: 7bit X-From: Walton Agnew X-To: Jennifer Medcalf, Sarah-Joy Hunter X-cc: X-bcc: X-Folder: \John_Arnold_Nov2001\Notes Folders\Dell X-Origin: ARNOLD-J X-FileName: jarnold.nsf After our meeting with Dell on 10/27, I sent a request to Charlie Ball (works for Kip) for detailed power data from TXU. Charlie delegated the task of getting this data to Randy Don Carlos, who ... [suite du body]

Installation :

Le fichier package.json contient la mention de la totalité des librairies externes utilisées (dépendences). En conséquence, un simple "npm install" dans le terminal de commandes, se chargera de télécharger et installer toutes les dépendences.

Utilisation :

$ node index.js <directoryWhichContainsEmails> [-hts]

:

readme : Display the README.txt file

filter <directory> <value> [options] : Filter the mails by a criteria # Arguments : <directory> : Path of the <directory> containing emails required <value> : The value of the criteria required
# Options :

- n, --name         : Filter emails by the name of the sender
- f, --firstname    : Filter emails by the first name of the sender
- s, --subject      : Filter emails by word in subjet

exchange <directory> <collab1> <collab2> <date1> <date2> : Returns the number of emails sent by one employee to another employee over a period of time # Arguments : <directory> : Path of the <directory> containing emails required <collab1> : The full name of the first collaborator required <collab2> : The full name of the second collaborator required <date1> : Start of period, in format: <AAAA-MM-dd> required <date2> : End of period, in format: <AAAA-MM-dd> required

buzzyday <directory> <collaborator> : Returns the number of emails sent by the collaborator between 10pm and 8am or on weekends # Arguments : <directory> : Path of the <directory> containing emails required <collaborator> : The full name of the collaborator sought required

vip <directory> <collaborator> : Returns the list of people to whom the most emails have been sent and the number of emails concerned # Arguments : <directory> : Path of the <directory> containing emails required <collaborator> : Collaborateur who sent the emails required

vcard <directory> : Generate all the vcf file # Arguments <directory> : Path of the <directory> containing emails to be parsed to create the vcard required # Output Create a folder names 'vcf' which contains all the .vcf files

help : Display help on a command

Optional parameters have to be before the mandatory file parameter.

Global Options :

-h, --help      : Display help
-V, --version   : Display version
--no-color      : Disable colors
--quiet         : Quiet mode - only displays warn and error messages
-v, --verbose   : Verbose mode - will also output debug messages

Liste des SPEC

SPEC_1 : traité => extraction et structuration des emails afin de permettre un traitement futur

• Possibilité d'effectuer des recherches primaires sur des emails, en recherchant une liste d'email écrite par la personne portant le nom de ... ou prénommée... Ou encore en recherchant une liste d'email en fonction d'un mot présent dans l'objet du mail

SPEC_2 : non-traité => générer un graphique suivant un ou plusieurs critères

SPEC_3 : traité => avoir accès aux nombres d'email échangés entre deux collaborateur sur une période de temps donnée

SPEC_4 : traité => avoir accès à la liste des "buzzy day" d'un collaborateur

SPEC_5 : traité => liste des 10 interlocuteurs les plus importants d'un collaborateur. Soient les personnes ayant reçu le plus de mails de ce même collaborateur

SPEC_6 : non-traité => liste des 10 termes utilisés

SPEC_7 : traité => génération au format vCard des contacts des collaborateurs Notes : toutes les informations ne sont pas récoltables depuis un mail, par exemple, la fonction n'apparaît jamais en dehors de la signature. Or, cette dernière n'est pas toujours présente et ne dispose pas toujours de la même structure, en conséquence de quoi elle est impossible à parser. On pourrait admettre que le domaine d'un email correspond à celui de la société pour laquelle il travaille. Cependant, il faut alors faire le tri avec les emails perso (marqué outlook.com, google.com, etc...) où dans ces cas là, il apparaît plus ou moins clairement que ce n'est pas l'entreprise dans laquelle travaille le contact. => Seul les noms et emails valides sont donc récupérés pour créer un contact. Ce dernier peut en posséder plusieurs.

Liste des contributeurs :

Alexis HELIOT Clement DE LA BOURDONNAYE Remi BONNETO Iza EL KANDRi