Dev guide

This code is made in order to analyze a set of e-mails. the place where data is checked can be found in the program.

most important function can be found in mailAnalyzer and clientFunction. They offer the analysis of the parsed data.

Data parser is a made up parser and allows to create a mail parsed data.

Mail.js is to be modified for the structure of the parsed data.

The functions reached from the outside are found in clientfunctions. Therefore, if you want to implement a new thing, your best chances are to start there.

    readDirectory is the function that reads a directory to look after data.
    readFile is the function that reads a file.



        log_data_graphe is the function which create a SVG graph with mails exchanged between workers in the folder selected.
        allMails contains the parced data.
        name is the sender name.
        At first, it look at each parced data, if the sender is the same as name.
        Then it look at who is the receiver of the mail, then it added the receiver name in a list and added a counter for this person in another list. So if the receiver name is already in the list, then it just increase by one the count for this receiver.

        mailSearch is the function that search mails sent by the one who answered to the condition.
        mails, the parced mail.
        arg, the conditions.
        value, the value of the conditions

        buzzyDays is the function that search mails sent on the weekend or between 10:00 PM and 8:00 AM by the name put in input.
        ( The code work for ime in the format HH:MM with HH between 00 and 23or in the format HH:MM AM/PM with HH between 00 and 12)
        mails, the parced mails.
        name, the sender name.
        At first, it look at if the mail is sent in weekend.
        Then, it look at if the date contains PM and in this case if it is sent after 10.
       If not, then it look at if the date contains AM and then look at if it is sent before 8.
       If it is neither of them then it look at if it is sent between 22:00 nd 8:00.

       Period is the function that search mails sent during the period put in input.
       mails is the parced mails.
       days1 is the start date for which we seek for.
       days2 is the last date for whch we seek for.
       Caution:days1 and days2 have to be in the format DD-MM-YYYY.

       topInterlocutors is the function that find the top interlocutors of the one we put in input.
       mails, the parced mails.
       name, the name of the sender.

       findcontact is the function that get the contact of someone and then return his VCards.
       mails, the parced mails.
       name, the name of the one we seek for.

       topTerms is the function that get the top terms of someone,
       mails, the parced mails.
       name, the name of the one we look after.

If you want to improve the software, here are a few things we thought about :

In a first time, try to solve problems reported by the open tickets.

Separate the files to make things clearer and more structured.

Make the place where we find the mails more flexible.

Add more graphs for better understanding of the analysis.

Add commentary for the results.

You are of course welcome to make any change of the program to either improve it or adapt it for your own usage, as long at it respects the stipulated opensource license.