feat(productiviy-report): email config (#8571)

Add ability to customize email headers for non-transactional emails.
Unleash · Oct 29, 2024 · 30c14ff · 30c14ff
1 parent 9809316
commit 30c14ff
Show file tree

Hide file tree

Showing 7 changed files with 45 additions and 4 deletions.
diff --git a/src/lib/__snapshots__/create-config.test.ts.snap b/src/lib/__snapshots__/create-config.test.ts.snap
@@ -53,6 +53,7 @@ exports[`should create default config 1`] = `
   "disableScheduler": undefined,
   "email": {
     "host": undefined,
+    "optionalHeaders": {},
     "port": 587,
     "secure": false,
     "sender": "Unleash <[email protected]>",

diff --git a/src/lib/create-config.ts b/src/lib/create-config.ts
@@ -39,6 +39,7 @@ import {
 } from './types/models/api-token';
 import {
     parseEnvVarBoolean,
+    parseEnvVarJSON,
     parseEnvVarNumber,
     parseEnvVarStrings,
 } from './util/parseEnvVar';
@@ -348,6 +349,7 @@ const defaultEmail: IEmailOption = {
     sender: process.env.EMAIL_SENDER || 'Unleash <[email protected]>',
     smtpuser: process.env.EMAIL_USER,
     smtppass: process.env.EMAIL_PASSWORD,
+    optionalHeaders: parseEnvVarJSON(process.env.EMAIL_OPTIONAL_HEADERS, {}),
 };
 
 const dbPort = (dbConfig: Partial<IDBOption>): Partial<IDBOption> => {

diff --git a/src/lib/services/email-service.ts b/src/lib/services/email-service.ts
@@ -33,6 +33,7 @@ export interface IEmailEnvelope {
         path: string;
         cid: string;
     }[];
+    headers?: Record<string, string>;
 }
 
 const RESET_MAIL_SUBJECT = 'Unleash - Reset your password';
@@ -536,11 +537,14 @@ export class EmailService {
         },
     ): Promise<IEmailEnvelope> {
         if (this.configured()) {
+            const unsubscribeUrl = '{{amazonSESUnsubscribeUrl}}'; // FIXME: Add unsubscribe URL
+
             const context = {
                 userName,
                 userEmail,
                 ...metrics,
                 unleashUrl: this.config.server.unleashUrl,
+                unsubscribeUrl,
             };
 
             const template = 'productivity-report';
@@ -555,6 +559,16 @@ export class EmailService {
                 TemplateFormat.PLAIN,
                 context,
             );
+
+            const headers: Record<string, string> = {};
+            Object.entries(this.config.email.optionalHeaders || {}).forEach(
+                ([key, value]) => {
+                    if (typeof value === 'string') {
+                        headers[key] = value;
+                    }
+                },
+            );
+
             const email: IEmailEnvelope = {
                 from: this.sender,
                 to: userEmail,
@@ -569,7 +583,9 @@ export class EmailService {
                         'unleashLogo',
                     ),
                 ],
-            };
+                headers,
+            } satisfies IEmailEnvelope;
+
             process.nextTick(() => {
                 this.mailer!.sendMail(email).then(
                     () =>

diff --git a/src/lib/types/option.ts b/src/lib/types/option.ts
@@ -167,6 +167,7 @@ export interface IEmailOption {
     smtpuser?: string;
     smtppass?: string;
     transportOptions?: SMTPTransport.Options;
+    optionalHeaders?: Record<string, unknown>;
 }
 
 export interface IListeningPipe {

diff --git a/src/lib/util/parseEnvVar.ts b/src/lib/util/parseEnvVar.ts
@@ -38,3 +38,18 @@ export function parseEnvVarStrings(
 
     return defaultVal;
 }
+
+export function parseEnvVarJSON(
+    envVar: string | undefined,
+    defaultVal: Record<string, unknown>,
+): Record<string, unknown> {
+    if (envVar) {
+        try {
+            return JSON.parse(envVar);
+        } catch (e) {
+            return defaultVal;
+        }
+    }
+
+    return defaultVal;
+}
diff --git a/src/mailtemplates/productivity-report/productivity-report.html.mustache b/src/mailtemplates/productivity-report/productivity-report.html.mustache
@@ -6,7 +6,7 @@
     <title>Your Unleash Productivity Report</title>
 </head>
 
-<body style="font-family: Arial, sans-serif;background-color: #f9f9f9;color: #333;margin: 0;padding: 0;font-size:16px">
+<body style="font-family: Arial, sans-serif;background-color: #f9f9f9;color: #333;margin: 0;padding: 12px 0;font-size:16px">
     <div class="container"
         style="max-width: 600px;margin: 24px auto;background-color: #ffffff;border-radius: 8px;border: 1px solid #f0f0f5;overflow: hidden;">
         <div class="header" style="background-color: #6c65e5;padding: 20px;text-align: center;color: #ffffff;">
@@ -72,8 +72,9 @@
             </div>
             <div class="unsubscribe" style="font-size: 12px;color: #888;margin-top: 10px;">
                 This email was sent to {{userEmail}}. You’ve received this as you are a user of Unleash.<br>
-                If you wish to unsubscribe from our newsletter, click <a
-                    href="https://example.com/unsubscribe">here</a>.
+                {{#unsubscribeUrl}}
+                If you wish to unsubscribe from updated, click <a href="{{unsubscribeUrl}}">here</a>.
+                {{/unsubscribeUrl}}
             </div>
         </div>
     </div>

diff --git a/src/mailtemplates/productivity-report/productivity-report.plain.mustache b/src/mailtemplates/productivity-report/productivity-report.plain.mustache
@@ -3,3 +3,8 @@ Subject: Unleash productivity report
 Hello,
 
 Productivity report
+{{! FIXME: create plaintext template }}
+
+{{#unsubscribeUrl}}
+If you wish to unsubscribe from updated, open {{unsubscribeUrl}}.
+{{/unsubscribeUrl}}