Merge pull request #4952 from novuhq/nv-3185-add-support-for-cid-base…

…d-attachment-in-email Add support for cid based attachment in email
novuhq · Dec 17, 2023 · 0744144 · 0744144 · github-actions · Dec 17, 2023
2 parents dd71192 + 0c3ac49
commit 0744144
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 7 deletions.
diff --git a/libs/shared/src/types/events/index.ts b/libs/shared/src/types/events/index.ts
@@ -17,6 +17,8 @@ export interface IAttachmentOptions {
   file: Buffer;
   name?: string;
   channels?: ChannelTypeEnum[];
+  cid?: string;
+  disposition?: string;
 }
 
 export interface IEmailOptions {

diff --git a/packages/stateless/src/lib/template/template.interface.ts b/packages/stateless/src/lib/template/template.interface.ts
@@ -53,6 +53,8 @@ export interface IAttachmentOptions {
   file: Buffer | null;
   name?: string;
   channels?: ChannelTypeEnum[];
+  cid?: string;
+  disposition?: string;
 }
 
 export interface IAttachmentOptionsExtended extends IAttachmentOptions {

diff --git a/providers/sendgrid/src/lib/sendgrid.provider.ts b/providers/sendgrid/src/lib/sendgrid.provider.ts
@@ -7,10 +7,13 @@ import {
   ICheckIntegrationResponse,
   CheckIntegrationResponseEnum,
   IEmailEventBody,
+  IAttachmentOptions,
 } from '@novu/stateless';
 
 import { MailDataRequired, MailService } from '@sendgrid/mail';
 
+type AttachmentJSON = MailDataRequired['attachments'][0];
+
 export class SendgridEmailProvider implements IEmailProvider {
   id = 'sendgrid';
   channelType = ChannelTypeEnum.EMAIL as ChannelTypeEnum.EMAIL;
@@ -74,6 +77,26 @@ export class SendgridEmailProvider implements IEmailProvider {
     delete options.customData?.dynamicTemplateData;
     delete options.customData?.templateId;
 
+    const attachments = options.attachments?.map(
+      (attachment: IAttachmentOptions) => {
+        const attachmentJson: AttachmentJSON = {
+          content: attachment.file.toString('base64'),
+          filename: attachment.name,
+          type: attachment.mime,
+        };
+
+        if (attachment?.cid) {
+          attachmentJson.contentId = attachment?.cid;
+        }
+
+        if (attachment?.disposition) {
+          attachmentJson.disposition = attachment?.disposition;
+        }
+
+        return attachmentJson;
+      }
+    );
+
     const mailData: Partial<MailDataRequired> = {
       from: {
         email: options.from || this.config.from,
@@ -95,13 +118,7 @@ export class SendgridEmailProvider implements IEmailProvider {
         novuSubscriberId: options.notificationDetails?.subscriberId,
         ...options.customData,
       },
-      attachments: options.attachments?.map((attachment) => {
-        return {
-          content: attachment.file.toString('base64'),
-          filename: attachment.name,
-          type: attachment.mime,
-        };
-      }),
+      attachments: attachments,
       personalizations: [
         {
           to: options.to.map((email) => ({ email })),