Merge branch 'develop' of https://github.com/tassiLuca/ChainVote into develop

Author: Luca1313

docs/report-asw/listings/mailer-config.ts

@@ -0,0 +1,15 @@
+import nodemailer from 'nodemailer';
+import fs from "fs";
+
+const path = "/run/secrets/google_api_secret";
+const secretValue = fs.readFileSync(path, 'utf8').trim();
+
+const config = {
+    service: 'gmail',
+    auth: {
+        user: "chainvote.01@gmail.com",
+        pass: secretValue
+    }
+}
+
+export default nodemailer.createTransport(config);

docs/report-asw/listings/mailer-usage.ts

@@ -0,0 +1,16 @@
+
+import mailer from "../configs/mailer.config";
+
+
+// other parts of the code
+
+const message = {
+    from: 'ChainVote',
+    to: emailToSend,
+    subject: 'Title of the email',
+    html: `
+       Some HTML content to append to the mail
+    `
+};
+
+await mailer.sendMail(message).catch((error: any) => next(error));

docs/report-asw/report.tex

@@ -14,7 +14,7 @@
 \subtitle{(v. \version)}
 
 \author{
-    Giovanni Antonioni \\ \emailaddr{giovanni.antonioni2@studio.unibo.it} \\ Matr. \texttt{xxxx}
+    Giovanni Antonioni \\ \emailaddr{giovanni.antonioni2@studio.unibo.it} \\ Matr. \texttt{001083764}
     \and 
     Luca Rubboli \\ \emailaddr{luca.rubboli2@studio.unibo.it} \\ Matr. \texttt{1083742}
     \and
@@ -567,8 +567,20 @@ \subsubsection{Rate limiter}
 \end{figure}
 
 \subsubsection{Mailer}
+The system can send emails to the user by the means of a mailer component configured inside the API server. 
+We use a custom gmail account which credentials are passed using a docker secret on the initialization of the container during the deployment phase.
+\jsimport[
+    caption={The mailer component},
+    label={lst:mailer}
+]{listings/mailer-config.ts}
+
+When needed the mailer can be used in the code as follows:
+
+\jsimport[
+    caption={An example of how to use the mailer component},
+    label={lst:mailer-usage}
+]{listings/mailer-usage.ts}
 
-\todo{Fill mailer}
 
 \subsubsection{Routes}