mirror of
https://github.com/xtr-dev/payload-mailing.git
synced 2025-12-10 08:13:23 +00:00
Compare commits
42 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
a40d87c63c | ||
| ccd8ef35c3 | |||
| a12d4c1bee | |||
|
|
fde8eb538d | ||
| 845b379da3 | |||
| dd205dba41 | |||
| a6564e2a29 | |||
| 8f200da449 | |||
|
|
ff94d72d49 | ||
| ddee7d5a76 | |||
|
|
0083e8e1fa | ||
| 63a7eef8d8 | |||
|
|
6cf055178b | ||
| aa978090fa | |||
|
|
556d910e30 | ||
| b4bad70634 | |||
|
|
efdfaf5889 | ||
| ea7d8dfdd5 | |||
| 0d6d07de85 | |||
|
|
f12ac8172e | ||
| 347cd33e13 | |||
|
|
672ab3236a | ||
| c7db65980a | |||
| 624dc12471 | |||
| e20ebe27bf | |||
|
|
7f04275d39 | ||
| 20afe30e88 | |||
| 02b3fecadf | |||
|
|
ea87f14308 | ||
| 6886027727 | |||
| 965569be06 | |||
|
|
ff788c1ecf | ||
| c12438aaa2 | |||
| 4dcbc1446a | |||
|
|
72f3d7f66d | ||
| ecc0b0a73e | |||
| a959673fc1 | |||
| 8809db6aff | |||
|
|
5905f732de | ||
| 4c495a72b0 | |||
| 8518c716e8 | |||
| 570190be01 |
109
README.md
109
README.md
@@ -28,26 +28,31 @@ npm install @xtr-dev/payload-mailing
|
||||
|
||||
## Quick Start
|
||||
|
||||
### 1. Add the plugin to your Payload config
|
||||
### 1. Configure email in your Payload config and add the plugin
|
||||
|
||||
```typescript
|
||||
import { buildConfig } from 'payload/config'
|
||||
import { mailingPlugin } from '@xtr-dev/payload-mailing'
|
||||
import { nodemailerAdapter } from '@payloadcms/email-nodemailer'
|
||||
|
||||
export default buildConfig({
|
||||
// ... your config
|
||||
plugins: [
|
||||
mailingPlugin({
|
||||
defaultFrom: 'noreply@yoursite.com',
|
||||
email: nodemailerAdapter({
|
||||
defaultFromAddress: 'noreply@yoursite.com',
|
||||
defaultFromName: 'Your Site',
|
||||
transport: {
|
||||
host: 'smtp.gmail.com',
|
||||
port: 587,
|
||||
secure: false,
|
||||
auth: {
|
||||
user: process.env.EMAIL_USER,
|
||||
pass: process.env.EMAIL_PASS,
|
||||
},
|
||||
},
|
||||
}),
|
||||
plugins: [
|
||||
mailingPlugin({
|
||||
defaultFrom: 'noreply@yoursite.com',
|
||||
defaultFromName: 'Your Site Name',
|
||||
retryAttempts: 3,
|
||||
retryDelay: 300000, // 5 minutes
|
||||
queue: 'email-queue', // optional
|
||||
@@ -119,13 +124,6 @@ mailingPlugin({
|
||||
return yourCustomEngine.render(template, variables)
|
||||
},
|
||||
|
||||
// Email transport
|
||||
transport: {
|
||||
host: 'smtp.gmail.com',
|
||||
port: 587,
|
||||
auth: { user: '...', pass: '...' }
|
||||
},
|
||||
|
||||
// Collection names (optional)
|
||||
collections: {
|
||||
templates: 'email-templates', // default
|
||||
@@ -142,6 +140,18 @@ mailingPlugin({
|
||||
richTextEditor: lexicalEditor(), // optional custom editor
|
||||
onReady: async (payload) => { // optional initialization hook
|
||||
console.log('Mailing plugin ready!')
|
||||
},
|
||||
|
||||
// beforeSend hook - modify emails before sending
|
||||
beforeSend: async (options, email) => {
|
||||
// Add attachments, modify headers, etc.
|
||||
options.attachments = [
|
||||
{ filename: 'invoice.pdf', content: pdfBuffer }
|
||||
]
|
||||
options.headers = {
|
||||
'X-Campaign-ID': email.campaignId
|
||||
}
|
||||
return options
|
||||
}
|
||||
})
|
||||
```
|
||||
@@ -255,6 +265,56 @@ mailingPlugin({
|
||||
})
|
||||
```
|
||||
|
||||
### beforeSend Hook
|
||||
|
||||
Modify emails before they are sent to add attachments, custom headers, or make other changes:
|
||||
|
||||
```typescript
|
||||
mailingPlugin({
|
||||
// ... other config
|
||||
beforeSend: async (options, email) => {
|
||||
// Add attachments dynamically
|
||||
if (email.invoiceId) {
|
||||
const invoice = await generateInvoicePDF(email.invoiceId)
|
||||
options.attachments = [
|
||||
{
|
||||
filename: `invoice-${email.invoiceId}.pdf`,
|
||||
content: invoice.buffer,
|
||||
contentType: 'application/pdf'
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
// Add custom headers
|
||||
options.headers = {
|
||||
'X-Campaign-ID': email.campaignId,
|
||||
'X-Customer-ID': email.customerId,
|
||||
'X-Priority': email.priority === 1 ? 'High' : 'Normal'
|
||||
}
|
||||
|
||||
// Modify recipients based on conditions
|
||||
if (process.env.NODE_ENV === 'development') {
|
||||
// Redirect all emails to test address in dev
|
||||
options.to = ['test@example.com']
|
||||
options.subject = `[TEST] ${options.subject}`
|
||||
}
|
||||
|
||||
// Add BCC for compliance
|
||||
if (email.requiresAudit) {
|
||||
options.bcc = ['audit@company.com']
|
||||
}
|
||||
|
||||
return options
|
||||
}
|
||||
})
|
||||
```
|
||||
|
||||
The `beforeSend` hook receives:
|
||||
- `options`: The nodemailer mail options that will be sent
|
||||
- `email`: The full email document from the database
|
||||
|
||||
You must return the modified options object.
|
||||
|
||||
### Initialization Hooks
|
||||
|
||||
Control plugin initialization order and add post-initialization logic:
|
||||
@@ -320,9 +380,9 @@ await processEmails(payload)
|
||||
await retryFailedEmails(payload)
|
||||
```
|
||||
|
||||
## PayloadCMS Task Integration
|
||||
## PayloadCMS Integration
|
||||
|
||||
The plugin provides a ready-to-use PayloadCMS task for queuing template emails:
|
||||
The plugin provides PayloadCMS tasks for email processing:
|
||||
|
||||
### 1. Add the task to your Payload config
|
||||
|
||||
@@ -395,6 +455,27 @@ The task can also be triggered from the Payload admin panel with a user-friendly
|
||||
- ✅ **Error Handling**: Comprehensive error reporting
|
||||
- ✅ **Queue Management**: Leverage Payload's job queue system
|
||||
|
||||
### Immediate Processing
|
||||
|
||||
The send email task now supports immediate processing. Enable the `processImmediately` option to send emails instantly:
|
||||
|
||||
```typescript
|
||||
await payload.jobs.queue({
|
||||
task: 'send-email',
|
||||
input: {
|
||||
processImmediately: true, // Send immediately (default: false)
|
||||
templateSlug: 'welcome-email',
|
||||
to: ['user@example.com'],
|
||||
variables: { name: 'John' }
|
||||
}
|
||||
})
|
||||
```
|
||||
|
||||
**Benefits**:
|
||||
- No separate workflow needed
|
||||
- Unified task interface
|
||||
- Optional immediate processing when needed
|
||||
|
||||
## Job Processing
|
||||
|
||||
The plugin automatically adds a unified email processing job to PayloadCMS:
|
||||
|
||||
@@ -248,6 +248,10 @@ export interface Email {
|
||||
* Sender email address (optional, uses default if not provided)
|
||||
*/
|
||||
from?: string | null;
|
||||
/**
|
||||
* Sender display name (optional, e.g., "John Doe" for "John Doe <john@example.com>")
|
||||
*/
|
||||
fromName?: string | null;
|
||||
/**
|
||||
* Reply-to email address
|
||||
*/
|
||||
@@ -543,6 +547,7 @@ export interface EmailsSelect<T extends boolean = true> {
|
||||
cc?: T;
|
||||
bcc?: T;
|
||||
from?: T;
|
||||
fromName?: T;
|
||||
replyTo?: T;
|
||||
subject?: T;
|
||||
html?: T;
|
||||
@@ -675,6 +680,18 @@ export interface TaskSendEmail {
|
||||
* Optional comma-separated list of BCC email addresses
|
||||
*/
|
||||
bcc?: string | null;
|
||||
/**
|
||||
* Optional sender email address (uses default if not provided)
|
||||
*/
|
||||
from?: string | null;
|
||||
/**
|
||||
* Optional sender display name (e.g., "John Doe")
|
||||
*/
|
||||
fromName?: string | null;
|
||||
/**
|
||||
* Optional reply-to email address
|
||||
*/
|
||||
replyTo?: string | null;
|
||||
/**
|
||||
* Optional date/time to schedule email for future delivery
|
||||
*/
|
||||
@@ -684,7 +701,9 @@ export interface TaskSendEmail {
|
||||
*/
|
||||
priority?: number | null;
|
||||
};
|
||||
output?: unknown;
|
||||
output: {
|
||||
id?: string | null;
|
||||
};
|
||||
}
|
||||
/**
|
||||
* This interface was referenced by `Config`'s JSON-Schema
|
||||
|
||||
@@ -135,15 +135,6 @@ const buildConfigWithMemoryDB = async () => {
|
||||
mailingPlugin({
|
||||
defaultFrom: 'noreply@test.com',
|
||||
initOrder: 'after',
|
||||
transport: {
|
||||
host: 'localhost',
|
||||
port: 1025, // MailHog port for dev
|
||||
secure: false,
|
||||
auth: {
|
||||
user: 'test',
|
||||
pass: 'test',
|
||||
},
|
||||
},
|
||||
retryAttempts: 3,
|
||||
retryDelay: 60000, // 1 minute for dev
|
||||
queue: 'email-queue',
|
||||
|
||||
113
dev/test-hook-validation.ts
Normal file
113
dev/test-hook-validation.ts
Normal file
@@ -0,0 +1,113 @@
|
||||
// Test hook validation in the dev environment
|
||||
import { getPayload } from 'payload'
|
||||
import config from './payload.config.js'
|
||||
|
||||
async function testHookValidation() {
|
||||
const payload = await getPayload({ config: await config })
|
||||
|
||||
console.log('\n🧪 Testing beforeSend hook validation...\n')
|
||||
|
||||
// Test 1: Create an email to process
|
||||
const email = await payload.create({
|
||||
collection: 'emails',
|
||||
data: {
|
||||
to: ['test@example.com'],
|
||||
subject: 'Test Email for Validation',
|
||||
html: '<p>Testing hook validation</p>',
|
||||
text: 'Testing hook validation',
|
||||
status: 'pending'
|
||||
}
|
||||
})
|
||||
|
||||
console.log('✅ Test email created:', email.id)
|
||||
|
||||
// Get the mailing service
|
||||
const mailingService = (payload as any).mailing.service
|
||||
|
||||
// Test 2: Temporarily replace the config with a bad hook
|
||||
const originalBeforeSend = mailingService.config.beforeSend
|
||||
|
||||
console.log('\n📝 Test: Hook that removes "from" field...')
|
||||
mailingService.config.beforeSend = async (options: any, email: any) => {
|
||||
delete options.from
|
||||
return options
|
||||
}
|
||||
|
||||
try {
|
||||
await mailingService.processEmails()
|
||||
console.log('❌ Should have thrown error for missing "from"')
|
||||
} catch (error: any) {
|
||||
if (error.message.includes('must not remove the "from" property')) {
|
||||
console.log('✅ Correctly caught missing "from" field')
|
||||
} else {
|
||||
console.log('❌ Unexpected error:', error.message)
|
||||
}
|
||||
}
|
||||
|
||||
console.log('\n📝 Test: Hook that empties "to" array...')
|
||||
mailingService.config.beforeSend = async (options: any, email: any) => {
|
||||
options.to = []
|
||||
return options
|
||||
}
|
||||
|
||||
try {
|
||||
await mailingService.processEmails()
|
||||
console.log('❌ Should have thrown error for empty "to"')
|
||||
} catch (error: any) {
|
||||
if (error.message.includes('must not remove or empty the "to" property')) {
|
||||
console.log('✅ Correctly caught empty "to" array')
|
||||
} else {
|
||||
console.log('❌ Unexpected error:', error.message)
|
||||
}
|
||||
}
|
||||
|
||||
console.log('\n📝 Test: Hook that removes "subject"...')
|
||||
mailingService.config.beforeSend = async (options: any, email: any) => {
|
||||
delete options.subject
|
||||
return options
|
||||
}
|
||||
|
||||
try {
|
||||
await mailingService.processEmails()
|
||||
console.log('❌ Should have thrown error for missing "subject"')
|
||||
} catch (error: any) {
|
||||
if (error.message.includes('must not remove the "subject" property')) {
|
||||
console.log('✅ Correctly caught missing "subject" field')
|
||||
} else {
|
||||
console.log('❌ Unexpected error:', error.message)
|
||||
}
|
||||
}
|
||||
|
||||
console.log('\n📝 Test: Hook that removes both "html" and "text"...')
|
||||
mailingService.config.beforeSend = async (options: any, email: any) => {
|
||||
delete options.html
|
||||
delete options.text
|
||||
return options
|
||||
}
|
||||
|
||||
try {
|
||||
await mailingService.processEmails()
|
||||
console.log('❌ Should have thrown error for missing content')
|
||||
} catch (error: any) {
|
||||
if (error.message.includes('must not remove both "html" and "text" properties')) {
|
||||
console.log('✅ Correctly caught missing content fields')
|
||||
} else {
|
||||
console.log('❌ Unexpected error:', error.message)
|
||||
}
|
||||
}
|
||||
|
||||
// Restore original hook
|
||||
mailingService.config.beforeSend = originalBeforeSend
|
||||
|
||||
console.log('\n✅ All validation tests completed!\n')
|
||||
|
||||
// Clean up
|
||||
await payload.delete({
|
||||
collection: 'emails',
|
||||
id: email.id
|
||||
})
|
||||
|
||||
process.exit(0)
|
||||
}
|
||||
|
||||
testHookValidation().catch(console.error)
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@xtr-dev/payload-mailing",
|
||||
"version": "0.1.12",
|
||||
"version": "0.4.1",
|
||||
"description": "Template-based email system with scheduling and job processing for PayloadCMS",
|
||||
"type": "module",
|
||||
"main": "dist/index.js",
|
||||
|
||||
@@ -49,6 +49,13 @@ const Emails: CollectionConfig = {
|
||||
description: 'Sender email address (optional, uses default if not provided)',
|
||||
},
|
||||
},
|
||||
{
|
||||
name: 'fromName',
|
||||
type: 'text',
|
||||
admin: {
|
||||
description: 'Sender display name (optional, e.g., "John Doe" for "John Doe <john@example.com>")',
|
||||
},
|
||||
},
|
||||
{
|
||||
name: 'replyTo',
|
||||
type: 'text',
|
||||
|
||||
@@ -27,3 +27,6 @@ export {
|
||||
retryFailedEmails,
|
||||
parseAndValidateEmails,
|
||||
} from './utils/helpers.js'
|
||||
|
||||
// Email processing utilities
|
||||
export { processEmailById, processAllEmails } from './utils/emailProcessor.js'
|
||||
@@ -1,35 +1,14 @@
|
||||
import { processEmailsJob, ProcessEmailsJobData } from './processEmailsJob.js'
|
||||
import { processEmailsJob } from './processEmailsTask.js'
|
||||
import { sendEmailJob } from './sendEmailTask.js'
|
||||
import { MailingService } from '../services/MailingService.js'
|
||||
|
||||
/**
|
||||
* All mailing-related jobs that get registered with Payload
|
||||
*/
|
||||
export const mailingJobs = [
|
||||
{
|
||||
slug: 'processEmails',
|
||||
handler: async ({ job, req }: { job: any; req: any }) => {
|
||||
// Get mailing context from payload
|
||||
const payload = (req as any).payload
|
||||
const mailingContext = payload.mailing
|
||||
if (!mailingContext) {
|
||||
throw new Error('Mailing plugin not properly initialized')
|
||||
}
|
||||
|
||||
// Use the existing mailing service from context
|
||||
await processEmailsJob(
|
||||
job as { data: ProcessEmailsJobData },
|
||||
{ req, mailingService: mailingContext.service }
|
||||
)
|
||||
|
||||
return {
|
||||
output: {
|
||||
success: true,
|
||||
message: 'Email queue processing completed successfully'
|
||||
}
|
||||
}
|
||||
},
|
||||
interfaceName: 'ProcessEmailsJob',
|
||||
},
|
||||
processEmailsJob,
|
||||
sendEmailJob,
|
||||
]
|
||||
|
||||
export * from './processEmailsJob.js'
|
||||
// Re-export everything from individual job files
|
||||
export * from './processEmailsTask.js'
|
||||
export * from './sendEmailTask.js'
|
||||
@@ -1,50 +0,0 @@
|
||||
import type { PayloadRequest } from 'payload'
|
||||
import { MailingService } from '../services/MailingService.js'
|
||||
|
||||
export interface ProcessEmailsJobData {
|
||||
// No type needed - always processes both pending and failed emails
|
||||
}
|
||||
|
||||
export const processEmailsJob = async (
|
||||
job: { data: ProcessEmailsJobData },
|
||||
context: { req: PayloadRequest; mailingService: MailingService }
|
||||
) => {
|
||||
const { mailingService } = context
|
||||
|
||||
try {
|
||||
console.log('🔄 Processing email queue (pending + failed emails)...')
|
||||
|
||||
// Process pending emails first
|
||||
await mailingService.processEmails()
|
||||
|
||||
// Then retry failed emails
|
||||
await mailingService.retryFailedEmails()
|
||||
|
||||
console.log('✅ Email queue processing completed successfully (pending and failed emails)')
|
||||
} catch (error) {
|
||||
console.error('❌ Email queue processing failed:', error)
|
||||
throw error
|
||||
}
|
||||
}
|
||||
|
||||
export const scheduleEmailsJob = async (
|
||||
payload: any,
|
||||
queueName: string,
|
||||
delay?: number
|
||||
) => {
|
||||
if (!payload.jobs) {
|
||||
console.warn('PayloadCMS jobs not configured - emails will not be processed automatically')
|
||||
return
|
||||
}
|
||||
|
||||
try {
|
||||
await payload.jobs.queue({
|
||||
queue: queueName,
|
||||
task: 'processEmails',
|
||||
input: {},
|
||||
waitUntil: delay ? new Date(Date.now() + delay) : undefined,
|
||||
})
|
||||
} catch (error) {
|
||||
console.error('Failed to schedule email processing job:', error)
|
||||
}
|
||||
}
|
||||
93
src/jobs/processEmailsTask.ts
Normal file
93
src/jobs/processEmailsTask.ts
Normal file
@@ -0,0 +1,93 @@
|
||||
import type { PayloadRequest, Payload } from 'payload'
|
||||
import { processAllEmails } from '../utils/emailProcessor.js'
|
||||
|
||||
/**
|
||||
* Data passed to the process emails task
|
||||
*/
|
||||
export interface ProcessEmailsTaskData {
|
||||
// Currently no data needed - always processes both pending and failed emails
|
||||
}
|
||||
|
||||
/**
|
||||
* Handler function for processing emails
|
||||
* Used internally by the task definition
|
||||
*/
|
||||
export const processEmailsTaskHandler = async (
|
||||
job: { data: ProcessEmailsTaskData },
|
||||
context: { req: PayloadRequest }
|
||||
) => {
|
||||
const { req } = context
|
||||
const payload = (req as any).payload
|
||||
|
||||
try {
|
||||
console.log('🔄 Processing email queue (pending + failed emails)...')
|
||||
|
||||
// Use the shared email processing logic
|
||||
await processAllEmails(payload)
|
||||
|
||||
console.log('✅ Email queue processing completed successfully')
|
||||
} catch (error) {
|
||||
console.error('❌ Email queue processing failed:', error)
|
||||
throw error
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Task definition for processing emails
|
||||
* This is what gets registered with Payload's job system
|
||||
*/
|
||||
export const processEmailsTask = {
|
||||
slug: 'process-emails',
|
||||
handler: async ({ job, req }: { job: any; req: any }) => {
|
||||
// Get mailing context from payload
|
||||
const payload = (req as any).payload
|
||||
const mailingContext = payload.mailing
|
||||
|
||||
if (!mailingContext) {
|
||||
throw new Error('Mailing plugin not properly initialized')
|
||||
}
|
||||
|
||||
// Use the task handler
|
||||
await processEmailsTaskHandler(
|
||||
job as { data: ProcessEmailsTaskData },
|
||||
{ req }
|
||||
)
|
||||
|
||||
return {
|
||||
output: {
|
||||
success: true,
|
||||
message: 'Email queue processing completed successfully'
|
||||
}
|
||||
}
|
||||
},
|
||||
interfaceName: 'ProcessEmailsTask',
|
||||
}
|
||||
|
||||
// For backward compatibility, export as processEmailsJob
|
||||
export const processEmailsJob = processEmailsTask
|
||||
|
||||
/**
|
||||
* Helper function to schedule an email processing job
|
||||
* Used by the plugin during initialization and can be used by developers
|
||||
*/
|
||||
export const scheduleEmailsJob = async (
|
||||
payload: Payload,
|
||||
queueName: string,
|
||||
delay?: number
|
||||
) => {
|
||||
if (!payload.jobs) {
|
||||
console.warn('PayloadCMS jobs not configured - emails will not be processed automatically')
|
||||
return
|
||||
}
|
||||
|
||||
try {
|
||||
await payload.jobs.queue({
|
||||
queue: queueName,
|
||||
task: 'process-emails',
|
||||
input: {},
|
||||
waitUntil: delay ? new Date(Date.now() + delay) : undefined,
|
||||
} as any)
|
||||
} catch (error) {
|
||||
console.error('Failed to schedule email processing job:', error)
|
||||
}
|
||||
}
|
||||
@@ -1,5 +1,6 @@
|
||||
import { sendEmail } from '../sendEmail.js'
|
||||
import {Email, EmailTemplate} from '../payload-types.js'
|
||||
import { BaseEmailDocument } from '../types/index.js'
|
||||
import { processEmailById } from '../utils/emailProcessor.js'
|
||||
|
||||
export interface SendEmailTaskInput {
|
||||
// Template mode fields
|
||||
@@ -15,8 +16,12 @@ export interface SendEmailTaskInput {
|
||||
to: string | string[]
|
||||
cc?: string | string[]
|
||||
bcc?: string | string[]
|
||||
scheduledAt?: string // ISO date string
|
||||
from?: string
|
||||
fromName?: string
|
||||
replyTo?: string
|
||||
scheduledAt?: string | Date // ISO date string or Date object
|
||||
priority?: number
|
||||
processImmediately?: boolean // If true, process the email immediately instead of waiting for the queue
|
||||
|
||||
// Allow any additional fields that users might have in their email collection
|
||||
[key: string]: any
|
||||
@@ -39,10 +44,10 @@ function transformTaskInputToSendEmailOptions(taskInput: SendEmailTaskInput) {
|
||||
}
|
||||
|
||||
// Standard email fields that should be copied to data
|
||||
const standardFields = ['to', 'cc', 'bcc', 'subject', 'html', 'text', 'scheduledAt', 'priority']
|
||||
const standardFields = ['to', 'cc', 'bcc', 'from', 'fromName', 'replyTo', 'subject', 'html', 'text', 'scheduledAt', 'priority']
|
||||
|
||||
// Template-specific fields that should not be copied to data
|
||||
const templateFields = ['templateSlug', 'variables']
|
||||
// Fields that should not be copied to data
|
||||
const excludedFields = ['templateSlug', 'variables', 'processImmediately']
|
||||
|
||||
// Copy standard fields to data
|
||||
standardFields.forEach(field => {
|
||||
@@ -51,9 +56,9 @@ function transformTaskInputToSendEmailOptions(taskInput: SendEmailTaskInput) {
|
||||
}
|
||||
})
|
||||
|
||||
// Copy any additional custom fields that aren't template or standard fields
|
||||
// Copy any additional custom fields that aren't excluded or standard fields
|
||||
Object.keys(taskInput).forEach(key => {
|
||||
if (!templateFields.includes(key) && !standardFields.includes(key)) {
|
||||
if (!excludedFields.includes(key) && !standardFields.includes(key)) {
|
||||
sendEmailOptions.data[key] = taskInput[key]
|
||||
}
|
||||
})
|
||||
@@ -61,10 +66,23 @@ function transformTaskInputToSendEmailOptions(taskInput: SendEmailTaskInput) {
|
||||
return sendEmailOptions
|
||||
}
|
||||
|
||||
/**
|
||||
* Job definition for sending emails
|
||||
* Can be used through Payload's job queue system to send emails programmatically
|
||||
*/
|
||||
export const sendEmailJob = {
|
||||
slug: 'send-email',
|
||||
label: 'Send Email',
|
||||
inputSchema: [
|
||||
{
|
||||
name: 'processImmediately',
|
||||
type: 'checkbox' as const,
|
||||
label: 'Process Immediately',
|
||||
defaultValue: false,
|
||||
admin: {
|
||||
description: 'Process and send the email immediately instead of waiting for the queue processor'
|
||||
}
|
||||
},
|
||||
{
|
||||
name: 'templateSlug',
|
||||
type: 'text' as const,
|
||||
@@ -135,12 +153,37 @@ export const sendEmailJob = {
|
||||
description: 'Optional comma-separated list of BCC email addresses'
|
||||
}
|
||||
},
|
||||
{
|
||||
name: 'from',
|
||||
type: 'text' as const,
|
||||
label: 'From Email',
|
||||
admin: {
|
||||
description: 'Optional sender email address (uses default if not provided)'
|
||||
}
|
||||
},
|
||||
{
|
||||
name: 'fromName',
|
||||
type: 'text' as const,
|
||||
label: 'From Name',
|
||||
admin: {
|
||||
description: 'Optional sender display name (e.g., "John Doe")'
|
||||
}
|
||||
},
|
||||
{
|
||||
name: 'replyTo',
|
||||
type: 'text' as const,
|
||||
label: 'Reply To',
|
||||
admin: {
|
||||
description: 'Optional reply-to email address'
|
||||
}
|
||||
},
|
||||
{
|
||||
name: 'scheduledAt',
|
||||
type: 'date' as const,
|
||||
label: 'Schedule For',
|
||||
admin: {
|
||||
description: 'Optional date/time to schedule email for future delivery'
|
||||
description: 'Optional date/time to schedule email for future delivery',
|
||||
condition: (data: any) => !data.processImmediately
|
||||
}
|
||||
},
|
||||
{
|
||||
@@ -164,30 +207,47 @@ export const sendEmailJob = {
|
||||
handler: async ({ input, payload }: any) => {
|
||||
// Cast input to our expected type
|
||||
const taskInput = input as SendEmailTaskInput
|
||||
const shouldProcessImmediately = taskInput.processImmediately || false
|
||||
|
||||
try {
|
||||
// Transform task input into sendEmail options using helper function
|
||||
const sendEmailOptions = transformTaskInputToSendEmailOptions(taskInput)
|
||||
|
||||
// Use the sendEmail helper to create the email
|
||||
const email = await sendEmail<Email>(payload, sendEmailOptions)
|
||||
const email = await sendEmail<BaseEmailDocument>(payload, sendEmailOptions)
|
||||
|
||||
// If processImmediately is true, process the email now
|
||||
if (shouldProcessImmediately) {
|
||||
console.log(`⚡ Processing email ${email.id} immediately...`)
|
||||
await processEmailById(payload, String(email.id))
|
||||
console.log(`✅ Email ${email.id} processed and sent immediately`)
|
||||
|
||||
return {
|
||||
output: {
|
||||
success: true,
|
||||
id: email.id,
|
||||
status: 'sent',
|
||||
processedImmediately: true
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return {
|
||||
output: {
|
||||
success: true,
|
||||
id: email.id,
|
||||
status: 'queued',
|
||||
processedImmediately: false
|
||||
}
|
||||
}
|
||||
|
||||
} catch (error) {
|
||||
// Re-throw Error instances to preserve stack trace and error context
|
||||
if (error instanceof Error) {
|
||||
// Preserve original error and stack trace
|
||||
const wrappedError = new Error(`Failed to queue email: ${error.message}`)
|
||||
wrappedError.stack = error.stack
|
||||
wrappedError.cause = error
|
||||
throw wrappedError
|
||||
throw error
|
||||
} else {
|
||||
throw new Error(`Failed to queue email: ${String(error)}`)
|
||||
// Only wrap non-Error values
|
||||
throw new Error(`Failed to process email: ${String(error)}`)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -143,6 +143,10 @@ export interface Email {
|
||||
* Sender email address (optional, uses default if not provided)
|
||||
*/
|
||||
from?: string | null;
|
||||
/**
|
||||
* Sender display name (optional, e.g., "John Doe" for "John Doe <john@example.com>")
|
||||
*/
|
||||
fromName?: string | null;
|
||||
/**
|
||||
* Reply-to email address
|
||||
*/
|
||||
@@ -336,6 +340,7 @@ export interface EmailsSelect<T extends boolean = true> {
|
||||
cc?: T;
|
||||
bcc?: T;
|
||||
from?: T;
|
||||
fromName?: T;
|
||||
replyTo?: T;
|
||||
subject?: T;
|
||||
html?: T;
|
||||
|
||||
@@ -9,12 +9,6 @@ import { mailingJobs, scheduleEmailsJob } from './jobs/index.js'
|
||||
export const mailingPlugin = (pluginConfig: MailingPluginConfig) => (config: Config): Config => {
|
||||
const queueName = pluginConfig.queue || 'default'
|
||||
|
||||
// Validate queueName
|
||||
if (!queueName || typeof queueName !== 'string') {
|
||||
throw new Error('Invalid queue configuration: queue must be a non-empty string')
|
||||
}
|
||||
|
||||
|
||||
// Handle templates collection configuration
|
||||
const templatesConfig = pluginConfig.collections?.templates
|
||||
const templatesSlug = typeof templatesConfig === 'string' ? templatesConfig : 'email-templates'
|
||||
@@ -74,10 +68,15 @@ export const mailingPlugin = (pluginConfig: MailingPluginConfig) => (config: Con
|
||||
}),
|
||||
} satisfies CollectionConfig
|
||||
|
||||
// Filter out any existing collections with the same slugs to prevent duplicates
|
||||
const existingCollections = (config.collections || []).filter(
|
||||
(collection) => collection.slug !== templatesSlug && collection.slug !== emailsSlug
|
||||
)
|
||||
|
||||
return {
|
||||
...config,
|
||||
collections: [
|
||||
...(config.collections || []),
|
||||
...existingCollections,
|
||||
templatesCollection,
|
||||
emailsCollection,
|
||||
],
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
import { Payload } from 'payload'
|
||||
import { getMailing, renderTemplate, parseAndValidateEmails } from './utils/helpers.js'
|
||||
import {Email, EmailTemplate} from "./payload-types.js"
|
||||
import { BaseEmailDocument } from './types/index.js'
|
||||
|
||||
// Options for sending emails
|
||||
export interface SendEmailOptions<T extends Email = Email> {
|
||||
export interface SendEmailOptions<T extends BaseEmailDocument = BaseEmailDocument> {
|
||||
// Template-based email
|
||||
template?: {
|
||||
slug: string
|
||||
@@ -35,7 +35,7 @@ export interface SendEmailOptions<T extends Email = Email> {
|
||||
* })
|
||||
* ```
|
||||
*/
|
||||
export const sendEmail = async <TEmail extends Email = Email>(
|
||||
export const sendEmail = async <TEmail extends BaseEmailDocument = BaseEmailDocument>(
|
||||
payload: Payload,
|
||||
options: SendEmailOptions<TEmail>
|
||||
): Promise<TEmail> => {
|
||||
@@ -89,6 +89,44 @@ export const sendEmail = async <TEmail extends Email = Email>(
|
||||
if (emailData.bcc) {
|
||||
emailData.bcc = parseAndValidateEmails(emailData.bcc as string | string[])
|
||||
}
|
||||
if (emailData.replyTo) {
|
||||
const validated = parseAndValidateEmails(emailData.replyTo as string | string[])
|
||||
// replyTo should be a single email, so take the first one if array
|
||||
emailData.replyTo = validated && validated.length > 0 ? validated[0] : undefined
|
||||
}
|
||||
if (emailData.from) {
|
||||
const validated = parseAndValidateEmails(emailData.from as string | string[])
|
||||
// from should be a single email, so take the first one if array
|
||||
emailData.from = validated && validated.length > 0 ? validated[0] : undefined
|
||||
}
|
||||
|
||||
// Sanitize fromName to prevent header injection
|
||||
if (emailData.fromName) {
|
||||
emailData.fromName = emailData.fromName
|
||||
.trim()
|
||||
// Remove/replace newlines and carriage returns to prevent header injection
|
||||
.replace(/[\r\n]/g, ' ')
|
||||
// Remove control characters (except space and printable characters)
|
||||
.replace(/[\x00-\x1F\x7F-\x9F]/g, '')
|
||||
// Note: We don't escape quotes here as that's handled in MailingService
|
||||
}
|
||||
|
||||
// Normalize Date objects to ISO strings for consistent database storage
|
||||
if (emailData.scheduledAt instanceof Date) {
|
||||
emailData.scheduledAt = emailData.scheduledAt.toISOString()
|
||||
}
|
||||
if (emailData.sentAt instanceof Date) {
|
||||
emailData.sentAt = emailData.sentAt.toISOString()
|
||||
}
|
||||
if (emailData.lastAttemptAt instanceof Date) {
|
||||
emailData.lastAttemptAt = emailData.lastAttemptAt.toISOString()
|
||||
}
|
||||
if (emailData.createdAt instanceof Date) {
|
||||
emailData.createdAt = emailData.createdAt.toISOString()
|
||||
}
|
||||
if (emailData.updatedAt instanceof Date) {
|
||||
emailData.updatedAt = emailData.updatedAt.toISOString()
|
||||
}
|
||||
|
||||
// Create the email in the collection with proper typing
|
||||
const email = await payload.create({
|
||||
|
||||
@@ -1,23 +1,20 @@
|
||||
import { Payload } from 'payload'
|
||||
import { Liquid } from 'liquidjs'
|
||||
import nodemailer, { Transporter } from 'nodemailer'
|
||||
import {
|
||||
MailingPluginConfig,
|
||||
TemplateVariables,
|
||||
MailingService as IMailingService,
|
||||
MailingTransportConfig,
|
||||
BaseEmail, BaseEmailTemplate
|
||||
BaseEmail, BaseEmailTemplate, BaseEmailDocument, BaseEmailTemplateDocument
|
||||
} from '../types/index.js'
|
||||
import { serializeRichTextToHTML, serializeRichTextToText } from '../utils/richTextSerializer.js'
|
||||
|
||||
export class MailingService implements IMailingService {
|
||||
public payload: Payload
|
||||
private config: MailingPluginConfig
|
||||
private transporter!: Transporter | any
|
||||
private emailAdapter: any
|
||||
private templatesCollection: string
|
||||
private emailsCollection: string
|
||||
private liquid: Liquid | null | false = null
|
||||
private transporterInitialized = false
|
||||
|
||||
constructor(payload: Payload, config: MailingPluginConfig) {
|
||||
this.payload = payload
|
||||
@@ -29,49 +26,55 @@ export class MailingService implements IMailingService {
|
||||
const emailsConfig = config.collections?.emails
|
||||
this.emailsCollection = typeof emailsConfig === 'string' ? emailsConfig : 'emails'
|
||||
|
||||
// Only initialize transporter if payload is properly set
|
||||
if (payload && payload.db) {
|
||||
this.initializeTransporter()
|
||||
// Use Payload's configured email adapter
|
||||
if (!this.payload.email) {
|
||||
throw new Error('Payload email configuration is required. Please configure email in your Payload config.')
|
||||
}
|
||||
}
|
||||
|
||||
private initializeTransporter(): void {
|
||||
if (this.transporterInitialized) return
|
||||
|
||||
if (this.config.transport) {
|
||||
if ('sendMail' in this.config.transport) {
|
||||
this.transporter = this.config.transport
|
||||
} else {
|
||||
this.transporter = nodemailer.createTransport(this.config.transport as MailingTransportConfig)
|
||||
}
|
||||
} else if (this.payload.email && 'sendMail' in this.payload.email) {
|
||||
// Use Payload's configured mailer (cast to any to handle different adapter types)
|
||||
this.transporter = this.payload.email as any
|
||||
} else {
|
||||
throw new Error('Email transport configuration is required either in plugin config or Payload config')
|
||||
}
|
||||
|
||||
this.transporterInitialized = true
|
||||
this.emailAdapter = this.payload.email
|
||||
}
|
||||
|
||||
private ensureInitialized(): void {
|
||||
if (!this.payload || !this.payload.db) {
|
||||
throw new Error('MailingService payload not properly initialized')
|
||||
}
|
||||
if (!this.transporterInitialized) {
|
||||
this.initializeTransporter()
|
||||
if (!this.emailAdapter) {
|
||||
throw new Error('Email adapter not configured. Please ensure Payload has email configured.')
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Sanitizes a display name for use in email headers to prevent header injection
|
||||
* and ensure proper formatting
|
||||
*/
|
||||
private sanitizeDisplayName(name: string): string {
|
||||
return name
|
||||
.trim()
|
||||
// Remove/replace newlines and carriage returns to prevent header injection
|
||||
.replace(/[\r\n]/g, ' ')
|
||||
// Remove control characters (except space and printable characters)
|
||||
.replace(/[\x00-\x1F\x7F-\x9F]/g, '')
|
||||
// Escape quotes to prevent malformed headers
|
||||
.replace(/"/g, '\\"')
|
||||
}
|
||||
|
||||
/**
|
||||
* Formats an email address with optional display name
|
||||
*/
|
||||
private formatEmailAddress(email: string, displayName?: string | null): string {
|
||||
if (displayName && displayName.trim()) {
|
||||
const sanitizedName = this.sanitizeDisplayName(displayName)
|
||||
return `"${sanitizedName}" <${email}>`
|
||||
}
|
||||
return email
|
||||
}
|
||||
|
||||
private getDefaultFrom(): string {
|
||||
const fromEmail = this.config.defaultFrom
|
||||
const fromName = this.config.defaultFromName
|
||||
|
||||
// Check if fromName exists, is not empty after trimming, and fromEmail exists
|
||||
if (fromName && fromName.trim() && fromEmail) {
|
||||
// Escape quotes in the display name to prevent malformed headers
|
||||
const escapedName = fromName.replace(/"/g, '\\"')
|
||||
return `"${escapedName}" <${fromEmail}>`
|
||||
return this.formatEmailAddress(fromEmail, fromName)
|
||||
}
|
||||
|
||||
return fromEmail || ''
|
||||
@@ -131,7 +134,7 @@ export class MailingService implements IMailingService {
|
||||
}
|
||||
|
||||
const emailContent = await this.renderEmailTemplate(template, variables)
|
||||
const subject = await this.renderTemplateString(template.subject, variables)
|
||||
const subject = await this.renderTemplateString(template.subject || '', variables)
|
||||
|
||||
return {
|
||||
html: emailContent.html,
|
||||
@@ -222,7 +225,7 @@ export class MailingService implements IMailingService {
|
||||
}
|
||||
}
|
||||
|
||||
private async processEmailItem(emailId: string): Promise<void> {
|
||||
async processEmailItem(emailId: string): Promise<void> {
|
||||
try {
|
||||
await this.payload.update({
|
||||
collection: this.emailsCollection as any,
|
||||
@@ -236,10 +239,18 @@ export class MailingService implements IMailingService {
|
||||
const email = await this.payload.findByID({
|
||||
collection: this.emailsCollection as any,
|
||||
id: emailId,
|
||||
}) as BaseEmail
|
||||
}) as BaseEmailDocument
|
||||
|
||||
const mailOptions = {
|
||||
from: email.from,
|
||||
// Combine from and fromName for nodemailer using proper sanitization
|
||||
let fromField: string
|
||||
if (email.from) {
|
||||
fromField = this.formatEmailAddress(email.from, email.fromName)
|
||||
} else {
|
||||
fromField = this.getDefaultFrom()
|
||||
}
|
||||
|
||||
let mailOptions: any = {
|
||||
from: fromField,
|
||||
to: email.to,
|
||||
cc: email.cc || undefined,
|
||||
bcc: email.bcc || undefined,
|
||||
@@ -249,7 +260,32 @@ export class MailingService implements IMailingService {
|
||||
text: email.text || undefined,
|
||||
}
|
||||
|
||||
await this.transporter.sendMail(mailOptions)
|
||||
// Call beforeSend hook if configured
|
||||
if (this.config.beforeSend) {
|
||||
try {
|
||||
mailOptions = await this.config.beforeSend(mailOptions, email)
|
||||
|
||||
// Validate required properties remain intact after hook execution
|
||||
if (!mailOptions.from) {
|
||||
throw new Error('beforeSend hook must not remove the "from" property')
|
||||
}
|
||||
if (!mailOptions.to || (Array.isArray(mailOptions.to) && mailOptions.to.length === 0)) {
|
||||
throw new Error('beforeSend hook must not remove or empty the "to" property')
|
||||
}
|
||||
if (!mailOptions.subject) {
|
||||
throw new Error('beforeSend hook must not remove the "subject" property')
|
||||
}
|
||||
if (!mailOptions.html && !mailOptions.text) {
|
||||
throw new Error('beforeSend hook must not remove both "html" and "text" properties')
|
||||
}
|
||||
} catch (error) {
|
||||
console.error('Error in beforeSend hook:', error)
|
||||
throw new Error(`beforeSend hook failed: ${error instanceof Error ? error.message : 'Unknown error'}`)
|
||||
}
|
||||
}
|
||||
|
||||
// Send email using Payload's email adapter
|
||||
await this.emailAdapter.sendEmail(mailOptions)
|
||||
|
||||
await this.payload.update({
|
||||
collection: this.emailsCollection as any,
|
||||
@@ -300,7 +336,7 @@ export class MailingService implements IMailingService {
|
||||
return newAttempts
|
||||
}
|
||||
|
||||
private async getTemplateBySlug(templateSlug: string): Promise<BaseEmailTemplate | null> {
|
||||
private async getTemplateBySlug(templateSlug: string): Promise<BaseEmailTemplateDocument | null> {
|
||||
try {
|
||||
const { docs } = await this.payload.find({
|
||||
collection: this.templatesCollection as any,
|
||||
@@ -312,7 +348,7 @@ export class MailingService implements IMailingService {
|
||||
limit: 1,
|
||||
})
|
||||
|
||||
return docs.length > 0 ? docs[0] as BaseEmailTemplate : null
|
||||
return docs.length > 0 ? docs[0] as BaseEmailTemplateDocument : null
|
||||
} catch (error) {
|
||||
console.error(`Template with slug '${templateSlug}' not found:`, error)
|
||||
return null
|
||||
@@ -377,7 +413,7 @@ export class MailingService implements IMailingService {
|
||||
})
|
||||
}
|
||||
|
||||
private async renderEmailTemplate(template: BaseEmailTemplate, variables: Record<string, any> = {}): Promise<{ html: string; text: string }> {
|
||||
private async renderEmailTemplate(template: BaseEmailTemplateDocument, variables: Record<string, any> = {}): Promise<{ html: string; text: string }> {
|
||||
if (!template.content) {
|
||||
return { html: '', text: '' }
|
||||
}
|
||||
|
||||
@@ -1,16 +1,67 @@
|
||||
import { Payload } from 'payload'
|
||||
import type { CollectionConfig, RichTextField } from 'payload'
|
||||
import { Transporter } from 'nodemailer'
|
||||
import {Email, EmailTemplate} from "../payload-types.js"
|
||||
|
||||
export type BaseEmail<TEmail extends Email = Email, TEmailTemplate extends EmailTemplate = EmailTemplate> = Omit<TEmail, 'id' | 'template'> & {template: Omit<TEmailTemplate, 'id'> | TEmailTemplate['id'] | undefined | null}
|
||||
// JSON value type that matches Payload's JSON field type
|
||||
export type JSONValue = string | number | boolean | { [k: string]: unknown } | unknown[] | null | undefined
|
||||
|
||||
export type BaseEmailTemplate<TEmailTemplate extends EmailTemplate = EmailTemplate> = Omit<TEmailTemplate, 'id'>
|
||||
// Generic base interfaces that work with any ID type and null values
|
||||
export interface BaseEmailDocument {
|
||||
id: string | number
|
||||
template?: any
|
||||
to: string[]
|
||||
cc?: string[] | null
|
||||
bcc?: string[] | null
|
||||
from?: string | null
|
||||
fromName?: string | null
|
||||
replyTo?: string | null
|
||||
subject: string
|
||||
html: string
|
||||
text?: string | null
|
||||
variables?: JSONValue
|
||||
scheduledAt?: string | Date | null
|
||||
sentAt?: string | Date | null
|
||||
status?: 'pending' | 'processing' | 'sent' | 'failed' | null
|
||||
attempts?: number | null
|
||||
lastAttemptAt?: string | Date | null
|
||||
error?: string | null
|
||||
priority?: number | null
|
||||
createdAt?: string | Date | null
|
||||
updatedAt?: string | Date | null
|
||||
}
|
||||
|
||||
export interface BaseEmailTemplateDocument {
|
||||
id: string | number
|
||||
name: string
|
||||
slug: string
|
||||
subject?: string | null
|
||||
content?: any
|
||||
createdAt?: string | Date | null
|
||||
updatedAt?: string | Date | null
|
||||
}
|
||||
|
||||
export type BaseEmail<TEmail extends BaseEmailDocument = BaseEmailDocument, TEmailTemplate extends BaseEmailTemplateDocument = BaseEmailTemplateDocument> = Omit<TEmail, 'id' | 'template'> & {template: Omit<TEmailTemplate, 'id'> | TEmailTemplate['id'] | undefined | null}
|
||||
|
||||
export type BaseEmailTemplate<TEmailTemplate extends BaseEmailTemplateDocument = BaseEmailTemplateDocument> = Omit<TEmailTemplate, 'id'>
|
||||
|
||||
export type TemplateRendererHook = (template: string, variables: Record<string, any>) => string | Promise<string>
|
||||
|
||||
export type TemplateEngine = 'liquidjs' | 'mustache' | 'simple'
|
||||
|
||||
export interface BeforeSendMailOptions {
|
||||
from: string
|
||||
to: string[]
|
||||
cc?: string[]
|
||||
bcc?: string[]
|
||||
replyTo?: string
|
||||
subject: string
|
||||
html: string
|
||||
text?: string
|
||||
attachments?: any[]
|
||||
[key: string]: any
|
||||
}
|
||||
|
||||
export type BeforeSendHook = (options: BeforeSendMailOptions, email: BaseEmailDocument) => BeforeSendMailOptions | Promise<BeforeSendMailOptions>
|
||||
|
||||
export interface MailingPluginConfig {
|
||||
collections?: {
|
||||
templates?: string | Partial<CollectionConfig>
|
||||
@@ -18,47 +69,37 @@ export interface MailingPluginConfig {
|
||||
}
|
||||
defaultFrom?: string
|
||||
defaultFromName?: string
|
||||
transport?: Transporter | MailingTransportConfig
|
||||
queue?: string
|
||||
retryAttempts?: number
|
||||
retryDelay?: number
|
||||
templateRenderer?: TemplateRendererHook
|
||||
templateEngine?: TemplateEngine
|
||||
richTextEditor?: RichTextField['editor']
|
||||
beforeSend?: BeforeSendHook
|
||||
onReady?: (payload: any) => Promise<void>
|
||||
initOrder?: 'before' | 'after'
|
||||
}
|
||||
|
||||
export interface MailingTransportConfig {
|
||||
host: string
|
||||
port: number
|
||||
secure?: boolean
|
||||
auth?: {
|
||||
user: string
|
||||
pass: string
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
export interface QueuedEmail {
|
||||
id: string
|
||||
template?: string
|
||||
template?: string | null
|
||||
to: string[]
|
||||
cc?: string[]
|
||||
bcc?: string[]
|
||||
from?: string
|
||||
replyTo?: string
|
||||
cc?: string[] | null
|
||||
bcc?: string[] | null
|
||||
from?: string | null
|
||||
fromName?: string | null
|
||||
replyTo?: string | null
|
||||
subject: string
|
||||
html: string
|
||||
text?: string
|
||||
variables?: Record<string, any>
|
||||
scheduledAt?: string
|
||||
sentAt?: string
|
||||
text?: string | null
|
||||
variables?: JSONValue
|
||||
scheduledAt?: string | Date | null
|
||||
sentAt?: string | Date | null
|
||||
status: 'pending' | 'processing' | 'sent' | 'failed'
|
||||
attempts: number
|
||||
lastAttemptAt?: string
|
||||
error?: string
|
||||
priority?: number
|
||||
lastAttemptAt?: string | Date | null
|
||||
error?: string | null
|
||||
priority?: number | null
|
||||
createdAt: string
|
||||
updatedAt: string
|
||||
}
|
||||
@@ -70,6 +111,7 @@ export interface TemplateVariables {
|
||||
|
||||
export interface MailingService {
|
||||
processEmails(): Promise<void>
|
||||
processEmailItem(emailId: string): Promise<void>
|
||||
retryFailedEmails(): Promise<void>
|
||||
renderTemplate(templateSlug: string, variables: TemplateVariables): Promise<{ html: string; text: string; subject: string }>
|
||||
}
|
||||
|
||||
61
src/utils/emailProcessor.ts
Normal file
61
src/utils/emailProcessor.ts
Normal file
@@ -0,0 +1,61 @@
|
||||
import type { Payload } from 'payload'
|
||||
|
||||
/**
|
||||
* Processes a single email by ID using the mailing service
|
||||
* @param payload Payload instance
|
||||
* @param emailId The ID of the email to process
|
||||
* @returns Promise that resolves when email is processed
|
||||
*/
|
||||
export async function processEmailById(payload: Payload, emailId: string): Promise<void> {
|
||||
// Get mailing context from payload
|
||||
const mailingContext = (payload as any).mailing
|
||||
|
||||
if (!mailingContext) {
|
||||
throw new Error(
|
||||
'Mailing plugin not found on payload instance. ' +
|
||||
'Ensure the mailingPlugin is properly configured in your Payload config plugins array.'
|
||||
)
|
||||
}
|
||||
|
||||
if (!mailingContext.service) {
|
||||
throw new Error(
|
||||
'Mailing service not available. ' +
|
||||
'The plugin may not have completed initialization. ' +
|
||||
'Check that email configuration is properly set up in your Payload config.'
|
||||
)
|
||||
}
|
||||
|
||||
// Process the specific email
|
||||
await mailingContext.service.processEmailItem(emailId)
|
||||
}
|
||||
|
||||
/**
|
||||
* Processes all pending and failed emails using the mailing service
|
||||
* @param payload Payload instance
|
||||
* @returns Promise that resolves when all emails are processed
|
||||
*/
|
||||
export async function processAllEmails(payload: Payload): Promise<void> {
|
||||
// Get mailing context from payload
|
||||
const mailingContext = (payload as any).mailing
|
||||
|
||||
if (!mailingContext) {
|
||||
throw new Error(
|
||||
'Mailing plugin not found on payload instance. ' +
|
||||
'Ensure the mailingPlugin is properly configured in your Payload config plugins array.'
|
||||
)
|
||||
}
|
||||
|
||||
if (!mailingContext.service) {
|
||||
throw new Error(
|
||||
'Mailing service not available. ' +
|
||||
'The plugin may not have completed initialization. ' +
|
||||
'Check that email configuration is properly set up in your Payload config.'
|
||||
)
|
||||
}
|
||||
|
||||
// Process pending emails first
|
||||
await mailingContext.service.processEmails()
|
||||
|
||||
// Then retry failed emails
|
||||
await mailingContext.service.retryFailedEmails()
|
||||
}
|
||||
Reference in New Issue
Block a user