feat(providers): Add support for using embedded images in email providers (#5457)

Co-authored-by: Dima Grossman <[email protected]>

Author: smbecker

packages/providers/src/lib/email/emailjs/emailjs.provider.ts

@@ -86,6 +86,7 @@ export class EmailJsProvider extends BaseProvider implements IEmailProvider {
             name: attachment.name,
             data: attachment.file.toString('base64'),
             type: attachment.mime,
+            inline: Boolean(attachment.cid),
           };
         })
       : [];

packages/providers/src/lib/email/mailersend/mailersend.provider.ts

@@ -36,7 +36,15 @@ export class MailersendEmailProvider extends BaseProvider implements IEmailProvi
   }
 
   private getAttachments(attachments: IEmailOptions['attachments']): Attachment[] | null {
-    return attachments?.map((attachment) => new Attachment(attachment.file.toString('base64'), attachment.name));
+    return attachments?.map(
+      (attachment) =>
+        new Attachment(
+          attachment.file.toString('base64'),
+          attachment.name,
+          attachment.disposition ?? (attachment.cid ? 'inline' : 'attachment'),
+          attachment.cid
+        )
+    );
   }
 
   private createMailData(options: IEmailOptions): EmailParams {

packages/providers/src/lib/email/mailgun/mailgun.provider.ts

@@ -73,12 +73,22 @@ export class MailgunEmailProvider extends BaseProvider implements IEmailProvider
       html: emailOptions.html,
       cc: emailOptions.cc?.join(','),
       bcc: emailOptions.bcc?.join(','),
-      attachment: emailOptions.attachments?.map((attachment) => {
-        return {
-          data: attachment.file,
-          filename: attachment.name,
-        };
-      }),
+      attachment: emailOptions.attachments
+        ?.filter((attachment) => !attachment.cid)
+        ?.map((attachment) => {
+          return {
+            data: attachment.file,
+            filename: attachment.name,
+          };
+        }),
+      inline: emailOptions.attachments
+        ?.filter((attachment) => Boolean(attachment.cid))
+        ?.map((attachment) => {
+          return {
+            data: attachment.file,
+            filename: attachment.name,
+          };
+        }),
     };
 
     if (emailOptions.replyTo) {

packages/providers/src/lib/email/mailjet/mailjet.provider.ts

@@ -103,11 +103,21 @@ export class MailjetEmailProvider extends BaseProvider implements IEmailProvider
       Subject: options.subject,
       TextPart: options.text,
       HTMLPart: options.html,
-      Attachments: options.attachments?.map((attachment) => ({
-        ContentType: attachment.mime,
-        Filename: attachment.name,
-        Base64Content: attachment.file.toString('base64'),
-      })),
+      Attachments: options.attachments
+        ?.filter((attachment) => !attachment.cid)
+        ?.map((attachment) => ({
+          ContentType: attachment.mime,
+          Filename: attachment.name,
+          Base64Content: attachment.file.toString('base64'),
+        })),
+      InlinedAttachments: options.attachments
+        ?.filter((attachment) => attachment.cid)
+        ?.map((attachment) => ({
+          ContentType: attachment.mime,
+          Filename: attachment.name,
+          Base64Content: attachment.file.toString('base64'),
+          ContentID: attachment.cid,
+        })),
     }).body;
 
     if (options.replyTo) {

packages/providers/src/lib/email/mailtrap/mailtrap.provider.ts

@@ -7,7 +7,7 @@ import {
   ICheckIntegrationResponse,
   CheckIntegrationResponseEnum,
 } from '@novu/stateless';
-import { MailtrapClient, Address, Mail } from 'mailtrap';
+import { MailtrapClient, Address, Mail, Attachment } from 'mailtrap';
 import { BaseProvider, CasingEnum } from '../../../base.provider';
 import { WithPassthrough } from '../../../utils/types';
 
@@ -73,6 +73,7 @@ export class MailtrapEmailProvider extends BaseProvider implements IEmailProvide
           filename: attachment.name,
           content: attachment.file,
           type: attachment.mime,
+          content_id: attachment.cid,
         })),
       }).body
     );

packages/providers/src/lib/email/nodemailer/nodemailer.provider.ts

@@ -139,6 +139,9 @@ export class NodemailerProvider extends BaseProvider implements IEmailProvider {
         filename: attachment?.name,
         content: attachment.file,
         contentType: attachment.mime,
+        cid: attachment.cid,
+        contentDisposition:
+          (attachment.disposition as 'inline' | 'attachment') ?? (attachment.cid ? 'inline' : undefined),
       })),
       bcc: options.bcc,
     };

packages/providers/src/lib/email/outlook365/outlook365.provider.ts

@@ -83,9 +83,12 @@ export class Outlook365Provider extends BaseProvider implements IEmailProvider {
       html: options.html,
       text: options.text,
       attachments: options.attachments?.map((attachment) => ({
-        filename: attachment?.name,
+        filename: attachment.name,
         content: attachment.file,
         contentType: attachment.mime,
+        cid: attachment.cid,
+        contentDisposition:
+          (attachment.disposition as 'inline' | 'attachment') ?? (attachment.cid ? 'inline' : undefined),
       })),
     };
 

packages/providers/src/lib/email/postmark/postmark.provider.ts

@@ -81,7 +81,8 @@ export class PostmarkEmailProvider extends BaseProvider implements IEmailProvide
       Cc: getFormattedTo(options.cc),
       Bcc: getFormattedTo(options.bcc),
       Attachments: options.attachments?.map(
-        (attachment) => new Models.Attachment(attachment.name, attachment.file.toString('base64'), attachment.mime)
+        (attachment) =>
+          new Models.Attachment(attachment.name, attachment.file.toString('base64'), attachment.mime, attachment.cid)
       ),
     };
 

packages/providers/src/lib/email/sendgrid/sendgrid.provider.ts

@@ -97,6 +97,8 @@ export class SendgridEmailProvider extends BaseProvider implements IEmailProvide
 
       if (attachment?.disposition) {
         attachmentJson.disposition = attachment?.disposition;
+      } else if (attachment?.cid) {
+        attachmentJson.disposition = 'inline';
       }
 
       return attachmentJson;

packages/providers/src/lib/email/ses/ses.provider.ts

@@ -74,6 +74,9 @@ export class SESEmailProvider extends BaseProvider implements IEmailProvider {
           filename: attachment?.name,
           content: attachment.file,
           contentType: attachment.mime,
+          cid: attachment.cid,
+          contentDisposition:
+            attachment.disposition ?? (attachment.cid ? 'inline' : undefined),
         })),
         cc,
         bcc,