User Guide modified by Mithulan VANNIYASINGAM

Mithulan VANNIYASINGAM — Thu, 09 Jan 2020 15:33:56 -0000

--- v2
+++ v3
@@ -44,10 +44,10 @@
 next day.

 ### period search 
-   node mailAnalyzer period <time1-time2>
+   node mailAnalyzer period <date1>, <date2>
 This command displays all mails that were sent during a certain period. 

-* `time1-time2` just like 01-20, 12-19
+* `date1`, `time2` just like 01-20, 12-19

 ### Top 10 Interlocutors 
     node mailAnalyzer.js topinterlocutor <mail>
</mail></date2></date1></time1-time2>

User Guide modified by Perrier

Perrier — Thu, 09 Jan 2020 15:28:43 -0000

--- v1
+++ v2
@@ -1,13 +1,75 @@
-Using this software, you can analyze a folder containing mails to gather informations on them.
+# mailAnalyzer.js

-You can use the functions directly after calling the program in order to execute them.
+A library to get information about a dataset of mails
+that will be used by UIConsult to improve their analyzing of the work of employees.
+----------
+## How to use

-findcontact gives you the email of someone you want to analyse.
+In order to use the library, you need to open a command-line interface in the source of this library (in frenglish-gl02-git) and launch

-search and keyword help you find a specific mail from given attributes
+     node mailAnalyzer.js

-topinterlocutor, topterm, graph and allinterlocutor help you analyze the mailbox of someone in particular.
+This will open the help for the library, other commands will be browsed below.

-countemails and buzzy helps you make general stats.
+All commands use the dataset of mails in `mail` containing mails of UIConsult collaborators.

-If any doubts, you can always check help for a specific command
+------
+## Commands
+
+### Set Up
+    node mailAnalyzer.js mailPath <path>
+This command changes the actual path to the new path if it exists (Note: you can also manually edit the path.txt file)
+
+### Graph 
+    node mailAnalyzer.js graph <mail>
+This command allow you to visualize in a graph how many mails were exchanged with others for a given address mail. It creates a scatter plot in SVG format.
+
+* `mail` Mail address of the collaborator
+
+### Search 
+    node mailAnalyzer.js search <condition> <value>
+This command is a search tool for person. It displays a list of mail matching the name, mail or surname given in arguments. Let's detail arguments :
+
+* `condition`  What condition you want your search to match between :
+    * name : Searching in names of sender or receiver
+    * surname : Searching in surnames of sender or receiver
+    * mail : Searching in mail addresses of sender or receiver
+
+* `value` The name, surname or mail address you are searching
+
+### Buzzy days 
+     node mailAnalyzer.js buzzy <targetperson>
+
+This command displays all mails of a target person that were sent during weekend or between 10:00pm and 8:00am of the
+next day.
+
+### period search 
+   node mailAnalyzer period <time1-time2>
+This command displays all mails that were sent during a certain period. 
+
+* `time1-time2` just like 01-20, 12-19
+
+### Top 10 Interlocutors 
+    node mailAnalyzer.js topinterlocutor <mail>
+This command displays the 10 interlocutors a given collaborator has exchanged with the most.
+
+* `mail` Mail address of the collaborator
+
+### All Interlocutors 
+    node mailAnalyzer.js allinterlocutor <mail>
+This command displays all interlocutors for a given collaborator has exchanged with.
+
+* `mail` Mail address of the collaborator
+
+### Top 10 terms 
+    node mailAnalyzer.js topterm <mail>
+This command displays the 10 terms the most used by a given collaborator.
+
+* `mail` Mail address of the collaborator
+
+
+### find contact 
+   node mailAnalyzer findcontact <name>
+This command displays find the contact address of someone.
+
+* `name` First and LastName of the collaborator,like findcontact "John Arnold"
</name></mail></mail></mail></time1-time2></targetperson></value></condition></mail></path>

User Guide modified by Grenon Maxence

Grenon Maxence — Wed, 08 Jan 2020 15:27:19 -0000

Using this software, you can analyze a folder containing mails to gather informations on them.

You can use the functions directly after calling the program in order to execute them.

findcontact gives you the email of someone you want to analyse.

search and keyword help you find a specific mail from given attributes

topinterlocutor, topterm, graph and allinterlocutor help you analyze the mailbox of someone in particular.

countemails and buzzy helps you make general stats.

If any doubts, you can always check help for a specific command

Recent changes to User Guide

User Guide modified by Mithulan VANNIYASINGAM

User Guide modified by Perrier

User Guide modified by Grenon Maxence