feat: add email domains (#1895)

Implemented Email Domains which allows Platform/Enterprise customers to send emails to recipients using their custom emails.
2025-11-15 17:21:41 +10:00 · 2025-07-24 16:05:00 +10:00
parent 07119f0e8d
commit 3409aae411
157 changed files with 5966 additions and 1090 deletions
--- a/packages/lib/jobs/definitions/emails/send-document-cancelled-emails.handler.ts
+++ b/packages/lib/jobs/definitions/emails/send-document-cancelled-emails.handler.ts
@ -9,7 +9,6 @@ import { prisma } from '@documenso/prisma';

 import { getI18nInstance } from '../../../client-only/providers/i18n-server';
 import { NEXT_PUBLIC_WEBAPP_URL } from '../../../constants/app';
-import { FROM_ADDRESS, FROM_NAME } from '../../../constants/email';
 import { getEmailContext } from '../../../server-only/email/get-email-context';
 import { extractDerivedDocumentEmailSettings } from '../../../types/document-email';
 import { renderEmailWithI18N } from '../../../utils/render-email-with-i18n';
@ -43,11 +42,13 @@ export const run = async ({
    },
  });

-  const { branding, settings } = await getEmailContext({
+  const { branding, emailLanguage, senderEmail, replyToEmail } = await getEmailContext({
+    emailType: 'RECIPIENT',
    source: {
      type: 'team',
      teamId: document.teamId,
    },
+    meta: document.documentMeta || null,
  });

  const { documentMeta, user: documentOwner } = document;
@ -59,9 +60,7 @@ export const run = async ({
    return;
  }

-  const lang = documentMeta?.language ?? settings.documentLanguage;
-
-  const i18n = await getI18nInstance(lang);
+  const i18n = await getI18nInstance(emailLanguage);

  // Send cancellation emails to all recipients who have been sent the document or viewed it
  const recipientsToNotify = document.recipients.filter(
@ -82,9 +81,9 @@ export const run = async ({
        });

        const [html, text] = await Promise.all([
-          renderEmailWithI18N(template, { lang, branding }),
+          renderEmailWithI18N(template, { lang: emailLanguage, branding }),
          renderEmailWithI18N(template, {
-            lang,
+            lang: emailLanguage,
            branding,
            plainText: true,
          }),
@ -95,10 +94,8 @@ export const run = async ({
            name: recipient.name,
            address: recipient.email,
          },
-          from: {
-            name: FROM_NAME,
-            address: FROM_ADDRESS,
-          },
+          from: senderEmail,
+          replyTo: replyToEmail,
          subject: i18n._(msg`Document "${document.title}" Cancelled`),
          html,
          text,
--- a/packages/lib/jobs/definitions/emails/send-organisation-member-joined-email.handler.ts
+++ b/packages/lib/jobs/definitions/emails/send-organisation-member-joined-email.handler.ts
@ -8,7 +8,6 @@ import { prisma } from '@documenso/prisma';

 import { getI18nInstance } from '../../../client-only/providers/i18n-server';
 import { NEXT_PUBLIC_WEBAPP_URL } from '../../../constants/app';
-import { FROM_ADDRESS, FROM_NAME } from '../../../constants/email';
 import { ORGANISATION_MEMBER_ROLE_PERMISSIONS_MAP } from '../../../constants/organisations';
 import { getEmailContext } from '../../../server-only/email/get-email-context';
 import { renderEmailWithI18N } from '../../../utils/render-email-with-i18n';
@ -56,7 +55,8 @@ export const run = async ({
    },
  });

-  const { branding, settings } = await getEmailContext({
+  const { branding, emailLanguage, senderEmail } = await getEmailContext({
+    emailType: 'INTERNAL',
    source: {
      type: 'organisation',
      organisationId: organisation.id,
@ -80,29 +80,24 @@ export const run = async ({
          organisationUrl: organisation.url,
        });

-        const lang = settings.documentLanguage;
-
        // !: Replace with the actual language of the recipient later
        const [html, text] = await Promise.all([
          renderEmailWithI18N(emailContent, {
-            lang,
+            lang: emailLanguage,
            branding,
          }),
          renderEmailWithI18N(emailContent, {
-            lang,
+            lang: emailLanguage,
            branding,
            plainText: true,
          }),
        ]);

-        const i18n = await getI18nInstance(lang);
+        const i18n = await getI18nInstance(emailLanguage);

        await mailer.sendMail({
          to: member.user.email,
-          from: {
-            name: FROM_NAME,
-            address: FROM_ADDRESS,
-          },
+          from: senderEmail,
          subject: i18n._(msg`A new member has joined your organisation`),
          html,
          text,
--- a/packages/lib/jobs/definitions/emails/send-organisation-member-left-email.handler.ts
+++ b/packages/lib/jobs/definitions/emails/send-organisation-member-left-email.handler.ts
@ -8,7 +8,6 @@ import { prisma } from '@documenso/prisma';

 import { getI18nInstance } from '../../../client-only/providers/i18n-server';
 import { NEXT_PUBLIC_WEBAPP_URL } from '../../../constants/app';
-import { FROM_ADDRESS, FROM_NAME } from '../../../constants/email';
 import { ORGANISATION_MEMBER_ROLE_PERMISSIONS_MAP } from '../../../constants/organisations';
 import { getEmailContext } from '../../../server-only/email/get-email-context';
 import { renderEmailWithI18N } from '../../../utils/render-email-with-i18n';
@ -52,7 +51,8 @@ export const run = async ({
    },
  });

-  const { branding, settings } = await getEmailContext({
+  const { branding, emailLanguage, senderEmail } = await getEmailContext({
+    emailType: 'INTERNAL',
    source: {
      type: 'organisation',
      organisationId: organisation.id,
@ -76,28 +76,23 @@ export const run = async ({
          organisationUrl: organisation.url,
        });

-        const lang = settings.documentLanguage;
-
        const [html, text] = await Promise.all([
          renderEmailWithI18N(emailContent, {
-            lang,
+            lang: emailLanguage,
            branding,
          }),
          renderEmailWithI18N(emailContent, {
-            lang,
+            lang: emailLanguage,
            branding,
            plainText: true,
          }),
        ]);

-        const i18n = await getI18nInstance(lang);
+        const i18n = await getI18nInstance(emailLanguage);

        await mailer.sendMail({
          to: member.user.email,
-          from: {
-            name: FROM_NAME,
-            address: FROM_ADDRESS,
-          },
+          from: senderEmail,
          subject: i18n._(msg`A member has left your organisation`),
          html,
          text,
--- a/packages/lib/jobs/definitions/emails/send-recipient-signed-email.handler.ts
+++ b/packages/lib/jobs/definitions/emails/send-recipient-signed-email.handler.ts
@ -8,7 +8,6 @@ import { prisma } from '@documenso/prisma';

 import { getI18nInstance } from '../../../client-only/providers/i18n-server';
 import { NEXT_PUBLIC_WEBAPP_URL } from '../../../constants/app';
-import { FROM_ADDRESS, FROM_NAME } from '../../../constants/email';
 import { getEmailContext } from '../../../server-only/email/get-email-context';
 import { extractDerivedDocumentEmailSettings } from '../../../types/document-email';
 import { renderEmailWithI18N } from '../../../utils/render-email-with-i18n';
@ -71,17 +70,18 @@ export const run = async ({
    return;
  }

-  const { branding, settings } = await getEmailContext({
+  const { branding, emailLanguage, senderEmail } = await getEmailContext({
+    emailType: 'INTERNAL',
    source: {
      type: 'team',
      teamId: document.teamId,
    },
+    meta: document.documentMeta || null,
  });

  const assetBaseUrl = NEXT_PUBLIC_WEBAPP_URL() || 'http://localhost:3000';

-  const lang = document.documentMeta?.language ?? settings.documentLanguage;
-  const i18n = await getI18nInstance(lang);
+  const i18n = await getI18nInstance(emailLanguage);

  const template = createElement(DocumentRecipientSignedEmailTemplate, {
    documentName: document.title,
@ -92,9 +92,9 @@ export const run = async ({

  await io.runTask('send-recipient-signed-email', async () => {
    const [html, text] = await Promise.all([
-      renderEmailWithI18N(template, { lang, branding }),
+      renderEmailWithI18N(template, { lang: emailLanguage, branding }),
      renderEmailWithI18N(template, {
-        lang,
+        lang: emailLanguage,
        branding,
        plainText: true,
      }),
@ -105,10 +105,7 @@ export const run = async ({
        name: owner.name ?? '',
        address: owner.email,
      },
-      from: {
-        name: FROM_NAME,
-        address: FROM_ADDRESS,
-      },
+      from: senderEmail,
      subject: i18n._(msg`${recipientReference} has signed "${document.title}"`),
      html,
      text,
--- a/packages/lib/jobs/definitions/emails/send-rejection-emails.handler.ts
+++ b/packages/lib/jobs/definitions/emails/send-rejection-emails.handler.ts
@ -10,7 +10,7 @@ import { prisma } from '@documenso/prisma';

 import { getI18nInstance } from '../../../client-only/providers/i18n-server';
 import { NEXT_PUBLIC_WEBAPP_URL } from '../../../constants/app';
-import { FROM_ADDRESS, FROM_NAME } from '../../../constants/email';
+import { DOCUMENSO_INTERNAL_EMAIL } from '../../../constants/email';
 import { getEmailContext } from '../../../server-only/email/get-email-context';
 import { extractDerivedDocumentEmailSettings } from '../../../types/document-email';
 import { renderEmailWithI18N } from '../../../utils/render-email-with-i18n';
@ -52,7 +52,7 @@ export const run = async ({
    }),
  ]);

-  const { documentMeta, user: documentOwner } = document;
+  const { user: documentOwner } = document;

  const isEmailEnabled = extractDerivedDocumentEmailSettings(
    document.documentMeta,
@ -62,16 +62,16 @@ export const run = async ({
    return;
  }

-  const { branding, settings } = await getEmailContext({
+  const { branding, emailLanguage, senderEmail, replyToEmail } = await getEmailContext({
+    emailType: 'RECIPIENT',
    source: {
      type: 'team',
      teamId: document.teamId,
    },
+    meta: document.documentMeta || null,
  });

-  const lang = documentMeta?.language ?? settings.documentLanguage;
-
-  const i18n = await getI18nInstance(lang);
+  const i18n = await getI18nInstance(emailLanguage);

  // Send confirmation email to the recipient who rejected
  await io.runTask('send-rejection-confirmation-email', async () => {
@ -84,9 +84,9 @@ export const run = async ({
    });

    const [html, text] = await Promise.all([
-      renderEmailWithI18N(recipientTemplate, { lang, branding }),
+      renderEmailWithI18N(recipientTemplate, { lang: emailLanguage, branding }),
      renderEmailWithI18N(recipientTemplate, {
-        lang,
+        lang: emailLanguage,
        branding,
        plainText: true,
      }),
@ -97,10 +97,8 @@ export const run = async ({
        name: recipient.name,
        address: recipient.email,
      },
-      from: {
-        name: FROM_NAME,
-        address: FROM_ADDRESS,
-      },
+      from: senderEmail,
+      replyTo: replyToEmail,
      subject: i18n._(msg`Document "${document.title}" - Rejection Confirmed`),
      html,
      text,
@ -120,9 +118,9 @@ export const run = async ({
    });

    const [html, text] = await Promise.all([
-      renderEmailWithI18N(ownerTemplate, { lang, branding }),
+      renderEmailWithI18N(ownerTemplate, { lang: emailLanguage, branding }),
      renderEmailWithI18N(ownerTemplate, {
-        lang,
+        lang: emailLanguage,
        branding,
        plainText: true,
      }),
@ -133,10 +131,7 @@ export const run = async ({
        name: documentOwner.name || '',
        address: documentOwner.email,
      },
-      from: {
-        name: FROM_NAME,
-        address: FROM_ADDRESS,
-      },
+      from: DOCUMENSO_INTERNAL_EMAIL, // Purposefully using internal email here.
      subject: i18n._(msg`Document "${document.title}" - Rejected by ${recipient.name}`),
      html,
      text,
--- a/packages/lib/jobs/definitions/emails/send-signing-email.handler.ts
+++ b/packages/lib/jobs/definitions/emails/send-signing-email.handler.ts
@ -15,7 +15,6 @@ import { prisma } from '@documenso/prisma';

 import { getI18nInstance } from '../../../client-only/providers/i18n-server';
 import { NEXT_PUBLIC_WEBAPP_URL } from '../../../constants/app';
-import { FROM_ADDRESS, FROM_NAME } from '../../../constants/email';
 import {
  RECIPIENT_ROLES_DESCRIPTION,
  RECIPIENT_ROLE_TO_EMAIL_TYPE,
@ -80,12 +79,15 @@ export const run = async ({
    return;
  }

-  const { branding, settings, organisationType } = await getEmailContext({
-    source: {
-      type: 'team',
-      teamId: document.teamId,
-    },
-  });
+  const { branding, emailLanguage, settings, organisationType, senderEmail, replyToEmail } =
+    await getEmailContext({
+      emailType: 'RECIPIENT',
+      source: {
+        type: 'team',
+        teamId: document.teamId,
+      },
+      meta: document.documentMeta || null,
+    });

  const customEmail = document?.documentMeta;
  const isDirectTemplate = document.source === DocumentSource.TEMPLATE_DIRECT_LINK;
@ -95,9 +97,7 @@ export const run = async ({
  const { email, name } = recipient;
  const selfSigner = email === user.email;

-  const lang = documentMeta?.language ?? settings.documentLanguage;
-
-  const i18n = await getI18nInstance(lang);
+  const i18n = await getI18nInstance(emailLanguage);

  const recipientActionVerb = i18n
    ._(RECIPIENT_ROLES_DESCRIPTION[recipient.role].actionVerb)
@ -166,9 +166,9 @@ export const run = async ({

  await io.runTask('send-signing-email', async () => {
    const [html, text] = await Promise.all([
-      renderEmailWithI18N(template, { lang, branding }),
+      renderEmailWithI18N(template, { lang: emailLanguage, branding }),
      renderEmailWithI18N(template, {
-        lang,
+        lang: emailLanguage,
        branding,
        plainText: true,
      }),
@ -179,10 +179,8 @@ export const run = async ({
        name: recipient.name,
        address: recipient.email,
      },
-      from: {
-        name: FROM_NAME,
-        address: FROM_ADDRESS,
-      },
+      from: senderEmail,
+      replyTo: replyToEmail,
      subject: renderCustomEmailTemplate(
        documentMeta?.subject || emailSubject,
        customEmailTemplate,
--- a/packages/lib/jobs/definitions/internal/bulk-send-template.handler.ts
+++ b/packages/lib/jobs/definitions/internal/bulk-send-template.handler.ts
@ -13,7 +13,6 @@ import { prisma } from '@documenso/prisma';

 import { getI18nInstance } from '../../../client-only/providers/i18n-server';
 import { NEXT_PUBLIC_WEBAPP_URL } from '../../../constants/app';
-import { FROM_ADDRESS, FROM_NAME } from '../../../constants/email';
 import { AppError } from '../../../errors/app-error';
 import { getEmailContext } from '../../../server-only/email/get-email-context';
 import { renderEmailWithI18N } from '../../../utils/render-email-with-i18n';
@ -162,24 +161,23 @@ export const run = async ({
      assetBaseUrl: NEXT_PUBLIC_WEBAPP_URL(),
    });

-    const { branding, settings } = await getEmailContext({
+    const { branding, emailLanguage, senderEmail } = await getEmailContext({
+      emailType: 'INTERNAL',
      source: {
        type: 'team',
        teamId,
      },
    });

-    const lang = template.templateMeta?.language ?? settings.documentLanguage;
-
-    const i18n = await getI18nInstance(lang);
+    const i18n = await getI18nInstance(emailLanguage);

    const [html, text] = await Promise.all([
      renderEmailWithI18N(completionTemplate, {
-        lang,
+        lang: emailLanguage,
        branding,
      }),
      renderEmailWithI18N(completionTemplate, {
-        lang,
+        lang: emailLanguage,
        branding,
        plainText: true,
      }),
@ -190,10 +188,7 @@ export const run = async ({
        name: user.name || '',
        address: user.email,
      },
-      from: {
-        name: FROM_NAME,
-        address: FROM_ADDRESS,
-      },
+      from: senderEmail,
      subject: i18n._(msg`Bulk Send Complete: ${template.title}`),
      html,
      text,