AAirline_GL02 Files

### README - MAIL Parser - Projet GL02

Based upon : Verbose POI Format (VPF) Parser - TP GL02 from M. Tixier (matthieu.tixier@utt.fr).
From the SRS of groupe FILA.

Description : Offer a parser implemented in Javascript for reading and processing mails. The files are in text format within a folder and should respect the correct grammar.
Provides :
    # RC01 : Number of exchanged emails during a period of time.
    # RC02 : A list of "buzzy day". Days where a mail has been written during the weekend or between 10pm to 8am.
    # RC03 : A list the Top 10 conversation partner for a given person.
    # RC04 : A list of the Top 10 term used in the subject for a given mailbox.
    # RC05 : A scatter plot (with plots of different sizes) of the amount of emails exchanged between partners for a given mailbox.
    
    # BS01 : Extracts a list of mail according to different criterias.
    # BS02 : Converts a mail into a VCard (RFC6350).
    # BS03 : Displays the content of a mail.

### Installation
    $ npm install

### Utilisation :
    $ node Commande.js <command> folderToParse [-hts]


	RC01 : <command> : mailpertime <folder> <startDate> <endDate> (folder : fichier à parser) (format date : YYYY/MM/DD) 
	   Renvoie un graphique SVG nommé : mailpertime
	RC02 : <command> : buzzyday <name> (name : nom d'un dossier personnel, ex : arnold-j) 
	    Renvoie un graphique SVG nommé : buzzyday
	RC03 : <command> : tenmost <folder> (folder : fichier à parser)
	    Renvoie un graphique SVG nommé : Chart10Interl
	RC04 : <command> : tenterms <folder> (folder : fichier à parser)
	    Renvoie un graphique SVG nommé : Chart10Terms
	RC05 : <command> : collaboExch <folder> (folder : fichier à parser)
	    Renvoie un graphique SVG nommé : EchCollab

	BS01 : <command> : searchExp <folder> (folder : fichier à parser) (formulaire à remplir avant de lancer la fonction)
		Affiche les mails correspondant aux critères de recherche
		Critères de recherches : mail, objet, corps du mail
		NB: le nom et le prénom ne peuvent être des critères de recherche car cette donnée n'est pas disponible. 
	BS02 : <command> : VCard2 <mail> (mail : email du nouveau contact)
		Renvoie une Vcard (fichier .vcf)
	BS03 : <command> : parseMail <mailpath> (mailpath : path du mail à afficher)
		Affiche le contenu d'un mail


-h or --help 	:	 display the program help
-t or --showTokenize :	 display the tokenization result 
-s or --showSymbols :	 display each step of the analysis

Optional parameters have to be before the mandatory file parameter.



### Version :
    # 0.07

        - Caporal 2.0 Migration.

    # 0.06

        - Add vega-lite visualization and export.

    # 0.05

        - Utilisation du framework Caporal.js pour gerer la cli

    # 0.04

        - Decouplage CLI dans module a part : cli.js
        - Refactoring POI et VpfParser

    # 0.03

        - Ajout d'une option help permettant de lire le readme depuis la console
        - Ajout d'un mode verbose pour suivre l'action du parser

    # 0.02

        - Prise en charge des notes
        - Construction d'une liste d'objet POI afin de permettre des traitement ult�rieur

    # 0.01

        - Parse entierement les fichiers simples du jeu de test (mais termine avec une erreur)
        - Prise en compte des noms de POI s'ils ne comportent pas d'espaces

### Liste des contributeurs
    M. Tixier (matthieu.tixier@utt.fr)
    Groupe A-Airline de GL02 en A20