mirror of
https://github.com/documenso/documenso.git
synced 2025-11-13 16:23:06 +10:00
## Description Support setting a document language that will control the language used for sending emails to recipients. Additional work has been done to convert all emails to using our i18n implementation so we can later add controls for sending other kinds of emails in a users target language. ## Related Issue N/A ## Changes Made - Added `<Trans>` and `msg` macros to emails - Introduced a new `renderEmailWithI18N` utility in the lib package - Updated all emails to use the `<Tailwind>` component at the top level due to rendering constraints - Updated the `i18n.server.tsx` file to not use a top level await ## Testing Performed - Configured document language and verified emails were sent in the expected language - Created a document from a template and verified that the templates language was transferred to the document
191 lines
6.0 KiB
TypeScript
191 lines
6.0 KiB
TypeScript
import { createElement } from 'react';
|
|
|
|
import { msg } from '@lingui/macro';
|
|
|
|
import { mailer } from '@documenso/email/mailer';
|
|
import { DocumentCompletedEmailTemplate } from '@documenso/email/templates/document-completed';
|
|
import { prisma } from '@documenso/prisma';
|
|
import { DocumentSource } from '@documenso/prisma/client';
|
|
|
|
import { getI18nInstance } from '../../client-only/providers/i18n.server';
|
|
import { NEXT_PUBLIC_WEBAPP_URL } from '../../constants/app';
|
|
import { DOCUMENT_AUDIT_LOG_TYPE } from '../../types/document-audit-logs';
|
|
import type { RequestMetadata } from '../../universal/extract-request-metadata';
|
|
import { getFile } from '../../universal/upload/get-file';
|
|
import { createDocumentAuditLogData } from '../../utils/document-audit-logs';
|
|
import { renderCustomEmailTemplate } from '../../utils/render-custom-email-template';
|
|
import { renderEmailWithI18N } from '../../utils/render-email-with-i18n';
|
|
|
|
export interface SendDocumentOptions {
|
|
documentId: number;
|
|
requestMetadata?: RequestMetadata;
|
|
}
|
|
|
|
export const sendCompletedEmail = async ({ documentId, requestMetadata }: SendDocumentOptions) => {
|
|
const document = await prisma.document.findUnique({
|
|
where: {
|
|
id: documentId,
|
|
},
|
|
include: {
|
|
documentData: true,
|
|
documentMeta: true,
|
|
Recipient: true,
|
|
User: true,
|
|
team: {
|
|
select: {
|
|
id: true,
|
|
url: true,
|
|
},
|
|
},
|
|
},
|
|
});
|
|
|
|
if (!document) {
|
|
throw new Error('Document not found');
|
|
}
|
|
|
|
const isDirectTemplate = document?.source === DocumentSource.TEMPLATE_DIRECT_LINK;
|
|
|
|
if (document.Recipient.length === 0) {
|
|
throw new Error('Document has no recipients');
|
|
}
|
|
|
|
const { User: owner } = document;
|
|
|
|
const completedDocument = await getFile(document.documentData);
|
|
|
|
const assetBaseUrl = NEXT_PUBLIC_WEBAPP_URL() || 'http://localhost:3000';
|
|
|
|
let documentOwnerDownloadLink = `${NEXT_PUBLIC_WEBAPP_URL()}/documents/${document.id}`;
|
|
|
|
if (document.team?.url) {
|
|
documentOwnerDownloadLink = `${NEXT_PUBLIC_WEBAPP_URL()}/t/${document.team.url}/documents/${
|
|
document.id
|
|
}`;
|
|
}
|
|
|
|
const i18n = await getI18nInstance(document.documentMeta?.language);
|
|
|
|
// If the document owner is not a recipient then send the email to them separately
|
|
if (!document.Recipient.find((recipient) => recipient.email === owner.email)) {
|
|
const template = createElement(DocumentCompletedEmailTemplate, {
|
|
documentName: document.title,
|
|
assetBaseUrl,
|
|
downloadLink: documentOwnerDownloadLink,
|
|
});
|
|
|
|
const [html, text] = await Promise.all([
|
|
renderEmailWithI18N(template, { lang: document.documentMeta?.language }),
|
|
renderEmailWithI18N(template, { lang: document.documentMeta?.language, plainText: true }),
|
|
]);
|
|
|
|
await mailer.sendMail({
|
|
to: [
|
|
{
|
|
name: owner.name || '',
|
|
address: owner.email,
|
|
},
|
|
],
|
|
from: {
|
|
name: process.env.NEXT_PRIVATE_SMTP_FROM_NAME || 'Documenso',
|
|
address: process.env.NEXT_PRIVATE_SMTP_FROM_ADDRESS || 'noreply@documenso.com',
|
|
},
|
|
subject: i18n._(msg`Signing Complete!`),
|
|
html,
|
|
text,
|
|
attachments: [
|
|
{
|
|
filename: document.title.endsWith('.pdf') ? document.title : document.title + '.pdf',
|
|
content: Buffer.from(completedDocument),
|
|
},
|
|
],
|
|
});
|
|
|
|
await prisma.documentAuditLog.create({
|
|
data: createDocumentAuditLogData({
|
|
type: DOCUMENT_AUDIT_LOG_TYPE.EMAIL_SENT,
|
|
documentId: document.id,
|
|
user: null,
|
|
requestMetadata,
|
|
data: {
|
|
emailType: 'DOCUMENT_COMPLETED',
|
|
recipientEmail: owner.email,
|
|
recipientName: owner.name ?? '',
|
|
recipientId: owner.id,
|
|
recipientRole: 'OWNER',
|
|
isResending: false,
|
|
},
|
|
}),
|
|
});
|
|
}
|
|
|
|
await Promise.all(
|
|
document.Recipient.map(async (recipient) => {
|
|
const customEmailTemplate = {
|
|
'signer.name': recipient.name,
|
|
'signer.email': recipient.email,
|
|
'document.name': document.title,
|
|
};
|
|
|
|
const downloadLink = `${NEXT_PUBLIC_WEBAPP_URL()}/sign/${recipient.token}/complete`;
|
|
|
|
const template = createElement(DocumentCompletedEmailTemplate, {
|
|
documentName: document.title,
|
|
assetBaseUrl,
|
|
downloadLink: recipient.email === owner.email ? documentOwnerDownloadLink : downloadLink,
|
|
customBody:
|
|
isDirectTemplate && document.documentMeta?.message
|
|
? renderCustomEmailTemplate(document.documentMeta.message, customEmailTemplate)
|
|
: undefined,
|
|
});
|
|
|
|
const [html, text] = await Promise.all([
|
|
renderEmailWithI18N(template, { lang: document.documentMeta?.language }),
|
|
renderEmailWithI18N(template, { lang: document.documentMeta?.language, plainText: true }),
|
|
]);
|
|
|
|
await mailer.sendMail({
|
|
to: [
|
|
{
|
|
name: recipient.name,
|
|
address: recipient.email,
|
|
},
|
|
],
|
|
from: {
|
|
name: process.env.NEXT_PRIVATE_SMTP_FROM_NAME || 'Documenso',
|
|
address: process.env.NEXT_PRIVATE_SMTP_FROM_ADDRESS || 'noreply@documenso.com',
|
|
},
|
|
subject:
|
|
isDirectTemplate && document.documentMeta?.subject
|
|
? renderCustomEmailTemplate(document.documentMeta.subject, customEmailTemplate)
|
|
: i18n._(msg`Signing Complete!`),
|
|
html,
|
|
text,
|
|
attachments: [
|
|
{
|
|
filename: document.title.endsWith('.pdf') ? document.title : document.title + '.pdf',
|
|
content: Buffer.from(completedDocument),
|
|
},
|
|
],
|
|
});
|
|
|
|
await prisma.documentAuditLog.create({
|
|
data: createDocumentAuditLogData({
|
|
type: DOCUMENT_AUDIT_LOG_TYPE.EMAIL_SENT,
|
|
documentId: document.id,
|
|
user: null,
|
|
requestMetadata,
|
|
data: {
|
|
emailType: 'DOCUMENT_COMPLETED',
|
|
recipientEmail: recipient.email,
|
|
recipientName: recipient.name,
|
|
recipientId: recipient.id,
|
|
recipientRole: recipient.role,
|
|
isResending: false,
|
|
},
|
|
}),
|
|
});
|
|
}),
|
|
);
|
|
};
|