email notification server configuration

Author: Bhupesh-mfsi

packages/lib/delivery/src/Delivery.ts

@@ -5,4 +5,10 @@ export interface DeliveryServiceProperties {
     //Number of bytes an envelop object should not exceed
     sizeLimit: number;
     notificationChannel: NotificationChannel[];
+    // properties for email service
+    smtpHost: string;
+    smtpPort: number;
+    smtpEmail: string;
+    smtpUsername: string;
+    smtpPassword: string;
 }

packages/lib/delivery/src/Messages.test.ts

@@ -9,8 +9,14 @@ import { getConversationId, getMessages, incomingMessage } from './Messages';
 import { Session } from './Session';
 import { SpamFilterRules } from './spam-filter/SpamFilterRules';
 
-import { MAIL_HTML, MAIL_SUBJECT } from './notifications/channels/Email';
-import { NotificationChannelType } from './notifications/types';
+import {
+    NEW_MSG_EMAIL_TEMPLATE,
+    NEW_MSG_EMAIL_SUBJECT,
+} from './notifications/templates/newMessage';
+import {
+    NotificationChannelType,
+    NotificationType,
+} from './notifications/types';
 
 const SENDER_NAME = 'alice.eth';
 const RECEIVER_NAME = 'bob.eth';
@@ -451,7 +457,10 @@ describe('Messages', () => {
                 return Promise.resolve([
                     {
                         type: NotificationChannelType.EMAIL,
-                        config: { recipientAddress: '[email protected]' },
+                        config: {
+                            recipientAddress: '[email protected]',
+                            notificationType: NotificationType.NEW_MESSAGE,
+                        },
                     },
                 ]);
             };
@@ -479,14 +488,11 @@ describe('Messages', () => {
                     {
                         type: NotificationChannelType.EMAIL,
                         config: {
-                            host: 'exmaple.host',
+                            host: '[email protected]',
                             port: 1234,
-                            secure: true,
-                            auth: {
-                                user: 'foo',
-                                pass: 'bar',
-                            },
-                            senderAddress: '[email protected]',
+                            username: '[email protected]',
+                            password: 'bar',
+                            emailID: '[email protected]',
                         },
                     },
                 ],
@@ -503,8 +509,10 @@ describe('Messages', () => {
 
             expect(sendMailMock).toHaveBeenCalledWith({
                 from: '[email protected]',
-                html: MAIL_HTML(testData.delvieryInformationBUnecrypted),
-                subject: MAIL_SUBJECT,
+                html: NEW_MSG_EMAIL_TEMPLATE(
+                    testData.delvieryInformationBUnecrypted,
+                ),
+                subject: NEW_MSG_EMAIL_SUBJECT,
                 to: '[email protected]',
             });
             //Check if the message was submitted to the socket

packages/lib/delivery/src/Messages.ts

@@ -24,6 +24,7 @@ import { NotificationBroker } from './notifications';
 import {
     GetNotificationChannels,
     NotificationChannel,
+    NotificationType,
 } from './notifications/types';
 import { checkToken, Session } from './Session';
 import { isSpam } from './spam-filter';
@@ -209,7 +210,10 @@ export async function incomingMessage(
         });
         //If not we're notifing the user that there is a new message waiting for them
     } else {
-        const { sendNotification } = NotificationBroker(dsNotificationChannels);
+        const { sendNotification } = NotificationBroker(
+            dsNotificationChannels,
+            NotificationType.NEW_MESSAGE,
+        );
         await sendNotification(
             deliveryInformation,
             getUsersNotificationChannels,

packages/lib/delivery/src/notifications/broker/NotificationBroker.ts

@@ -6,6 +6,7 @@ import {
     NotificationChannel,
     NotificationChannelType,
     INotificationChannel,
+    NotificationType,
 } from '../types';
 
 /**
@@ -55,10 +56,12 @@ export const _setupNotficationBroker = (
  */
 export const NotificationBroker = (
     notificationChannel: NotificationChannel[],
+    notificationType: NotificationType,
 ): INotificationBroker => {
     const channels = notificationChannel.map((channel) => {
         switch (channel.type) {
             case NotificationChannelType.EMAIL:
+                channel.config.notificationType = notificationType;
                 return {
                     type: NotificationChannelType.EMAIL,
                     send: Email(channel.config).send,

packages/lib/delivery/src/notifications/channels/Email.ts

@@ -2,46 +2,57 @@ import { DeliveryInformation } from '@dm3-org/dm3-lib-messaging';
 import { logError } from '@dm3-org/dm3-lib-shared';
 import nodemailer from 'nodemailer';
 import SMTPTransport from 'nodemailer/lib/smtp-transport';
+import { NotificationType } from '../types';
+import { fetchEmailSubjectAndTemplate } from '../utils';
 
-// Define types for email server and user configuration
-export type EmailNotificationServerConfig = SMTPTransport.Options & {
-    senderAddress: string;
+// email server configuration
+export type EmailNotificationServerConfig = {
+    host: string;
+    port: number;
+    username: string;
+    password: string;
+    emailID: string;
 };
 
+// email notification configuration
 export type EmailNotificationUserConfig = {
     recipientAddress: string;
+    notificationType: NotificationType;
 };
 
-// Constants for email subject and HTML template
-export const MAIL_SUBJECT = 'New DM3 Message';
-export const MAIL_HTML = (
-    deliveryInformation: DeliveryInformation,
-) => `<html lang="en">
-<body>
-<p>You have received a new DM3 message from ${deliveryInformation.from}.
-<br/>
-Open <a href="app.dm3.network">DM3</a> to read it</p>
-<script src="index.js"></script>
-</body>
-</html>`;
-
-// Define the Email function
+// method to send email
 export function Email(config: EmailNotificationServerConfig) {
     const send = async (
         mailConfig: EmailNotificationUserConfig,
         deliveryInformation: DeliveryInformation,
     ) => {
-        nodemailer.createTestAccount();
-        const transport = nodemailer.createTransport(new SMTPTransport(config));
-
         try {
-            // Send the email using nodemailer
+            // create transport with email credentials
+            const transport: nodemailer.Transporter<SMTPTransport.SentMessageInfo> =
+                nodemailer.createTransport({
+                    host: config.host,
+                    port: config.port,
+                    auth: {
+                        user: config.username,
+                        pass: config.password,
+                    },
+                });
+
+            // fetch the specific subject & template of email
+            const { subject, template } = fetchEmailSubjectAndTemplate(
+                mailConfig.notificationType,
+                deliveryInformation,
+            );
+
+            // send the email using nodemailer
             await transport.sendMail({
-                from: config.senderAddress,
+                from: config.emailID,
                 to: mailConfig.recipientAddress,
-                subject: MAIL_SUBJECT,
-                html: MAIL_HTML(deliveryInformation),
+                subject: subject,
+                html: template,
             });
+
+            // close the connection
             transport.close();
         } catch (err) {
             logError('Send mail failed ' + err);

packages/lib/delivery/src/notifications/templates/newMessage.ts

@@ -0,0 +1,12 @@
+import { DeliveryInformation } from '@dm3-org/dm3-lib-messaging';
+
+export const NEW_MSG_EMAIL_TEMPLATE = (
+    deliveryInformation: DeliveryInformation,
+) =>
+    `<html lang="en">
+    <body>
+        <p>You received a new message from ${deliveryInformation.from}.
+    </body>
+</html>`;
+
+export const NEW_MSG_EMAIL_SUBJECT = 'DM3 New Message';

packages/lib/delivery/src/notifications/templates/otp.ts

@@ -0,0 +1,8 @@
+export const OTP_EMAIL_TEMPLATE = (otp: string) =>
+    `<html lang="en">
+    <body>
+        <p>Your OTP to verify email ID is : ${otp}. The OTP will expire in 10 minutes.
+    </body>
+</html>`;
+
+export const OTP_EMAIL_SUBJECT = 'Email Verification';

packages/lib/delivery/src/notifications/types.ts

@@ -5,6 +5,11 @@ export enum NotificationChannelType {
     EMAIL = 'EMAIL',
 }
 
+export enum NotificationType {
+    NEW_MESSAGE = 'NEW_MESSAGE',
+    OTP = 'OTP',
+}
+
 //The properties of a notification channel.
 // Those properties are stored in the DB to let the user specify their notificatin channels
 export interface NotificationChannel {

packages/lib/delivery/src/notifications/utils.ts

@@ -0,0 +1,38 @@
+import { DeliveryInformation } from '@dm3-org/dm3-lib-messaging';
+import { NotificationType } from './types';
+import {
+    NEW_MSG_EMAIL_SUBJECT,
+    NEW_MSG_EMAIL_TEMPLATE,
+} from './templates/newMessage';
+import { OTP_EMAIL_SUBJECT, OTP_EMAIL_TEMPLATE } from './templates/otp';
+
+// TODO: generates 5 digit OTP
+export const generateOtp = () => {
+    return '12345';
+};
+
+// to fetch subject & template of email based on notification type
+export const fetchEmailSubjectAndTemplate = (
+    notificationType: NotificationType,
+    deliveryInformation: DeliveryInformation,
+): {
+    subject: string;
+    template: string;
+} => {
+    switch (notificationType) {
+        case NotificationType.NEW_MESSAGE:
+            return {
+                subject: NEW_MSG_EMAIL_SUBJECT,
+                template: NEW_MSG_EMAIL_TEMPLATE(deliveryInformation),
+            };
+        case NotificationType.OTP:
+            return {
+                subject: OTP_EMAIL_SUBJECT,
+                template: OTP_EMAIL_TEMPLATE(generateOtp()),
+            };
+        default:
+            throw new Error(
+                `Notification type ${notificationType} is not supported`,
+            );
+    }
+};