mirror of
https://github.com/xtr-dev/payload-mailing.git
synced 2025-12-10 16:23:23 +00:00
Compare commits
45 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
03f1f62fbf | ||
| e55e4197d3 | |||
| 2e6feccf54 | |||
|
|
e38b63d814 | ||
| 31721dc110 | |||
| 6e4f754306 | |||
| 45559804b0 | |||
| 934b7c2de7 | |||
|
|
c78a8c2480 | ||
| a27481c818 | |||
| b342f32d97 | |||
| e1800f5a6e | |||
|
|
0c4d894f51 | ||
| 1af54c6573 | |||
| 24f1f4c5a4 | |||
| de41f4ecb2 | |||
|
|
6d4e020133 | ||
| 25838bcba4 | |||
| dfa833fa5e | |||
| cb5ce2e720 | |||
| f8b7dd8f4c | |||
|
|
b3de54b953 | ||
| 186c340d96 | |||
| 08b4d49019 | |||
|
|
ed058c0721 | ||
| 6db27093d1 | |||
| 43557c9a03 | |||
| 2deefc8eaa | |||
| 12952ad41c | |||
|
|
273dea5a73 | ||
| 651a487921 | |||
| f2df4ce496 | |||
|
|
c81ef7f8a8 | ||
| 804a63647a | |||
| 135fddc6fa | |||
| 74f565ab4e | |||
|
|
cddcfb1e4c | ||
| cfc3ce5a7e | |||
| 5acf7d52f6 | |||
| b854b17266 | |||
| dc3c4fdb44 | |||
|
|
80d32674a9 | ||
| 243f7c96cf | |||
| 159a99a1ec | |||
| 860dd7e921 |
717
README.md
717
README.md
@@ -6,12 +6,19 @@
|
||||
|
||||
## Features
|
||||
|
||||
✅ **Template System**: Create reusable email templates with Handlebars syntax
|
||||
✅ **Outbox Scheduling**: Schedule emails for future delivery
|
||||
✅ **Job Integration**: Automatic processing via PayloadCMS jobs queue
|
||||
✅ **Retry Failed Sends**: Automatic retry mechanism for failed emails
|
||||
✅ **Template Variables**: Dynamic content with validation
|
||||
✅ **Developer API**: Simple methods for sending emails programmatically
|
||||
✅ **Template System**: Create reusable email templates with LiquidJS, Mustache, or simple variables
|
||||
|
||||
✅ **Type Safety**: Full TypeScript support using your generated Payload types
|
||||
|
||||
✅ **Flexible Template Engines**: LiquidJS, Mustache, or bring your own template renderer
|
||||
|
||||
✅ **Email Scheduling**: Schedule emails for future delivery using Payload collections
|
||||
|
||||
✅ **Job Integration**: Automatic processing via PayloadCMS jobs queue
|
||||
|
||||
✅ **Retry Failed Sends**: Automatic retry mechanism for failed emails
|
||||
|
||||
✅ **Payload Native**: Uses Payload collections directly - no custom APIs to learn
|
||||
|
||||
## Installation
|
||||
|
||||
@@ -49,29 +56,51 @@ export default buildConfig({
|
||||
})
|
||||
```
|
||||
|
||||
### 2. Send emails in your code
|
||||
### 2. Send emails with type-safe helper
|
||||
|
||||
```typescript
|
||||
import { sendEmail, scheduleEmail } from '@xtr-dev/payload-mailing'
|
||||
// sendEmail is a primary export for easy access
|
||||
import { sendEmail } from '@xtr-dev/payload-mailing'
|
||||
import { Email } from './payload-types' // Your generated types
|
||||
|
||||
// Send immediately using template slug
|
||||
const emailId = await sendEmail(payload, {
|
||||
templateSlug: 'welcome-email',
|
||||
to: 'user@example.com',
|
||||
variables: {
|
||||
firstName: 'John',
|
||||
welcomeUrl: 'https://yoursite.com/welcome'
|
||||
// Option 1: Using templates with full type safety
|
||||
const email = await sendEmail<Email>(payload, {
|
||||
template: {
|
||||
slug: 'welcome-email',
|
||||
variables: {
|
||||
firstName: 'John',
|
||||
welcomeUrl: 'https://yoursite.com/welcome'
|
||||
}
|
||||
},
|
||||
data: {
|
||||
to: 'user@example.com',
|
||||
// Schedule for later (optional)
|
||||
scheduledAt: new Date(Date.now() + 24 * 60 * 60 * 1000),
|
||||
priority: 1,
|
||||
// Your custom fields are type-safe!
|
||||
customField: 'your-value',
|
||||
}
|
||||
})
|
||||
|
||||
// Schedule for later
|
||||
const scheduledId = await scheduleEmail(payload, {
|
||||
templateSlug: 'reminder-email',
|
||||
to: 'user@example.com',
|
||||
scheduledAt: new Date(Date.now() + 24 * 60 * 60 * 1000), // 24 hours
|
||||
variables: {
|
||||
eventName: 'Product Launch',
|
||||
eventDate: new Date('2024-01-15')
|
||||
// Option 2: Direct HTML email (no template)
|
||||
const directEmail = await sendEmail<Email>(payload, {
|
||||
data: {
|
||||
to: ['user@example.com', 'another@example.com'],
|
||||
subject: 'Welcome!',
|
||||
html: '<h1>Welcome John!</h1><p>Thanks for joining!</p>',
|
||||
text: 'Welcome John! Thanks for joining!',
|
||||
// All your custom fields work with TypeScript autocomplete!
|
||||
customField: 'value',
|
||||
}
|
||||
})
|
||||
|
||||
// Option 3: Use payload.create() directly for full control
|
||||
const manualEmail = await payload.create({
|
||||
collection: 'emails',
|
||||
data: {
|
||||
to: ['user@example.com'],
|
||||
subject: 'Hello',
|
||||
html: '<p>Hello World</p>',
|
||||
}
|
||||
})
|
||||
```
|
||||
@@ -81,21 +110,68 @@ const scheduledId = await scheduleEmail(payload, {
|
||||
### Plugin Options
|
||||
|
||||
```typescript
|
||||
interface MailingPluginConfig {
|
||||
collections?: {
|
||||
templates?: string // default: 'email-templates'
|
||||
emails?: string // default: 'emails'
|
||||
mailingPlugin({
|
||||
// Template engine (optional)
|
||||
templateEngine: 'liquidjs', // 'liquidjs' | 'mustache' | 'simple'
|
||||
|
||||
// Custom template renderer (optional)
|
||||
templateRenderer: async (template: string, variables: Record<string, any>) => {
|
||||
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
|
||||
emails: 'emails' // default
|
||||
},
|
||||
|
||||
// Sending options
|
||||
defaultFrom: 'noreply@yoursite.com',
|
||||
defaultFromName: 'Your Site',
|
||||
retryAttempts: 3, // default
|
||||
retryDelay: 300000, // 5 minutes (default)
|
||||
|
||||
// Advanced options
|
||||
richTextEditor: lexicalEditor(), // optional custom editor
|
||||
onReady: async (payload) => { // optional initialization hook
|
||||
console.log('Mailing plugin ready!')
|
||||
}
|
||||
defaultFrom?: string
|
||||
transport?: Transporter | MailingTransportConfig
|
||||
queue?: string // default: 'default'
|
||||
retryAttempts?: number // default: 3
|
||||
retryDelay?: number // default: 300000 (5 minutes)
|
||||
emailWrapper?: EmailWrapperHook // optional email layout wrapper
|
||||
richTextEditor?: RichTextField['editor'] // optional custom rich text editor
|
||||
onReady?: (payload: any) => Promise<void> // optional callback after plugin initialization
|
||||
initOrder?: 'before' | 'after' // default: 'before'
|
||||
}
|
||||
})
|
||||
```
|
||||
|
||||
### Template Engine Options
|
||||
|
||||
Choose your preferred template engine:
|
||||
|
||||
```typescript
|
||||
// LiquidJS (default) - Modern syntax with logic
|
||||
mailingPlugin({
|
||||
templateEngine: 'liquidjs' // {% if user.isPremium %}Premium!{% endif %}
|
||||
})
|
||||
|
||||
// Mustache - Logic-less templates
|
||||
mailingPlugin({
|
||||
templateEngine: 'mustache' // {{#user.isPremium}}Premium!{{/user.isPremium}}
|
||||
})
|
||||
|
||||
// Simple variable replacement
|
||||
mailingPlugin({
|
||||
templateEngine: 'simple' // Just {{variable}} replacement
|
||||
})
|
||||
|
||||
// Custom template renderer
|
||||
mailingPlugin({
|
||||
templateRenderer: async (template, variables) => {
|
||||
return handlebars.compile(template)(variables) // Bring your own!
|
||||
}
|
||||
})
|
||||
```
|
||||
|
||||
### Transport Configuration
|
||||
@@ -147,7 +223,7 @@ Thanks for joining {{siteName}}. We're excited to have you!
|
||||
|
||||
**What you can do:**
|
||||
• Create beautiful emails with rich text formatting
|
||||
• Use the emailWrapper hook to add custom layouts
|
||||
|
||||
• Queue and schedule emails effortlessly
|
||||
|
||||
Your account was created on {{formatDate createdAt "long"}}.
|
||||
@@ -158,282 +234,6 @@ The {{siteName}} Team
|
||||
|
||||
## Advanced Features
|
||||
|
||||
### Custom HTML Layouts with Email Wrapper Hook
|
||||
|
||||
The `emailWrapper` hook allows you to apply consistent HTML layouts and styling to all emails sent through the plugin. This is perfect for adding company branding, headers, footers, and responsive styling.
|
||||
|
||||
#### Basic Email Wrapper
|
||||
|
||||
```typescript
|
||||
mailingPlugin({
|
||||
// ... other config
|
||||
emailWrapper: (email) => {
|
||||
const wrappedHtml = `
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<title>${email.subject}</title>
|
||||
<style>
|
||||
body { font-family: Arial, sans-serif; margin: 0; padding: 20px; background-color: #f4f4f4; }
|
||||
.container { max-width: 600px; margin: 0 auto; background: white; border-radius: 8px; overflow: hidden; }
|
||||
.header { background: #007bff; color: white; padding: 20px; text-align: center; }
|
||||
.content { padding: 30px; line-height: 1.6; }
|
||||
.footer { background: #f8f9fa; padding: 15px; text-align: center; color: #6c757d; font-size: 14px; }
|
||||
|
||||
/* Responsive styles */
|
||||
@media only screen and (max-width: 600px) {
|
||||
.container { margin: 0 10px; }
|
||||
.content { padding: 20px; }
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<div class="container">
|
||||
<div class="header">
|
||||
<h1>My Company</h1>
|
||||
</div>
|
||||
<div class="content">
|
||||
${email.html}
|
||||
</div>
|
||||
<div class="footer">
|
||||
© 2024 My Company. All rights reserved.<br>
|
||||
<a href="#" style="color: #007bff;">Unsubscribe</a> |
|
||||
<a href="#" style="color: #007bff;">Contact Support</a>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
`
|
||||
|
||||
return {
|
||||
...email,
|
||||
html: wrappedHtml,
|
||||
text: `MY COMPANY\n\n${email.text}\n\n© 2024 My Company\nUnsubscribe: [link] | Contact Support: [link]`
|
||||
}
|
||||
}
|
||||
})
|
||||
```
|
||||
|
||||
#### Advanced Email Wrapper with Dynamic Content
|
||||
|
||||
```typescript
|
||||
mailingPlugin({
|
||||
// ... other config
|
||||
emailWrapper: (email) => {
|
||||
// You can access email properties and customize based on content
|
||||
const isTransactional = email.subject?.includes('Receipt') || email.subject?.includes('Confirmation');
|
||||
const headerColor = isTransactional ? '#28a745' : '#007bff';
|
||||
const headerText = isTransactional ? 'Order Confirmation' : 'My Company';
|
||||
|
||||
const wrappedHtml = `
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>${email.subject}</title>
|
||||
<!--[if mso]>
|
||||
<noscript>
|
||||
<xml>
|
||||
<o:OfficeDocumentSettings>
|
||||
<o:PixelsPerInch>96</o:PixelsPerInch>
|
||||
</o:OfficeDocumentSettings>
|
||||
</xml>
|
||||
</noscript>
|
||||
<![endif]-->
|
||||
<style>
|
||||
/* Reset styles */
|
||||
body, table, td, a { -webkit-text-size-adjust: 100%; -ms-text-size-adjust: 100%; }
|
||||
table, td { mso-table-lspace: 0pt; mso-table-rspace: 0pt; }
|
||||
img { -ms-interpolation-mode: bicubic; border: 0; outline: none; text-decoration: none; }
|
||||
|
||||
/* Base styles */
|
||||
body {
|
||||
margin: 0 !important;
|
||||
padding: 0 !important;
|
||||
background-color: #f4f4f4;
|
||||
font-family: 'Segoe UI', Tahoma, Geneva, Verdana, sans-serif;
|
||||
}
|
||||
|
||||
.email-container {
|
||||
max-width: 600px;
|
||||
margin: 0 auto;
|
||||
background-color: #ffffff;
|
||||
border-radius: 8px;
|
||||
overflow: hidden;
|
||||
box-shadow: 0 2px 10px rgba(0,0,0,0.1);
|
||||
}
|
||||
|
||||
.email-header {
|
||||
background: linear-gradient(135deg, ${headerColor}, ${headerColor}dd);
|
||||
color: white;
|
||||
padding: 30px 20px;
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
.email-content {
|
||||
padding: 30px;
|
||||
color: #333333;
|
||||
line-height: 1.6;
|
||||
}
|
||||
|
||||
.email-footer {
|
||||
background-color: #f8f9fa;
|
||||
padding: 20px;
|
||||
text-align: center;
|
||||
color: #6c757d;
|
||||
font-size: 14px;
|
||||
border-top: 1px solid #e9ecef;
|
||||
}
|
||||
|
||||
.email-footer a {
|
||||
color: ${headerColor};
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
/* Responsive */
|
||||
@media only screen and (max-width: 600px) {
|
||||
.email-container {
|
||||
margin: 0 10px !important;
|
||||
}
|
||||
.email-header, .email-content {
|
||||
padding: 20px !important;
|
||||
}
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<div class="email-container">
|
||||
<div class="email-header">
|
||||
<h1 style="margin: 0; font-size: 24px;">${headerText}</h1>
|
||||
</div>
|
||||
<div class="email-content">
|
||||
${email.html}
|
||||
</div>
|
||||
<div class="email-footer">
|
||||
<p style="margin: 0 0 10px;">© ${new Date().getFullYear()} My Company. All rights reserved.</p>
|
||||
<p style="margin: 0;">
|
||||
<a href="mailto:support@mycompany.com">Contact Support</a> |
|
||||
<a href="#">Privacy Policy</a> |
|
||||
<a href="#">Unsubscribe</a>
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
`
|
||||
|
||||
// Also enhance the plain text version
|
||||
const wrappedText = `
|
||||
${headerText.toUpperCase()}
|
||||
${'='.repeat(headerText.length)}
|
||||
|
||||
${email.text || email.html?.replace(/<[^>]*>/g, '')}
|
||||
|
||||
---
|
||||
© ${new Date().getFullYear()} My Company. All rights reserved.
|
||||
Contact Support: support@mycompany.com
|
||||
Privacy Policy: [link]
|
||||
Unsubscribe: [link]
|
||||
`.trim();
|
||||
|
||||
return {
|
||||
...email,
|
||||
html: wrappedHtml,
|
||||
text: wrappedText
|
||||
}
|
||||
}
|
||||
})
|
||||
```
|
||||
|
||||
#### External CSS and Assets
|
||||
|
||||
You can also reference external stylesheets and assets:
|
||||
|
||||
```typescript
|
||||
mailingPlugin({
|
||||
emailWrapper: (email) => {
|
||||
const wrappedHtml = `
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<title>${email.subject}</title>
|
||||
<!-- External CSS -->
|
||||
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;600&display=swap" rel="stylesheet">
|
||||
<style>
|
||||
body { font-family: 'Inter', sans-serif; }
|
||||
/* Your custom styles here */
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<div style="max-width: 600px; margin: 0 auto;">
|
||||
<img src="https://mycompany.com/email-header.png" alt="My Company" style="width: 100%; height: auto;">
|
||||
<div style="padding: 20px;">
|
||||
${email.html}
|
||||
</div>
|
||||
<img src="https://mycompany.com/email-footer.png" alt="Footer" style="width: 100%; height: auto;">
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
`;
|
||||
|
||||
return { ...email, html: wrappedHtml };
|
||||
}
|
||||
})
|
||||
```
|
||||
|
||||
#### Template-Specific Layouts
|
||||
|
||||
You can customize layouts based on email templates:
|
||||
|
||||
```typescript
|
||||
mailingPlugin({
|
||||
emailWrapper: (email, context) => {
|
||||
// Access template information if available
|
||||
const templateSlug = context?.templateSlug;
|
||||
|
||||
let layoutClass = 'default-layout';
|
||||
let headerColor = '#007bff';
|
||||
|
||||
if (templateSlug === 'welcome-email') {
|
||||
layoutClass = 'welcome-layout';
|
||||
headerColor = '#28a745';
|
||||
} else if (templateSlug === 'invoice-email') {
|
||||
layoutClass = 'invoice-layout';
|
||||
headerColor = '#dc3545';
|
||||
}
|
||||
|
||||
const wrappedHtml = `
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>${email.subject}</title>
|
||||
<style>
|
||||
.${layoutClass} { /* template-specific styles */ }
|
||||
.header { background-color: ${headerColor}; }
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<div class="${layoutClass}">
|
||||
${email.html}
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
`;
|
||||
|
||||
return { ...email, html: wrappedHtml };
|
||||
}
|
||||
})
|
||||
```
|
||||
|
||||
The `emailWrapper` hook receives the email object with `html`, `text`, and `subject` properties, and should return the modified email object with your custom layout applied.
|
||||
|
||||
### Custom Rich Text Editor
|
||||
|
||||
Override the rich text editor used for templates:
|
||||
@@ -473,73 +273,127 @@ mailingPlugin({
|
||||
})
|
||||
```
|
||||
|
||||
## Handlebars Helpers
|
||||
## Template Syntax Reference
|
||||
|
||||
The plugin includes several built-in helpers:
|
||||
Depending on your chosen template engine, you can use different syntax:
|
||||
|
||||
- `{{formatDate date 'short'}}` - Format dates (short, long, or default)
|
||||
- `{{formatCurrency amount 'USD'}}` - Format currency
|
||||
- `{{capitalize string}}` - Capitalize first letter
|
||||
- `{{#ifEquals value1 value2}}...{{/ifEquals}}` - Conditional equality
|
||||
### LiquidJS (Default)
|
||||
- Variables: `{{ user.name }}`
|
||||
- Logic: `{% if user.isPremium %}Premium content{% endif %}`
|
||||
- Loops: `{% for item in items %}{{ item.name }}{% endfor %}`
|
||||
- Filters: `{{ amount | formatCurrency }}`, `{{ date | formatDate: "short" }}`
|
||||
|
||||
## API Methods
|
||||
### Mustache
|
||||
- Variables: `{{ user.name }}`
|
||||
- Logic: `{{#user.isPremium}}Premium content{{/user.isPremium}}`
|
||||
- Loops: `{{#items}}{{ name }}{{/items}}`
|
||||
- No built-in filters (use variables with pre-formatted data)
|
||||
|
||||
### sendEmail(payload, options)
|
||||
### Simple
|
||||
- Variables only: `{{ user.name }}`, `{{ amount }}`, `{{ date }}`
|
||||
|
||||
Send an email immediately:
|
||||
### Built-in Filters (LiquidJS only)
|
||||
- `formatDate` - Format dates: `{{ createdAt | formatDate: "short" }}`
|
||||
- `formatCurrency` - Format currency: `{{ amount | formatCurrency: "USD" }}`
|
||||
- `capitalize` - Capitalize first letter: `{{ name | capitalize }}`
|
||||
|
||||
## Available Helper Functions
|
||||
|
||||
```typescript
|
||||
const emailId = await sendEmail(payload, {
|
||||
templateSlug: 'order-confirmation', // optional - use template slug
|
||||
to: ['customer@example.com'], // string or array of emails
|
||||
cc: ['manager@example.com'], // optional - array of emails
|
||||
bcc: ['archive@example.com'], // optional - array of emails
|
||||
from: 'orders@yoursite.com', // optional, uses default
|
||||
replyTo: 'support@yoursite.com', // optional
|
||||
subject: 'Custom subject', // required if no template
|
||||
html: '<h1>Custom HTML</h1>', // required if no template
|
||||
text: 'Custom text version', // optional
|
||||
variables: { // template variables
|
||||
orderNumber: '12345',
|
||||
customerName: 'John Doe'
|
||||
},
|
||||
priority: 1 // optional, 1-10 (1 = highest)
|
||||
import {
|
||||
renderTemplate, // Render email templates with variables
|
||||
processEmails, // Process pending emails manually
|
||||
retryFailedEmails, // Retry failed emails
|
||||
getMailing // Get mailing service instance
|
||||
} from '@xtr-dev/payload-mailing'
|
||||
|
||||
// Render a template
|
||||
const { html, text, subject } = await renderTemplate(payload, 'welcome', {
|
||||
name: 'John',
|
||||
activationUrl: 'https://example.com/activate'
|
||||
})
|
||||
|
||||
// Process emails manually
|
||||
await processEmails(payload)
|
||||
|
||||
// Retry failed emails
|
||||
await retryFailedEmails(payload)
|
||||
```
|
||||
|
||||
### scheduleEmail(payload, options)
|
||||
## PayloadCMS Task Integration
|
||||
|
||||
Schedule an email for later delivery:
|
||||
The plugin provides a ready-to-use PayloadCMS task for queuing template emails:
|
||||
|
||||
### 1. Add the task to your Payload config
|
||||
|
||||
```typescript
|
||||
const emailId = await scheduleEmail(payload, {
|
||||
templateSlug: 'newsletter',
|
||||
to: ['user1@example.com', 'user2@example.com'],
|
||||
scheduledAt: new Date('2024-01-15T10:00:00Z'),
|
||||
variables: {
|
||||
month: 'January',
|
||||
highlights: ['Feature A', 'Feature B']
|
||||
import { buildConfig } from 'payload/config'
|
||||
import { sendTemplateEmailTask } from '@xtr-dev/payload-mailing'
|
||||
|
||||
export default buildConfig({
|
||||
// ... your config
|
||||
jobs: {
|
||||
tasks: [
|
||||
sendTemplateEmailTask,
|
||||
// ... your other tasks
|
||||
]
|
||||
}
|
||||
})
|
||||
```
|
||||
|
||||
### processEmails(payload)
|
||||
|
||||
Manually process pending emails:
|
||||
### 2. Queue emails from your code
|
||||
|
||||
```typescript
|
||||
import { processEmails } from '@xtr-dev/payload-mailing'
|
||||
await processEmails(payload)
|
||||
import type { SendTemplateEmailInput } from '@xtr-dev/payload-mailing'
|
||||
|
||||
// Queue a template email
|
||||
const result = await payload.jobs.queue({
|
||||
task: 'send-template-email',
|
||||
input: {
|
||||
templateSlug: 'welcome-email',
|
||||
to: ['user@example.com'],
|
||||
cc: ['manager@example.com'],
|
||||
variables: {
|
||||
firstName: 'John',
|
||||
activationUrl: 'https://example.com/activate/123'
|
||||
},
|
||||
priority: 1,
|
||||
// Add any custom fields from your email collection
|
||||
customField: 'value'
|
||||
} as SendTemplateEmailInput
|
||||
})
|
||||
|
||||
// Queue a scheduled email
|
||||
await payload.jobs.queue({
|
||||
task: 'send-template-email',
|
||||
input: {
|
||||
templateSlug: 'reminder-email',
|
||||
to: ['user@example.com'],
|
||||
variables: { eventName: 'Product Launch' },
|
||||
scheduledAt: new Date('2024-01-15T10:00:00Z').toISOString(),
|
||||
priority: 3
|
||||
}
|
||||
})
|
||||
```
|
||||
|
||||
### retryFailedEmails(payload)
|
||||
### 3. Use in admin panel workflows
|
||||
|
||||
Manually retry failed emails:
|
||||
The task can also be triggered from the Payload admin panel with a user-friendly form interface that includes:
|
||||
- Template slug selection
|
||||
- Email recipients (to, cc, bcc)
|
||||
- Template variables as JSON
|
||||
- Optional scheduling
|
||||
- Priority setting
|
||||
- Any custom fields you've added to your email collection
|
||||
|
||||
```typescript
|
||||
import { retryFailedEmails } from '@xtr-dev/payload-mailing'
|
||||
await retryFailedEmails(payload)
|
||||
```
|
||||
### Task Benefits
|
||||
|
||||
- ✅ **Easy Integration**: Just add to your tasks array
|
||||
- ✅ **Type Safety**: Full TypeScript support with `SendTemplateEmailInput`
|
||||
- ✅ **Admin UI**: Ready-to-use form interface
|
||||
- ✅ **Flexible**: Supports all your custom email collection fields
|
||||
- ✅ **Error Handling**: Comprehensive error reporting
|
||||
- ✅ **Queue Management**: Leverage Payload's job queue system
|
||||
|
||||
## Job Processing
|
||||
|
||||
@@ -716,35 +570,134 @@ import {
|
||||
} from '@xtr-dev/payload-mailing'
|
||||
```
|
||||
|
||||
## API Reference
|
||||
|
||||
### `sendEmail<T>(payload, options)`
|
||||
|
||||
Type-safe email sending with automatic template rendering and validation.
|
||||
|
||||
```typescript
|
||||
import { sendEmail } from '@xtr-dev/payload-mailing'
|
||||
import { Email } from './payload-types'
|
||||
|
||||
const email = await sendEmail<Email>(payload, {
|
||||
template: {
|
||||
slug: 'template-slug',
|
||||
variables: { /* template variables */ }
|
||||
},
|
||||
data: {
|
||||
to: 'user@example.com',
|
||||
// Your custom fields are type-safe here!
|
||||
}
|
||||
})
|
||||
```
|
||||
|
||||
**Type Parameters:**
|
||||
- `T extends BaseEmailData` - Your generated Email type for full type safety
|
||||
|
||||
**Options:**
|
||||
- `template.slug` - Template slug to render
|
||||
- `template.variables` - Variables to pass to template
|
||||
- `data` - Email data (merged with template output)
|
||||
- `collectionSlug` - Custom collection name (defaults to 'emails')
|
||||
|
||||
### `renderTemplate(payload, slug, variables)`
|
||||
|
||||
Render an email template without sending.
|
||||
|
||||
```typescript
|
||||
const { html, text, subject } = await renderTemplate(
|
||||
payload,
|
||||
'welcome-email',
|
||||
{ name: 'John' }
|
||||
)
|
||||
```
|
||||
|
||||
### Helper Functions
|
||||
|
||||
- `getMailing(payload)` - Get mailing context
|
||||
- `processEmails(payload)` - Manually trigger email processing
|
||||
- `retryFailedEmails(payload)` - Manually retry failed emails
|
||||
|
||||
## Migration Guide (v0.0.x → v0.1.0)
|
||||
|
||||
**🚨 BREAKING CHANGES**: The API has been simplified to use Payload collections directly.
|
||||
|
||||
### Before (v0.0.x)
|
||||
```typescript
|
||||
import { sendEmail, scheduleEmail } from '@xtr-dev/payload-mailing'
|
||||
|
||||
// Old way
|
||||
const emailId = await sendEmail(payload, {
|
||||
templateSlug: 'welcome',
|
||||
to: 'user@example.com',
|
||||
variables: { name: 'John' }
|
||||
})
|
||||
|
||||
const scheduledId = await scheduleEmail(payload, {
|
||||
templateSlug: 'reminder',
|
||||
to: 'user@example.com',
|
||||
scheduledAt: new Date('2024-01-15T10:00:00Z'),
|
||||
variables: { eventName: 'Launch' }
|
||||
})
|
||||
```
|
||||
|
||||
### After (v0.1.0+)
|
||||
```typescript
|
||||
import { renderTemplate } from '@xtr-dev/payload-mailing'
|
||||
|
||||
// New way - render template first
|
||||
const { html, text, subject } = await renderTemplate(payload, 'welcome', {
|
||||
name: 'John'
|
||||
})
|
||||
|
||||
// Then create email using Payload collections (full type safety!)
|
||||
const email = await payload.create({
|
||||
collection: 'emails',
|
||||
data: {
|
||||
to: ['user@example.com'],
|
||||
subject,
|
||||
html,
|
||||
text,
|
||||
// For scheduling
|
||||
scheduledAt: new Date('2024-01-15T10:00:00Z'),
|
||||
// Add any custom fields from your collection
|
||||
customField: 'value',
|
||||
}
|
||||
})
|
||||
```
|
||||
|
||||
### Benefits of Migration
|
||||
- ✅ **Full TypeScript support** with your generated Payload types
|
||||
- ✅ **Use any custom fields** you add to your email collection
|
||||
- ✅ **Leverage Payload's features**: validation, hooks, access control
|
||||
- ✅ **One consistent API** - just use `payload.create()`
|
||||
- ✅ **No wrapper methods** - direct access to Payload's power
|
||||
|
||||
## Recent Changes
|
||||
|
||||
### v0.0.x (Latest)
|
||||
### v0.1.0 (Latest - Breaking Changes)
|
||||
|
||||
**🔄 Breaking Changes:**
|
||||
- Removed email layouts system in favor of `emailWrapper` hook for better flexibility
|
||||
- Email fields (`to`, `cc`, `bcc`) now use `hasMany: true` for proper array handling
|
||||
- Templates now use slug-based lookup instead of ID-based for developer-friendly API
|
||||
- Email collection renamed from "outbox" to "emails"
|
||||
- Unified job processing: single `process-email-queue` job handles both pending and failed emails
|
||||
**🚀 Major API Simplification:**
|
||||
- **REMOVED**: `sendEmail()` and `scheduleEmail()` wrapper methods
|
||||
- **REMOVED**: `SendEmailOptions` custom types
|
||||
- **ADDED**: Direct Payload collection usage with full type safety
|
||||
- **ADDED**: `renderTemplate()` helper for template rendering
|
||||
- **ADDED**: Support for LiquidJS, Mustache, and custom template engines
|
||||
- **IMPROVED**: Webpack compatibility with proper dynamic imports
|
||||
|
||||
**✨ New Features:**
|
||||
- Rich text editor with automatic HTML/text conversion
|
||||
- Template slugs for easier template reference
|
||||
- `emailWrapper` hook for consistent email layouts
|
||||
- Custom rich text editor configuration support
|
||||
- Initialization hooks (`onReady`, `initOrder`) for better plugin lifecycle control
|
||||
- Improved Handlebars variable interpolation with defensive programming
|
||||
**Template Engine Enhancements:**
|
||||
- **NEW**: LiquidJS support (default) with modern syntax and logic
|
||||
- **NEW**: Mustache support for logic-less templates
|
||||
- **NEW**: Custom template renderer hook for maximum flexibility
|
||||
- **NEW**: Simple variable replacement as fallback
|
||||
- **FIXED**: All webpack compatibility issues resolved
|
||||
|
||||
**🐛 Bug Fixes:**
|
||||
- Fixed text version uppercase conversion in headings
|
||||
- Fixed Handlebars interpolation issues in text version
|
||||
- Improved plugin initialization order to prevent timing issues
|
||||
|
||||
**💡 Improvements:**
|
||||
- Better admin UI with proper array input controls
|
||||
- More robust error handling and logging
|
||||
- Enhanced TypeScript definitions
|
||||
- Simplified template creation workflow
|
||||
**Developer Experience:**
|
||||
- **IMPROVED**: Full TypeScript inference using generated Payload types
|
||||
- **IMPROVED**: Comprehensive migration guide and documentation
|
||||
- **IMPROVED**: Better error handling and async patterns
|
||||
- **SIMPLIFIED**: Cleaner codebase with fewer abstractions
|
||||
|
||||
## License
|
||||
|
||||
|
||||
@@ -184,25 +184,43 @@ The plugin automatically processes the outbox every 5 minutes and retries failed
|
||||
## Plugin API Usage
|
||||
|
||||
```javascript
|
||||
import { sendEmail, scheduleEmail } from '@xtr-dev/payload-mailing'
|
||||
import { sendEmail } from '@xtr-dev/payload-mailing'
|
||||
|
||||
// Send immediate email
|
||||
const emailId = await sendEmail(payload, {
|
||||
templateId: 'welcome-template-id',
|
||||
to: 'user@example.com',
|
||||
variables: {
|
||||
firstName: 'John',
|
||||
siteName: 'My App'
|
||||
// Send immediate email with template
|
||||
const email = await sendEmail(payload, {
|
||||
template: {
|
||||
slug: 'welcome-email',
|
||||
variables: {
|
||||
firstName: 'John',
|
||||
siteName: 'My App'
|
||||
}
|
||||
},
|
||||
data: {
|
||||
to: 'user@example.com',
|
||||
}
|
||||
})
|
||||
|
||||
// Schedule email
|
||||
const scheduledId = await scheduleEmail(payload, {
|
||||
templateId: 'reminder-template-id',
|
||||
to: 'user@example.com',
|
||||
scheduledAt: new Date(Date.now() + 24 * 60 * 60 * 1000), // 24 hours
|
||||
variables: {
|
||||
eventName: 'Product Launch'
|
||||
// Schedule email for later
|
||||
const scheduledEmail = await sendEmail(payload, {
|
||||
template: {
|
||||
slug: 'reminder',
|
||||
variables: {
|
||||
eventName: 'Product Launch'
|
||||
}
|
||||
},
|
||||
data: {
|
||||
to: 'user@example.com',
|
||||
scheduledAt: new Date(Date.now() + 24 * 60 * 60 * 1000), // 24 hours
|
||||
}
|
||||
})
|
||||
|
||||
// Send direct HTML email (no template)
|
||||
const directEmail = await sendEmail(payload, {
|
||||
data: {
|
||||
to: 'user@example.com',
|
||||
subject: 'Direct Email',
|
||||
html: '<h1>Hello World</h1>',
|
||||
text: 'Hello World'
|
||||
}
|
||||
})
|
||||
```
|
||||
@@ -1,37 +1,50 @@
|
||||
import { getPayload } from 'payload'
|
||||
import config from '@payload-config'
|
||||
import { sendEmail, scheduleEmail } from '@xtr-dev/payload-mailing'
|
||||
import { sendEmail } from '@xtr-dev/payload-mailing'
|
||||
|
||||
export async function POST(request: Request) {
|
||||
try {
|
||||
const payload = await getPayload({ config })
|
||||
const body = await request.json()
|
||||
const { type = 'send', templateSlug, to, variables, scheduledAt } = body
|
||||
const { type = 'send', templateSlug, to, variables, scheduledAt, subject, html, text } = body
|
||||
|
||||
let result
|
||||
if (type === 'send') {
|
||||
// Send immediately
|
||||
result = await sendEmail(payload, {
|
||||
templateSlug,
|
||||
// Use the new sendEmail API
|
||||
const emailOptions: any = {
|
||||
data: {
|
||||
to,
|
||||
variables,
|
||||
})
|
||||
} else if (type === 'schedule') {
|
||||
// Schedule for later
|
||||
result = await scheduleEmail(payload, {
|
||||
templateSlug,
|
||||
to,
|
||||
variables,
|
||||
scheduledAt: scheduledAt ? new Date(scheduledAt) : new Date(Date.now() + 60000), // Default to 1 minute
|
||||
})
|
||||
} else {
|
||||
return Response.json({ error: 'Invalid type. Use "send" or "schedule"' }, { status: 400 })
|
||||
}
|
||||
}
|
||||
|
||||
// Add template if provided
|
||||
if (templateSlug) {
|
||||
emailOptions.template = {
|
||||
slug: templateSlug,
|
||||
variables: variables || {}
|
||||
}
|
||||
} else if (subject && html) {
|
||||
// Direct email without template
|
||||
emailOptions.data.subject = subject
|
||||
emailOptions.data.html = html
|
||||
if (text) {
|
||||
emailOptions.data.text = text
|
||||
}
|
||||
} else {
|
||||
return Response.json({
|
||||
error: 'Either templateSlug or subject+html must be provided'
|
||||
}, { status: 400 })
|
||||
}
|
||||
|
||||
// Add scheduling if needed
|
||||
if (type === 'schedule' || scheduledAt) {
|
||||
emailOptions.data.scheduledAt = scheduledAt ? new Date(scheduledAt) : new Date(Date.now() + 60000)
|
||||
}
|
||||
|
||||
const result = await sendEmail(payload, emailOptions)
|
||||
|
||||
return Response.json({
|
||||
success: true,
|
||||
emailId: result,
|
||||
message: type === 'send' ? 'Email sent successfully' : 'Email scheduled successfully',
|
||||
emailId: result.id,
|
||||
message: scheduledAt ? 'Email scheduled successfully' : 'Email queued successfully',
|
||||
})
|
||||
} catch (error) {
|
||||
console.error('Test email error:', error)
|
||||
|
||||
@@ -100,7 +100,8 @@ export interface Config {
|
||||
};
|
||||
jobs: {
|
||||
tasks: {
|
||||
'process-email-queue': ProcessEmailQueueJob;
|
||||
processEmails: ProcessEmailsJob;
|
||||
'send-email': TaskSendEmail;
|
||||
inline: {
|
||||
input: unknown;
|
||||
output: unknown;
|
||||
@@ -232,21 +233,17 @@ export interface Email {
|
||||
*/
|
||||
template?: (string | null) | EmailTemplate;
|
||||
/**
|
||||
* Template slug used for this email
|
||||
* Recipient email addresses
|
||||
*/
|
||||
templateSlug?: string | null;
|
||||
to: string[];
|
||||
/**
|
||||
* Recipient email address(es), comma-separated
|
||||
* CC email addresses
|
||||
*/
|
||||
to: string;
|
||||
cc?: string[] | null;
|
||||
/**
|
||||
* CC email address(es), comma-separated
|
||||
* BCC email addresses
|
||||
*/
|
||||
cc?: string | null;
|
||||
/**
|
||||
* BCC email address(es), comma-separated
|
||||
*/
|
||||
bcc?: string | null;
|
||||
bcc?: string[] | null;
|
||||
/**
|
||||
* Sender email address (optional, uses default if not provided)
|
||||
*/
|
||||
@@ -362,7 +359,7 @@ export interface PayloadJob {
|
||||
| {
|
||||
executedAt: string;
|
||||
completedAt: string;
|
||||
taskSlug: 'inline' | 'process-email-queue';
|
||||
taskSlug: 'inline' | 'processEmails' | 'send-email';
|
||||
taskID: string;
|
||||
input?:
|
||||
| {
|
||||
@@ -395,7 +392,7 @@ export interface PayloadJob {
|
||||
id?: string | null;
|
||||
}[]
|
||||
| null;
|
||||
taskSlug?: ('inline' | 'process-email-queue') | null;
|
||||
taskSlug?: ('inline' | 'processEmails' | 'send-email') | null;
|
||||
queue?: string | null;
|
||||
waitUntil?: string | null;
|
||||
processing?: boolean | null;
|
||||
@@ -542,7 +539,6 @@ export interface EmailTemplatesSelect<T extends boolean = true> {
|
||||
*/
|
||||
export interface EmailsSelect<T extends boolean = true> {
|
||||
template?: T;
|
||||
templateSlug?: T;
|
||||
to?: T;
|
||||
cc?: T;
|
||||
bcc?: T;
|
||||
@@ -627,12 +623,69 @@ export interface PayloadMigrationsSelect<T extends boolean = true> {
|
||||
}
|
||||
/**
|
||||
* This interface was referenced by `Config`'s JSON-Schema
|
||||
* via the `definition` "ProcessEmailQueueJob".
|
||||
* via the `definition` "ProcessEmailsJob".
|
||||
*/
|
||||
export interface ProcessEmailQueueJob {
|
||||
export interface ProcessEmailsJob {
|
||||
input?: unknown;
|
||||
output?: unknown;
|
||||
}
|
||||
/**
|
||||
* This interface was referenced by `Config`'s JSON-Schema
|
||||
* via the `definition` "TaskSend-email".
|
||||
*/
|
||||
export interface TaskSendEmail {
|
||||
input: {
|
||||
/**
|
||||
* Use a template (leave empty for direct email)
|
||||
*/
|
||||
templateSlug?: string | null;
|
||||
/**
|
||||
* JSON object with variables for template rendering
|
||||
*/
|
||||
variables?:
|
||||
| {
|
||||
[k: string]: unknown;
|
||||
}
|
||||
| unknown[]
|
||||
| string
|
||||
| number
|
||||
| boolean
|
||||
| null;
|
||||
/**
|
||||
* Email subject (required if not using template)
|
||||
*/
|
||||
subject?: string | null;
|
||||
/**
|
||||
* HTML email content (required if not using template)
|
||||
*/
|
||||
html?: string | null;
|
||||
/**
|
||||
* Plain text email content (optional)
|
||||
*/
|
||||
text?: string | null;
|
||||
/**
|
||||
* Comma-separated list of email addresses
|
||||
*/
|
||||
to: string;
|
||||
/**
|
||||
* Optional comma-separated list of CC email addresses
|
||||
*/
|
||||
cc?: string | null;
|
||||
/**
|
||||
* Optional comma-separated list of BCC email addresses
|
||||
*/
|
||||
bcc?: string | null;
|
||||
/**
|
||||
* Optional date/time to schedule email for future delivery
|
||||
*/
|
||||
scheduledAt?: string | null;
|
||||
/**
|
||||
* Email priority (1 = highest, 10 = lowest)
|
||||
*/
|
||||
priority?: number | null;
|
||||
};
|
||||
output?: unknown;
|
||||
}
|
||||
/**
|
||||
* This interface was referenced by `Config`'s JSON-Schema
|
||||
* via the `definition` "auth".
|
||||
|
||||
@@ -1,12 +1,10 @@
|
||||
import { mongooseAdapter } from '@payloadcms/db-mongodb'
|
||||
import { lexicalEditor } from '@payloadcms/richtext-lexical'
|
||||
import {
|
||||
BlocksFeature,
|
||||
FixedToolbarFeature,
|
||||
HeadingFeature,
|
||||
HorizontalRuleFeature,
|
||||
InlineToolbarFeature,
|
||||
lexicalHTML,
|
||||
} from '@payloadcms/richtext-lexical'
|
||||
import { MongoMemoryReplSet } from 'mongodb-memory-server'
|
||||
import path from 'path'
|
||||
@@ -17,7 +15,7 @@ import { fileURLToPath } from 'url'
|
||||
import { testEmailAdapter } from './helpers/testEmailAdapter.js'
|
||||
import { seed, seedUser } from './seed.js'
|
||||
import mailingPlugin from "../src/plugin.js"
|
||||
import { sendEmail } from "../src/utils/helpers.js"
|
||||
import {sendEmail} from "@xtr-dev/payload-mailing"
|
||||
|
||||
const filename = fileURLToPath(import.meta.url)
|
||||
const dirname = path.dirname(filename)
|
||||
@@ -85,15 +83,19 @@ const buildConfigWithMemoryDB = async () => {
|
||||
|
||||
// Queue the welcome email using template slug
|
||||
const emailId = await sendEmail(req.payload, {
|
||||
templateSlug: 'welcome-email',
|
||||
to: doc.email,
|
||||
variables: {
|
||||
firstName: doc.firstName || doc.email?.split('@')?.[0],
|
||||
siteName: 'PayloadCMS Mailing Demo',
|
||||
createdAt: new Date().toISOString(),
|
||||
isPremium: false,
|
||||
dashboardUrl: 'http://localhost:3000/admin',
|
||||
template: {
|
||||
slug: 'welcome-email',
|
||||
variables: {
|
||||
firstName: doc.firstName || doc.email?.split('@')?.[0],
|
||||
siteName: 'PayloadCMS Mailing Demo',
|
||||
createdAt: new Date().toISOString(),
|
||||
isPremium: false,
|
||||
dashboardUrl: 'http://localhost:3000/admin',
|
||||
},
|
||||
},
|
||||
data: {
|
||||
to: doc.email,
|
||||
}
|
||||
})
|
||||
|
||||
console.log('✅ Welcome email queued successfully. Email ID:', emailId)
|
||||
@@ -280,56 +282,6 @@ const buildConfigWithMemoryDB = async () => {
|
||||
],
|
||||
}),
|
||||
|
||||
emailWrapper: (email) => {
|
||||
// Example: wrap email content in a custom layout
|
||||
const wrappedHtml = `
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<title>${email.subject}</title>
|
||||
<style>
|
||||
body { font-family: Arial, sans-serif; margin: 0; padding: 20px; background-color: #f5f5f5; }
|
||||
.container { max-width: 600px; margin: 0 auto; background: white; border-radius: 8px; overflow: hidden; }
|
||||
.header { background: #007bff; color: white; padding: 20px; text-align: center; }
|
||||
.content { padding: 30px; }
|
||||
.footer { background: #f8f9fa; padding: 15px; text-align: center; font-size: 12px; color: #6c757d; }
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<div class="container">
|
||||
<div class="header">
|
||||
<h1>My Company</h1>
|
||||
</div>
|
||||
<div class="content">
|
||||
${email.html}
|
||||
</div>
|
||||
<div class="footer">
|
||||
This email was sent from My Company. If you have questions, contact support@mycompany.com
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
`
|
||||
|
||||
const wrappedText = `
|
||||
MY COMPANY
|
||||
==========
|
||||
|
||||
${email.text || email.html?.replace(/<[^>]*>/g, '')}
|
||||
|
||||
---
|
||||
This email was sent from My Company.
|
||||
If you have questions, contact support@mycompany.com
|
||||
`
|
||||
|
||||
return {
|
||||
...email,
|
||||
html: wrappedHtml,
|
||||
text: wrappedText.trim(),
|
||||
}
|
||||
},
|
||||
|
||||
// Called after mailing plugin is fully initialized
|
||||
onReady: async (payload) => {
|
||||
|
||||
@@ -102,7 +102,7 @@ export const seed = async (payload: Payload) => {
|
||||
format: 0,
|
||||
mode: 'normal',
|
||||
style: '',
|
||||
text: 'Use the emailWrapper hook to add custom layouts',
|
||||
text: 'Create beautiful emails with rich text formatting',
|
||||
type: 'text',
|
||||
version: 1,
|
||||
},
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
// Simple test to verify plugin can be imported and initialized
|
||||
import { mailingPlugin, sendEmail, scheduleEmail } from '@xtr-dev/payload-mailing'
|
||||
import { mailingPlugin, sendEmail, renderTemplate } from '@xtr-dev/payload-mailing'
|
||||
|
||||
console.log('✅ Plugin imports successfully')
|
||||
console.log('✅ mailingPlugin:', typeof mailingPlugin)
|
||||
console.log('✅ sendEmail:', typeof sendEmail)
|
||||
console.log('✅ scheduleEmail:', typeof scheduleEmail)
|
||||
console.log('✅ sendEmail:', typeof sendEmail)
|
||||
console.log('✅ renderTemplate:', typeof renderTemplate)
|
||||
|
||||
// Test plugin configuration
|
||||
try {
|
||||
|
||||
@@ -19,13 +19,13 @@
|
||||
"@payload-config": [
|
||||
"./payload.config.ts"
|
||||
],
|
||||
"temp-project": [
|
||||
"@xtr-dev/payload-mailing": [
|
||||
"../src/index.ts"
|
||||
],
|
||||
"temp-project/client": [
|
||||
"@xtr-dev/payload-mailing/client": [
|
||||
"../src/exports/client.ts"
|
||||
],
|
||||
"temp-project/rsc": [
|
||||
"@xtr-dev/payload-mailing/rsc": [
|
||||
"../src/exports/rsc.ts"
|
||||
]
|
||||
},
|
||||
|
||||
12
package.json
12
package.json
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@xtr-dev/payload-mailing",
|
||||
"version": "0.0.7",
|
||||
"version": "0.1.9",
|
||||
"description": "Template-based email system with scheduling and job processing for PayloadCMS",
|
||||
"type": "module",
|
||||
"main": "dist/index.js",
|
||||
@@ -23,8 +23,9 @@
|
||||
"dev:generate-importmap": "npm run dev:payload generate:importmap",
|
||||
"dev:generate-types": "npm run dev:payload generate:types",
|
||||
"dev:payload": "cross-env PAYLOAD_CONFIG_PATH=./dev/payload.config.ts payload",
|
||||
"generate:importmap": "npm run dev:generate-importmap",
|
||||
"generate:types": "npm run dev:generate-types",
|
||||
"payload": "cross-env NODE_OPTIONS=--no-deprecation payload",
|
||||
"generate:importmap": "npm run payload generate:importmap",
|
||||
"generate:types": "npm run payload generate:types",
|
||||
"lint": "eslint",
|
||||
"lint:fix": "eslint ./src --fix",
|
||||
"prepublishOnly": "npm run clean && npm run build",
|
||||
@@ -47,9 +48,12 @@
|
||||
"payload": "^3.37.0"
|
||||
},
|
||||
"dependencies": {
|
||||
"handlebars": "^4.7.8",
|
||||
"nodemailer": "^6.9.8"
|
||||
},
|
||||
"optionalDependencies": {
|
||||
"liquidjs": "^10.19.0",
|
||||
"mustache": "^4.2.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@eslint/eslintrc": "^3.2.0",
|
||||
"@payloadcms/db-mongodb": "^3.37.0",
|
||||
|
||||
31
payload.config.ts
Normal file
31
payload.config.ts
Normal file
@@ -0,0 +1,31 @@
|
||||
/**
|
||||
* This config is only used to generate types.
|
||||
*/
|
||||
|
||||
import { BaseDatabaseAdapter, buildConfig, Payload} from 'payload'
|
||||
import Emails from "./src/collections/Emails.js"
|
||||
import {createEmailTemplatesCollection} from "./src/collections/EmailTemplates.js"
|
||||
import path from "path"
|
||||
import { fileURLToPath } from 'url'
|
||||
|
||||
const __filename = fileURLToPath(import.meta.url)
|
||||
const __dirname = path.dirname(__filename)
|
||||
|
||||
export default buildConfig({
|
||||
collections: [
|
||||
Emails,
|
||||
createEmailTemplatesCollection()
|
||||
],
|
||||
db: {
|
||||
allowIDOnCreate: undefined,
|
||||
defaultIDType: 'number',
|
||||
init: function (args: { payload: Payload; }): BaseDatabaseAdapter {
|
||||
throw new Error('Function not implemented.');
|
||||
},
|
||||
name: undefined
|
||||
},
|
||||
secret: '',
|
||||
typescript: {
|
||||
outputFile: path.resolve(__dirname, 'src/payload-types.ts'),
|
||||
}
|
||||
});
|
||||
66
pnpm-lock.yaml
generated
66
pnpm-lock.yaml
generated
@@ -8,9 +8,6 @@ importers:
|
||||
|
||||
.:
|
||||
dependencies:
|
||||
handlebars:
|
||||
specifier: ^4.7.8
|
||||
version: 4.7.8
|
||||
nodemailer:
|
||||
specifier: ^6.9.8
|
||||
version: 6.10.1
|
||||
@@ -117,6 +114,13 @@ importers:
|
||||
vitest:
|
||||
specifier: ^3.1.2
|
||||
version: 3.2.4(@types/debug@4.1.12)(@types/node@22.18.1)(sass@1.77.4)(tsx@4.20.3)
|
||||
optionalDependencies:
|
||||
liquidjs:
|
||||
specifier: ^10.19.0
|
||||
version: 10.21.1
|
||||
mustache:
|
||||
specifier: ^4.2.0
|
||||
version: 4.2.0
|
||||
|
||||
packages:
|
||||
|
||||
@@ -2637,6 +2641,10 @@ packages:
|
||||
colorette@2.0.20:
|
||||
resolution: {integrity: sha512-IfEDxwoWIjkeXL1eXcDiow4UbKjhLdq6/EuSVR9GMN7KVH3r9gQ83e73hsz1Nd1T3ijd5xv1wcWRYO+D6kCI2w==}
|
||||
|
||||
commander@10.0.1:
|
||||
resolution: {integrity: sha512-y4Mg2tXshplEbSGzx7amzPwKKOCGuoSRP/CjEdwwk0FOGlUbq6lKuoyDZTNZkmxHdJtp54hdfY/JUrdL7Xfdug==}
|
||||
engines: {node: '>=14'}
|
||||
|
||||
commander@2.20.3:
|
||||
resolution: {integrity: sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ==}
|
||||
|
||||
@@ -3540,11 +3548,6 @@ packages:
|
||||
resolution: {integrity: sha512-mS1lbMsxgQj6hge1XZ6p7GPhbrtFwUFYi3wRzXAC/FmYnyXMTvvI3td3rjmQ2u8ewXueaSvRPWaEcgVVOT9Jnw==}
|
||||
engines: {node: ^12.22.0 || ^14.16.0 || ^16.0.0 || >=17.0.0}
|
||||
|
||||
handlebars@4.7.8:
|
||||
resolution: {integrity: sha512-vafaFqs8MZkRrSX7sFVUdo3ap/eNiLnb4IakshzvP56X5Nr1iGKAIqdX6tMlm6HcNRIkr6AxO5jFEoJzzpT8aQ==}
|
||||
engines: {node: '>=0.4.7'}
|
||||
hasBin: true
|
||||
|
||||
has-bigints@1.1.0:
|
||||
resolution: {integrity: sha512-R3pbpkcIqv2Pm3dUwgjclDRVmWpTJW2DcMzcIhEXEx1oh/CEMObMm3KLmRJOdvhM7o4uQBnwr8pzRK2sJWIqfg==}
|
||||
engines: {node: '>= 0.4'}
|
||||
@@ -3922,6 +3925,11 @@ packages:
|
||||
lines-and-columns@1.2.4:
|
||||
resolution: {integrity: sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg==}
|
||||
|
||||
liquidjs@10.21.1:
|
||||
resolution: {integrity: sha512-NZXmCwv3RG5nire3fmIn9HsOyJX3vo+ptp0yaXUHAMzSNBhx74Hm+dAGJvscUA6lNqbLuYfXgNavRQ9UbUJhQQ==}
|
||||
engines: {node: '>=14'}
|
||||
hasBin: true
|
||||
|
||||
locate-path@5.0.0:
|
||||
resolution: {integrity: sha512-t7hw9pI+WvuwNJXwk5zVHpyhIqzg2qTlklJOf0mVxGSbe3Fp2VieZcduNYjaLDoy6p9uGpQEGWG87WpMKlNq8g==}
|
||||
engines: {node: '>=8'}
|
||||
@@ -4186,6 +4194,10 @@ packages:
|
||||
ms@2.1.3:
|
||||
resolution: {integrity: sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==}
|
||||
|
||||
mustache@4.2.0:
|
||||
resolution: {integrity: sha512-71ippSywq5Yb7/tVYyGbkBggbU8H3u5Rz56fH60jGFgr8uHwxs+aSKeqmluIVzM0m0kB7xQjKS6qPfd0b2ZoqQ==}
|
||||
hasBin: true
|
||||
|
||||
nanoid@3.3.11:
|
||||
resolution: {integrity: sha512-N8SpfPUnUp1bK+PMYW8qSWdl9U+wwNWI4QKxOYDy9JAro3WMX7p2OeVRF9v+347pnakNevPmiHhNmZ2HbFA76w==}
|
||||
engines: {node: ^10 || ^12 || ^13.7 || ^14 || >=15.0.1}
|
||||
@@ -4202,9 +4214,6 @@ packages:
|
||||
natural-compare@1.4.0:
|
||||
resolution: {integrity: sha512-OWND8ei3VtNC9h7V60qff3SVobHr996CTwgxubgyQYEpg290h9J0buyECNNJexkFm5sOajh5G116RYA1c8ZMSw==}
|
||||
|
||||
neo-async@2.6.2:
|
||||
resolution: {integrity: sha512-Yd3UES5mWCSqR+qNT93S3UoYUkqAZ9lLg8a7g9rimsWmYGK8cVToA4/sF3RrshdyV3sAGMXVUmpMYOw+dLpOuw==}
|
||||
|
||||
new-find-package-json@2.0.0:
|
||||
resolution: {integrity: sha512-lDcBsjBSMlj3LXH2v/FW3txlh2pYTjmbOXPYJD93HI5EwuLzI11tdHSIpUMmfq/IOsldj4Ps8M8flhm+pCK4Ew==}
|
||||
engines: {node: '>=12.22.0'}
|
||||
@@ -5170,11 +5179,6 @@ packages:
|
||||
engines: {node: '>=14.17'}
|
||||
hasBin: true
|
||||
|
||||
uglify-js@3.19.3:
|
||||
resolution: {integrity: sha512-v3Xu+yuwBXisp6QYTcH4UbH+xYJXqnq2m/LtQVWKWzYc1iehYnLixoQDN9FH6/j9/oybfd6W9Ghwkl8+UMKTKQ==}
|
||||
engines: {node: '>=0.8.0'}
|
||||
hasBin: true
|
||||
|
||||
uint8array-extras@1.5.0:
|
||||
resolution: {integrity: sha512-rvKSBiC5zqCCiDZ9kAOszZcDvdAHwwIKJG33Ykj43OKcWsnmcBRL09YTU4nOeHZ8Y2a7l1MgTd08SBe9A8Qj6A==}
|
||||
engines: {node: '>=18'}
|
||||
@@ -5377,9 +5381,6 @@ packages:
|
||||
resolution: {integrity: sha512-BN22B5eaMMI9UMtjrGd5g5eCYPpCPDUy0FJXbYsaT5zYxjFOckS53SQDE3pWkVoWpHXVb3BrYcEN4Twa55B5cA==}
|
||||
engines: {node: '>=0.10.0'}
|
||||
|
||||
wordwrap@1.0.0:
|
||||
resolution: {integrity: sha512-gvVzJFlPycKc5dZN4yPkP8w7Dc37BtP1yczEneOb4uq34pXZcvrtRTmWV8W+Ume+XCxKgbjM+nevkyFPMybd4Q==}
|
||||
|
||||
wrap-ansi@7.0.0:
|
||||
resolution: {integrity: sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q==}
|
||||
engines: {node: '>=10'}
|
||||
@@ -8540,6 +8541,9 @@ snapshots:
|
||||
|
||||
colorette@2.0.20: {}
|
||||
|
||||
commander@10.0.1:
|
||||
optional: true
|
||||
|
||||
commander@2.20.3: {}
|
||||
|
||||
commander@6.2.1: {}
|
||||
@@ -9689,15 +9693,6 @@ snapshots:
|
||||
|
||||
graphql@16.11.0: {}
|
||||
|
||||
handlebars@4.7.8:
|
||||
dependencies:
|
||||
minimist: 1.2.8
|
||||
neo-async: 2.6.2
|
||||
source-map: 0.6.1
|
||||
wordwrap: 1.0.0
|
||||
optionalDependencies:
|
||||
uglify-js: 3.19.3
|
||||
|
||||
has-bigints@1.1.0: {}
|
||||
|
||||
has-flag@4.0.0: {}
|
||||
@@ -10044,6 +10039,11 @@ snapshots:
|
||||
|
||||
lines-and-columns@1.2.4: {}
|
||||
|
||||
liquidjs@10.21.1:
|
||||
dependencies:
|
||||
commander: 10.0.1
|
||||
optional: true
|
||||
|
||||
locate-path@5.0.0:
|
||||
dependencies:
|
||||
p-locate: 4.1.0
|
||||
@@ -10431,6 +10431,9 @@ snapshots:
|
||||
|
||||
ms@2.1.3: {}
|
||||
|
||||
mustache@4.2.0:
|
||||
optional: true
|
||||
|
||||
nanoid@3.3.11: {}
|
||||
|
||||
napi-postinstall@0.3.3: {}
|
||||
@@ -10439,8 +10442,6 @@ snapshots:
|
||||
|
||||
natural-compare@1.4.0: {}
|
||||
|
||||
neo-async@2.6.2: {}
|
||||
|
||||
new-find-package-json@2.0.0:
|
||||
dependencies:
|
||||
debug: 4.4.1
|
||||
@@ -11571,9 +11572,6 @@ snapshots:
|
||||
|
||||
typescript@5.9.2: {}
|
||||
|
||||
uglify-js@3.19.3:
|
||||
optional: true
|
||||
|
||||
uint8array-extras@1.5.0: {}
|
||||
|
||||
unbox-primitive@1.1.0:
|
||||
@@ -11820,8 +11818,6 @@ snapshots:
|
||||
|
||||
word-wrap@1.2.5: {}
|
||||
|
||||
wordwrap@1.0.0: {}
|
||||
|
||||
wrap-ansi@7.0.0:
|
||||
dependencies:
|
||||
ansi-styles: 4.3.0
|
||||
|
||||
12
src/index.ts
12
src/index.ts
@@ -11,13 +11,19 @@ export { MailingService } from './services/MailingService.js'
|
||||
export { default as EmailTemplates, createEmailTemplatesCollection } from './collections/EmailTemplates.js'
|
||||
export { default as Emails } from './collections/Emails.js'
|
||||
|
||||
// Jobs are integrated into the plugin configuration
|
||||
// Jobs (includes the send email task)
|
||||
export { mailingJobs, sendEmailJob } from './jobs/index.js'
|
||||
export type { SendEmailTaskInput } from './jobs/sendEmailTask.js'
|
||||
|
||||
// Main email sending function
|
||||
export { sendEmail, type SendEmailOptions } from './sendEmail.js'
|
||||
export { default as sendEmailDefault } from './sendEmail.js'
|
||||
|
||||
// Utility functions for developers
|
||||
export {
|
||||
getMailing,
|
||||
sendEmail,
|
||||
scheduleEmail,
|
||||
renderTemplate,
|
||||
processEmails,
|
||||
retryFailedEmails,
|
||||
parseAndValidateEmails,
|
||||
} from './utils/helpers.js'
|
||||
@@ -1,19 +1,35 @@
|
||||
import { processEmailsJob, ProcessEmailsJobData } from './processEmailsJob.js'
|
||||
import { sendEmailJob } from './sendEmailTask.js'
|
||||
import { MailingService } from '../services/MailingService.js'
|
||||
|
||||
export const createMailingJobs = (mailingService: MailingService): any[] => {
|
||||
return [
|
||||
{
|
||||
slug: 'processEmails',
|
||||
handler: async ({ job, req }: { job: any; req: any }) => {
|
||||
return processEmailsJob(
|
||||
job as { data: ProcessEmailsJobData },
|
||||
{ req, mailingService }
|
||||
)
|
||||
},
|
||||
interfaceName: 'ProcessEmailsJob',
|
||||
},
|
||||
]
|
||||
}
|
||||
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')
|
||||
}
|
||||
|
||||
export * from './processEmailsJob.js'
|
||||
// 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',
|
||||
},
|
||||
sendEmailJob,
|
||||
]
|
||||
|
||||
export * from './processEmailsJob.js'
|
||||
export * from './sendEmailTask.js'
|
||||
@@ -2,7 +2,7 @@ import type { PayloadRequest } from 'payload'
|
||||
import { MailingService } from '../services/MailingService.js'
|
||||
|
||||
export interface ProcessEmailsJobData {
|
||||
type: 'process-emails' | 'retry-failed'
|
||||
// No type needed - always processes both pending and failed emails
|
||||
}
|
||||
|
||||
export const processEmailsJob = async (
|
||||
@@ -10,18 +10,19 @@ export const processEmailsJob = async (
|
||||
context: { req: PayloadRequest; mailingService: MailingService }
|
||||
) => {
|
||||
const { mailingService } = context
|
||||
const { type } = job.data
|
||||
|
||||
try {
|
||||
if (type === 'process-emails') {
|
||||
await mailingService.processEmails()
|
||||
console.log('Email processing completed successfully')
|
||||
} else if (type === 'retry-failed') {
|
||||
await mailingService.retryFailedEmails()
|
||||
console.log('Failed email retry completed successfully')
|
||||
}
|
||||
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(`${type} job failed:`, error)
|
||||
console.error('❌ Email queue processing failed:', error)
|
||||
throw error
|
||||
}
|
||||
}
|
||||
@@ -29,7 +30,6 @@ export const processEmailsJob = async (
|
||||
export const scheduleEmailsJob = async (
|
||||
payload: any,
|
||||
queueName: string,
|
||||
jobType: 'process-emails' | 'retry-failed',
|
||||
delay?: number
|
||||
) => {
|
||||
if (!payload.jobs) {
|
||||
@@ -41,10 +41,10 @@ export const scheduleEmailsJob = async (
|
||||
await payload.jobs.queue({
|
||||
queue: queueName,
|
||||
task: 'processEmails',
|
||||
input: { type: jobType },
|
||||
input: {},
|
||||
waitUntil: delay ? new Date(Date.now() + delay) : undefined,
|
||||
})
|
||||
} catch (error) {
|
||||
console.error(`Failed to schedule ${jobType} job:`, error)
|
||||
console.error('Failed to schedule email processing job:', error)
|
||||
}
|
||||
}
|
||||
179
src/jobs/sendEmailTask.ts
Normal file
179
src/jobs/sendEmailTask.ts
Normal file
@@ -0,0 +1,179 @@
|
||||
import { sendEmail } from '../sendEmail.js'
|
||||
import { Email } from '../payload-types.js'
|
||||
|
||||
export interface SendEmailTaskInput {
|
||||
// Template mode fields
|
||||
templateSlug?: string
|
||||
variables?: Record<string, any>
|
||||
|
||||
// Direct email mode fields
|
||||
subject?: string
|
||||
html?: string
|
||||
text?: string
|
||||
|
||||
// Common fields
|
||||
to: string | string[]
|
||||
cc?: string | string[]
|
||||
bcc?: string | string[]
|
||||
scheduledAt?: string // ISO date string
|
||||
priority?: number
|
||||
|
||||
// Allow any additional fields that users might have in their email collection
|
||||
[key: string]: any
|
||||
}
|
||||
|
||||
export const sendEmailJob = {
|
||||
slug: 'send-email',
|
||||
label: 'Send Email',
|
||||
inputSchema: [
|
||||
{
|
||||
name: 'templateSlug',
|
||||
type: 'text' as const,
|
||||
label: 'Template Slug',
|
||||
admin: {
|
||||
description: 'Use a template (leave empty for direct email)',
|
||||
condition: (data: any) => !data.subject && !data.html
|
||||
}
|
||||
},
|
||||
{
|
||||
name: 'variables',
|
||||
type: 'json' as const,
|
||||
label: 'Template Variables',
|
||||
admin: {
|
||||
description: 'JSON object with variables for template rendering',
|
||||
condition: (data: any) => Boolean(data.templateSlug)
|
||||
}
|
||||
},
|
||||
{
|
||||
name: 'subject',
|
||||
type: 'text' as const,
|
||||
label: 'Subject',
|
||||
admin: {
|
||||
description: 'Email subject (required if not using template)',
|
||||
condition: (data: any) => !data.templateSlug
|
||||
}
|
||||
},
|
||||
{
|
||||
name: 'html',
|
||||
type: 'textarea' as const,
|
||||
label: 'HTML Content',
|
||||
admin: {
|
||||
description: 'HTML email content (required if not using template)',
|
||||
condition: (data: any) => !data.templateSlug
|
||||
}
|
||||
},
|
||||
{
|
||||
name: 'text',
|
||||
type: 'textarea' as const,
|
||||
label: 'Text Content',
|
||||
admin: {
|
||||
description: 'Plain text email content (optional)',
|
||||
condition: (data: any) => !data.templateSlug
|
||||
}
|
||||
},
|
||||
{
|
||||
name: 'to',
|
||||
type: 'text' as const,
|
||||
required: true,
|
||||
label: 'To (Email Recipients)',
|
||||
admin: {
|
||||
description: 'Comma-separated list of email addresses'
|
||||
}
|
||||
},
|
||||
{
|
||||
name: 'cc',
|
||||
type: 'text' as const,
|
||||
label: 'CC (Carbon Copy)',
|
||||
admin: {
|
||||
description: 'Optional comma-separated list of CC email addresses'
|
||||
}
|
||||
},
|
||||
{
|
||||
name: 'bcc',
|
||||
type: 'text' as const,
|
||||
label: 'BCC (Blind Carbon Copy)',
|
||||
admin: {
|
||||
description: 'Optional comma-separated list of BCC email addresses'
|
||||
}
|
||||
},
|
||||
{
|
||||
name: 'scheduledAt',
|
||||
type: 'date' as const,
|
||||
label: 'Schedule For',
|
||||
admin: {
|
||||
description: 'Optional date/time to schedule email for future delivery'
|
||||
}
|
||||
},
|
||||
{
|
||||
name: 'priority',
|
||||
type: 'number' as const,
|
||||
label: 'Priority',
|
||||
min: 1,
|
||||
max: 10,
|
||||
defaultValue: 5,
|
||||
admin: {
|
||||
description: 'Email priority (1 = highest, 10 = lowest)'
|
||||
}
|
||||
}
|
||||
],
|
||||
handler: async ({ input, payload }: any) => {
|
||||
// Cast input to our expected type
|
||||
const taskInput = input as SendEmailTaskInput
|
||||
|
||||
try {
|
||||
// Prepare options for sendEmail based on task input
|
||||
const sendEmailOptions: any = {
|
||||
data: {}
|
||||
}
|
||||
|
||||
// If using template mode
|
||||
if (taskInput.templateSlug) {
|
||||
sendEmailOptions.template = {
|
||||
slug: taskInput.templateSlug,
|
||||
variables: taskInput.variables || {}
|
||||
}
|
||||
}
|
||||
|
||||
// Build data object from task input
|
||||
const dataFields = ['to', 'cc', 'bcc', 'subject', 'html', 'text', 'scheduledAt', 'priority']
|
||||
const additionalFields: string[] = []
|
||||
|
||||
// Copy standard fields
|
||||
dataFields.forEach(field => {
|
||||
if (taskInput[field] !== undefined) {
|
||||
sendEmailOptions.data[field] = taskInput[field]
|
||||
}
|
||||
})
|
||||
|
||||
// Copy any additional custom fields
|
||||
Object.keys(taskInput).forEach(key => {
|
||||
if (!['templateSlug', 'variables', ...dataFields].includes(key)) {
|
||||
sendEmailOptions.data[key] = taskInput[key]
|
||||
additionalFields.push(key)
|
||||
}
|
||||
})
|
||||
|
||||
// Use the sendEmail helper to create the email
|
||||
const email = await sendEmail<Email>(payload, sendEmailOptions)
|
||||
|
||||
return {
|
||||
output: {
|
||||
success: true,
|
||||
emailId: email.id,
|
||||
message: `Email queued successfully with ID: ${email.id}`,
|
||||
mode: taskInput.templateSlug ? 'template' : 'direct',
|
||||
templateSlug: taskInput.templateSlug || null,
|
||||
subject: email.subject,
|
||||
recipients: Array.isArray(email.to) ? email.to.length : 1,
|
||||
scheduledAt: email.scheduledAt || null
|
||||
}
|
||||
}
|
||||
|
||||
} catch (error) {
|
||||
const errorMessage = error instanceof Error ? error.message : 'Unknown error'
|
||||
throw new Error(`Failed to queue email: ${errorMessage}`)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export default sendEmailJob
|
||||
431
src/payload-types.ts
Normal file
431
src/payload-types.ts
Normal file
@@ -0,0 +1,431 @@
|
||||
/* tslint:disable */
|
||||
/* eslint-disable */
|
||||
/**
|
||||
* This file was automatically generated by Payload.
|
||||
* DO NOT MODIFY IT BY HAND. Instead, modify your source Payload config,
|
||||
* and re-run `payload generate:types` to regenerate this file.
|
||||
*/
|
||||
|
||||
/**
|
||||
* Supported timezones in IANA format.
|
||||
*
|
||||
* This interface was referenced by `Config`'s JSON-Schema
|
||||
* via the `definition` "supportedTimezones".
|
||||
*/
|
||||
export type SupportedTimezones =
|
||||
| 'Pacific/Midway'
|
||||
| 'Pacific/Niue'
|
||||
| 'Pacific/Honolulu'
|
||||
| 'Pacific/Rarotonga'
|
||||
| 'America/Anchorage'
|
||||
| 'Pacific/Gambier'
|
||||
| 'America/Los_Angeles'
|
||||
| 'America/Tijuana'
|
||||
| 'America/Denver'
|
||||
| 'America/Phoenix'
|
||||
| 'America/Chicago'
|
||||
| 'America/Guatemala'
|
||||
| 'America/New_York'
|
||||
| 'America/Bogota'
|
||||
| 'America/Caracas'
|
||||
| 'America/Santiago'
|
||||
| 'America/Buenos_Aires'
|
||||
| 'America/Sao_Paulo'
|
||||
| 'Atlantic/South_Georgia'
|
||||
| 'Atlantic/Azores'
|
||||
| 'Atlantic/Cape_Verde'
|
||||
| 'Europe/London'
|
||||
| 'Europe/Berlin'
|
||||
| 'Africa/Lagos'
|
||||
| 'Europe/Athens'
|
||||
| 'Africa/Cairo'
|
||||
| 'Europe/Moscow'
|
||||
| 'Asia/Riyadh'
|
||||
| 'Asia/Dubai'
|
||||
| 'Asia/Baku'
|
||||
| 'Asia/Karachi'
|
||||
| 'Asia/Tashkent'
|
||||
| 'Asia/Calcutta'
|
||||
| 'Asia/Dhaka'
|
||||
| 'Asia/Almaty'
|
||||
| 'Asia/Jakarta'
|
||||
| 'Asia/Bangkok'
|
||||
| 'Asia/Shanghai'
|
||||
| 'Asia/Singapore'
|
||||
| 'Asia/Tokyo'
|
||||
| 'Asia/Seoul'
|
||||
| 'Australia/Brisbane'
|
||||
| 'Australia/Sydney'
|
||||
| 'Pacific/Guam'
|
||||
| 'Pacific/Noumea'
|
||||
| 'Pacific/Auckland'
|
||||
| 'Pacific/Fiji';
|
||||
|
||||
export interface Config {
|
||||
auth: {
|
||||
users: UserAuthOperations;
|
||||
};
|
||||
blocks: {};
|
||||
collections: {
|
||||
emails: Email;
|
||||
'email-templates': EmailTemplate;
|
||||
users: User;
|
||||
'payload-locked-documents': PayloadLockedDocument;
|
||||
'payload-preferences': PayloadPreference;
|
||||
'payload-migrations': PayloadMigration;
|
||||
};
|
||||
collectionsJoins: {};
|
||||
collectionsSelect: {
|
||||
emails: EmailsSelect<false> | EmailsSelect<true>;
|
||||
'email-templates': EmailTemplatesSelect<false> | EmailTemplatesSelect<true>;
|
||||
users: UsersSelect<false> | UsersSelect<true>;
|
||||
'payload-locked-documents': PayloadLockedDocumentsSelect<false> | PayloadLockedDocumentsSelect<true>;
|
||||
'payload-preferences': PayloadPreferencesSelect<false> | PayloadPreferencesSelect<true>;
|
||||
'payload-migrations': PayloadMigrationsSelect<false> | PayloadMigrationsSelect<true>;
|
||||
};
|
||||
db: {
|
||||
defaultIDType: number;
|
||||
};
|
||||
globals: {};
|
||||
globalsSelect: {};
|
||||
locale: null;
|
||||
user: User & {
|
||||
collection: 'users';
|
||||
};
|
||||
jobs: {
|
||||
tasks: unknown;
|
||||
workflows: unknown;
|
||||
};
|
||||
}
|
||||
export interface UserAuthOperations {
|
||||
forgotPassword: {
|
||||
email: string;
|
||||
password: string;
|
||||
};
|
||||
login: {
|
||||
email: string;
|
||||
password: string;
|
||||
};
|
||||
registerFirstUser: {
|
||||
email: string;
|
||||
password: string;
|
||||
};
|
||||
unlock: {
|
||||
email: string;
|
||||
password: string;
|
||||
};
|
||||
}
|
||||
/**
|
||||
* Email delivery and status tracking
|
||||
*
|
||||
* This interface was referenced by `Config`'s JSON-Schema
|
||||
* via the `definition` "emails".
|
||||
*/
|
||||
export interface Email {
|
||||
id: number;
|
||||
/**
|
||||
* Email template used (optional if custom content provided)
|
||||
*/
|
||||
template?: (number | null) | EmailTemplate;
|
||||
/**
|
||||
* Recipient email addresses
|
||||
*/
|
||||
to: string[];
|
||||
/**
|
||||
* CC email addresses
|
||||
*/
|
||||
cc?: string[] | null;
|
||||
/**
|
||||
* BCC email addresses
|
||||
*/
|
||||
bcc?: string[] | null;
|
||||
/**
|
||||
* Sender email address (optional, uses default if not provided)
|
||||
*/
|
||||
from?: string | null;
|
||||
/**
|
||||
* Reply-to email address
|
||||
*/
|
||||
replyTo?: string | null;
|
||||
/**
|
||||
* Email subject line
|
||||
*/
|
||||
subject: string;
|
||||
/**
|
||||
* Rendered HTML content of the email
|
||||
*/
|
||||
html: string;
|
||||
/**
|
||||
* Plain text version of the email
|
||||
*/
|
||||
text?: string | null;
|
||||
/**
|
||||
* Template variables used to render this email
|
||||
*/
|
||||
variables?:
|
||||
| {
|
||||
[k: string]: unknown;
|
||||
}
|
||||
| unknown[]
|
||||
| string
|
||||
| number
|
||||
| boolean
|
||||
| null;
|
||||
/**
|
||||
* When this email should be sent (leave empty for immediate)
|
||||
*/
|
||||
scheduledAt?: string | null;
|
||||
/**
|
||||
* When this email was actually sent
|
||||
*/
|
||||
sentAt?: string | null;
|
||||
/**
|
||||
* Current status of this email
|
||||
*/
|
||||
status: 'pending' | 'processing' | 'sent' | 'failed';
|
||||
/**
|
||||
* Number of send attempts made
|
||||
*/
|
||||
attempts?: number | null;
|
||||
/**
|
||||
* When the last send attempt was made
|
||||
*/
|
||||
lastAttemptAt?: string | null;
|
||||
/**
|
||||
* Last error message if send failed
|
||||
*/
|
||||
error?: string | null;
|
||||
/**
|
||||
* Email priority (1=highest, 10=lowest)
|
||||
*/
|
||||
priority?: number | null;
|
||||
updatedAt: string;
|
||||
createdAt: string;
|
||||
}
|
||||
/**
|
||||
* This interface was referenced by `Config`'s JSON-Schema
|
||||
* via the `definition` "email-templates".
|
||||
*/
|
||||
export interface EmailTemplate {
|
||||
id: number;
|
||||
/**
|
||||
* A descriptive name for this email template
|
||||
*/
|
||||
name: string;
|
||||
/**
|
||||
* Unique identifier for this template (e.g., "welcome-email", "password-reset")
|
||||
*/
|
||||
slug: string;
|
||||
/**
|
||||
* Email subject line. You can use Handlebars variables like {{firstName}} or {{siteName}}.
|
||||
*/
|
||||
subject: string;
|
||||
/**
|
||||
* Email content with rich text formatting. Supports Handlebars variables like {{firstName}} and helpers like {{formatDate createdAt "long"}}. Content is converted to HTML and plain text automatically.
|
||||
*/
|
||||
content: {
|
||||
root: {
|
||||
type: string;
|
||||
children: {
|
||||
type: string;
|
||||
version: number;
|
||||
[k: string]: unknown;
|
||||
}[];
|
||||
direction: ('ltr' | 'rtl') | null;
|
||||
format: 'left' | 'start' | 'center' | 'right' | 'end' | 'justify' | '';
|
||||
indent: number;
|
||||
version: number;
|
||||
};
|
||||
[k: string]: unknown;
|
||||
};
|
||||
updatedAt: string;
|
||||
createdAt: string;
|
||||
}
|
||||
/**
|
||||
* This interface was referenced by `Config`'s JSON-Schema
|
||||
* via the `definition` "users".
|
||||
*/
|
||||
export interface User {
|
||||
id: number;
|
||||
updatedAt: string;
|
||||
createdAt: string;
|
||||
email: string;
|
||||
resetPasswordToken?: string | null;
|
||||
resetPasswordExpiration?: string | null;
|
||||
salt?: string | null;
|
||||
hash?: string | null;
|
||||
loginAttempts?: number | null;
|
||||
lockUntil?: string | null;
|
||||
sessions?:
|
||||
| {
|
||||
id: string;
|
||||
createdAt?: string | null;
|
||||
expiresAt: string;
|
||||
}[]
|
||||
| null;
|
||||
password?: string | null;
|
||||
}
|
||||
/**
|
||||
* This interface was referenced by `Config`'s JSON-Schema
|
||||
* via the `definition` "payload-locked-documents".
|
||||
*/
|
||||
export interface PayloadLockedDocument {
|
||||
id: number;
|
||||
document?:
|
||||
| ({
|
||||
relationTo: 'emails';
|
||||
value: number | Email;
|
||||
} | null)
|
||||
| ({
|
||||
relationTo: 'email-templates';
|
||||
value: number | EmailTemplate;
|
||||
} | null)
|
||||
| ({
|
||||
relationTo: 'users';
|
||||
value: number | User;
|
||||
} | null);
|
||||
globalSlug?: string | null;
|
||||
user: {
|
||||
relationTo: 'users';
|
||||
value: number | User;
|
||||
};
|
||||
updatedAt: string;
|
||||
createdAt: string;
|
||||
}
|
||||
/**
|
||||
* This interface was referenced by `Config`'s JSON-Schema
|
||||
* via the `definition` "payload-preferences".
|
||||
*/
|
||||
export interface PayloadPreference {
|
||||
id: number;
|
||||
user: {
|
||||
relationTo: 'users';
|
||||
value: number | User;
|
||||
};
|
||||
key?: string | null;
|
||||
value?:
|
||||
| {
|
||||
[k: string]: unknown;
|
||||
}
|
||||
| unknown[]
|
||||
| string
|
||||
| number
|
||||
| boolean
|
||||
| null;
|
||||
updatedAt: string;
|
||||
createdAt: string;
|
||||
}
|
||||
/**
|
||||
* This interface was referenced by `Config`'s JSON-Schema
|
||||
* via the `definition` "payload-migrations".
|
||||
*/
|
||||
export interface PayloadMigration {
|
||||
id: number;
|
||||
name?: string | null;
|
||||
batch?: number | null;
|
||||
updatedAt: string;
|
||||
createdAt: string;
|
||||
}
|
||||
/**
|
||||
* This interface was referenced by `Config`'s JSON-Schema
|
||||
* via the `definition` "emails_select".
|
||||
*/
|
||||
export interface EmailsSelect<T extends boolean = true> {
|
||||
template?: T;
|
||||
to?: T;
|
||||
cc?: T;
|
||||
bcc?: T;
|
||||
from?: T;
|
||||
replyTo?: T;
|
||||
subject?: T;
|
||||
html?: T;
|
||||
text?: T;
|
||||
variables?: T;
|
||||
scheduledAt?: T;
|
||||
sentAt?: T;
|
||||
status?: T;
|
||||
attempts?: T;
|
||||
lastAttemptAt?: T;
|
||||
error?: T;
|
||||
priority?: T;
|
||||
updatedAt?: T;
|
||||
createdAt?: T;
|
||||
}
|
||||
/**
|
||||
* This interface was referenced by `Config`'s JSON-Schema
|
||||
* via the `definition` "email-templates_select".
|
||||
*/
|
||||
export interface EmailTemplatesSelect<T extends boolean = true> {
|
||||
name?: T;
|
||||
slug?: T;
|
||||
subject?: T;
|
||||
content?: T;
|
||||
updatedAt?: T;
|
||||
createdAt?: T;
|
||||
}
|
||||
/**
|
||||
* This interface was referenced by `Config`'s JSON-Schema
|
||||
* via the `definition` "users_select".
|
||||
*/
|
||||
export interface UsersSelect<T extends boolean = true> {
|
||||
updatedAt?: T;
|
||||
createdAt?: T;
|
||||
email?: T;
|
||||
resetPasswordToken?: T;
|
||||
resetPasswordExpiration?: T;
|
||||
salt?: T;
|
||||
hash?: T;
|
||||
loginAttempts?: T;
|
||||
lockUntil?: T;
|
||||
sessions?:
|
||||
| T
|
||||
| {
|
||||
id?: T;
|
||||
createdAt?: T;
|
||||
expiresAt?: T;
|
||||
};
|
||||
}
|
||||
/**
|
||||
* This interface was referenced by `Config`'s JSON-Schema
|
||||
* via the `definition` "payload-locked-documents_select".
|
||||
*/
|
||||
export interface PayloadLockedDocumentsSelect<T extends boolean = true> {
|
||||
document?: T;
|
||||
globalSlug?: T;
|
||||
user?: T;
|
||||
updatedAt?: T;
|
||||
createdAt?: T;
|
||||
}
|
||||
/**
|
||||
* This interface was referenced by `Config`'s JSON-Schema
|
||||
* via the `definition` "payload-preferences_select".
|
||||
*/
|
||||
export interface PayloadPreferencesSelect<T extends boolean = true> {
|
||||
user?: T;
|
||||
key?: T;
|
||||
value?: T;
|
||||
updatedAt?: T;
|
||||
createdAt?: T;
|
||||
}
|
||||
/**
|
||||
* This interface was referenced by `Config`'s JSON-Schema
|
||||
* via the `definition` "payload-migrations_select".
|
||||
*/
|
||||
export interface PayloadMigrationsSelect<T extends boolean = true> {
|
||||
name?: T;
|
||||
batch?: T;
|
||||
updatedAt?: T;
|
||||
createdAt?: T;
|
||||
}
|
||||
/**
|
||||
* This interface was referenced by `Config`'s JSON-Schema
|
||||
* via the `definition` "auth".
|
||||
*/
|
||||
export interface Auth {
|
||||
[k: string]: unknown;
|
||||
}
|
||||
|
||||
|
||||
declare module 'payload' {
|
||||
export interface GeneratedTypes extends Config {}
|
||||
}
|
||||
@@ -3,10 +3,18 @@ import { MailingPluginConfig, MailingContext } from './types/index.js'
|
||||
import { MailingService } from './services/MailingService.js'
|
||||
import { createEmailTemplatesCollection } from './collections/EmailTemplates.js'
|
||||
import Emails from './collections/Emails.js'
|
||||
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'
|
||||
@@ -77,36 +85,7 @@ export const mailingPlugin = (pluginConfig: MailingPluginConfig) => (config: Con
|
||||
...(config.jobs || {}),
|
||||
tasks: [
|
||||
...(config.jobs?.tasks || []),
|
||||
{
|
||||
slug: 'process-email-queue',
|
||||
handler: async ({ job, req }: { job: any; req: any }) => {
|
||||
try {
|
||||
const mailingService = new MailingService((req as any).payload, pluginConfig)
|
||||
|
||||
console.log('🔄 Processing email queue (pending + failed emails)...')
|
||||
|
||||
// Process pending emails first
|
||||
await mailingService.processEmails()
|
||||
|
||||
// Then retry failed emails
|
||||
await mailingService.retryFailedEmails()
|
||||
|
||||
return {
|
||||
output: {
|
||||
success: true,
|
||||
message: 'Email queue processed successfully (pending and failed emails)'
|
||||
}
|
||||
}
|
||||
} catch (error) {
|
||||
console.error('❌ Error processing email queue:', error)
|
||||
const errorMessage = error instanceof Error ? error.message : 'Unknown error'
|
||||
|
||||
// Properly fail the job by throwing the error
|
||||
throw new Error(`Email queue processing failed: ${errorMessage}`)
|
||||
}
|
||||
},
|
||||
interfaceName: 'ProcessEmailQueueJob',
|
||||
},
|
||||
...mailingJobs,
|
||||
],
|
||||
},
|
||||
onInit: async (payload: any) => {
|
||||
@@ -114,7 +93,7 @@ export const mailingPlugin = (pluginConfig: MailingPluginConfig) => (config: Con
|
||||
await config.onInit(payload)
|
||||
}
|
||||
|
||||
// Initialize mailing service
|
||||
// Initialize mailing service with proper payload instance
|
||||
const mailingService = new MailingService(payload, pluginConfig)
|
||||
|
||||
// Add mailing context to payload for developer access
|
||||
@@ -130,6 +109,14 @@ export const mailingPlugin = (pluginConfig: MailingPluginConfig) => (config: Con
|
||||
|
||||
console.log('PayloadCMS Mailing Plugin initialized successfully')
|
||||
|
||||
// Schedule the initial email processing job
|
||||
try {
|
||||
await scheduleEmailsJob(payload, queueName, 60000) // Schedule in 1 minute
|
||||
console.log(`🔄 Scheduled initial email processing job in queue: ${queueName}`)
|
||||
} catch (error) {
|
||||
console.error('Failed to schedule email processing job:', error)
|
||||
}
|
||||
|
||||
// Call onReady callback if provided
|
||||
if (pluginConfig.onReady) {
|
||||
await pluginConfig.onReady(payload)
|
||||
|
||||
102
src/sendEmail.ts
Normal file
102
src/sendEmail.ts
Normal file
@@ -0,0 +1,102 @@
|
||||
import { Payload } from 'payload'
|
||||
import { getMailing, renderTemplate, parseAndValidateEmails } from './utils/helpers.js'
|
||||
import {Email} from "./payload-types.js"
|
||||
|
||||
// Options for sending emails
|
||||
export interface SendEmailOptions<T extends Email = Email> {
|
||||
// Template-based email
|
||||
template?: {
|
||||
slug: string
|
||||
variables?: Record<string, any>
|
||||
}
|
||||
// Direct email data
|
||||
data?: Partial<T>
|
||||
// Common options
|
||||
collectionSlug?: string // defaults to 'emails'
|
||||
}
|
||||
|
||||
/**
|
||||
* Send an email with full type safety
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* // With your generated Email type
|
||||
* import { Email } from './payload-types'
|
||||
*
|
||||
* const email = await sendEmail<Email>(payload, {
|
||||
* template: {
|
||||
* slug: 'welcome',
|
||||
* variables: { name: 'John' }
|
||||
* },
|
||||
* data: {
|
||||
* to: 'user@example.com',
|
||||
* customField: 'value' // Your custom fields are type-safe!
|
||||
* }
|
||||
* })
|
||||
* ```
|
||||
*/
|
||||
export const sendEmail = async <T extends Email = Email>(
|
||||
payload: Payload,
|
||||
options: SendEmailOptions<T>
|
||||
): Promise<T> => {
|
||||
const mailing = getMailing(payload)
|
||||
const collectionSlug = options.collectionSlug || mailing.collections.emails || 'emails'
|
||||
|
||||
let emailData: Partial<T> = { ...options.data } as Partial<T>
|
||||
|
||||
// If using a template, render it first
|
||||
if (options.template) {
|
||||
const { html, text, subject } = await renderTemplate(
|
||||
payload,
|
||||
options.template.slug,
|
||||
options.template.variables || {}
|
||||
)
|
||||
|
||||
// Template values take precedence over data values
|
||||
emailData = {
|
||||
...emailData,
|
||||
subject,
|
||||
html,
|
||||
text,
|
||||
} as Partial<T>
|
||||
}
|
||||
|
||||
// Validate required fields
|
||||
if (!emailData.to) {
|
||||
throw new Error('Field "to" is required for sending emails')
|
||||
}
|
||||
|
||||
// Validate required fields based on whether template was used
|
||||
if (options.template) {
|
||||
// When using template, subject and html should have been set by renderTemplate
|
||||
if (!emailData.subject || !emailData.html) {
|
||||
throw new Error(`Template rendering failed: template "${options.template.slug}" did not provide required subject and html content`)
|
||||
}
|
||||
} else {
|
||||
// When not using template, user must provide subject and html directly
|
||||
if (!emailData.subject || !emailData.html) {
|
||||
throw new Error('Fields "subject" and "html" are required when sending direct emails without a template')
|
||||
}
|
||||
}
|
||||
|
||||
// Process email addresses using shared validation (handle null values)
|
||||
if (emailData.to) {
|
||||
emailData.to = parseAndValidateEmails(emailData.to as string | string[])
|
||||
}
|
||||
if (emailData.cc) {
|
||||
emailData.cc = parseAndValidateEmails(emailData.cc as string | string[])
|
||||
}
|
||||
if (emailData.bcc) {
|
||||
emailData.bcc = parseAndValidateEmails(emailData.bcc as string | string[])
|
||||
}
|
||||
|
||||
// Create the email in the collection with proper typing
|
||||
const email = await payload.create({
|
||||
collection: collectionSlug,
|
||||
data: emailData
|
||||
})
|
||||
|
||||
return email as T
|
||||
}
|
||||
|
||||
export default sendEmail
|
||||
@@ -1,39 +1,45 @@
|
||||
import { Payload } from 'payload'
|
||||
import Handlebars from 'handlebars'
|
||||
import { Liquid } from 'liquidjs'
|
||||
import nodemailer, { Transporter } from 'nodemailer'
|
||||
import {
|
||||
MailingPluginConfig,
|
||||
SendEmailOptions,
|
||||
import {
|
||||
MailingPluginConfig,
|
||||
TemplateVariables,
|
||||
MailingService as IMailingService,
|
||||
EmailTemplate,
|
||||
QueuedEmail,
|
||||
MailingTransportConfig,
|
||||
EmailObject
|
||||
BaseEmail
|
||||
} from '../types/index.js'
|
||||
import { serializeRichTextToHTML, serializeRichTextToText } from '../utils/richTextSerializer.js'
|
||||
|
||||
export class MailingService implements IMailingService {
|
||||
private payload: Payload
|
||||
public payload: Payload
|
||||
private config: MailingPluginConfig
|
||||
private transporter!: Transporter | any
|
||||
private templatesCollection: string
|
||||
private emailsCollection: string
|
||||
private liquid: Liquid | null | false = null
|
||||
private transporterInitialized = false
|
||||
|
||||
constructor(payload: Payload, config: MailingPluginConfig) {
|
||||
this.payload = payload
|
||||
this.config = config
|
||||
|
||||
|
||||
const templatesConfig = config.collections?.templates
|
||||
this.templatesCollection = typeof templatesConfig === 'string' ? templatesConfig : 'email-templates'
|
||||
|
||||
|
||||
const emailsConfig = config.collections?.emails
|
||||
this.emailsCollection = typeof emailsConfig === 'string' ? emailsConfig : 'emails'
|
||||
|
||||
this.initializeTransporter()
|
||||
this.registerHandlebarsHelpers()
|
||||
|
||||
// Only initialize transporter if payload is properly set
|
||||
if (payload && payload.db) {
|
||||
this.initializeTransporter()
|
||||
}
|
||||
}
|
||||
|
||||
private initializeTransporter(): void {
|
||||
if (this.transporterInitialized) return
|
||||
|
||||
if (this.config.transport) {
|
||||
if ('sendMail' in this.config.transport) {
|
||||
this.transporter = this.config.transport
|
||||
@@ -46,6 +52,17 @@ export class MailingService implements IMailingService {
|
||||
} else {
|
||||
throw new Error('Email transport configuration is required either in plugin config or Payload config')
|
||||
}
|
||||
|
||||
this.transporterInitialized = true
|
||||
}
|
||||
|
||||
private ensureInitialized(): void {
|
||||
if (!this.payload || !this.payload.db) {
|
||||
throw new Error('MailingService payload not properly initialized')
|
||||
}
|
||||
if (!this.transporterInitialized) {
|
||||
this.initializeTransporter()
|
||||
}
|
||||
}
|
||||
|
||||
private getDefaultFrom(): string {
|
||||
@@ -62,109 +79,73 @@ export class MailingService implements IMailingService {
|
||||
return fromEmail || ''
|
||||
}
|
||||
|
||||
private registerHandlebarsHelpers(): void {
|
||||
Handlebars.registerHelper('formatDate', (date: Date, format?: string) => {
|
||||
if (!date) return ''
|
||||
const d = new Date(date)
|
||||
if (format === 'short') {
|
||||
return d.toLocaleDateString()
|
||||
}
|
||||
if (format === 'long') {
|
||||
return d.toLocaleDateString('en-US', {
|
||||
year: 'numeric',
|
||||
month: 'long',
|
||||
day: 'numeric'
|
||||
private async ensureLiquidJSInitialized(): Promise<void> {
|
||||
if (this.liquid !== null) return // Already initialized or failed
|
||||
|
||||
try {
|
||||
const liquidModule = await import('liquidjs')
|
||||
const { Liquid: LiquidEngine } = liquidModule
|
||||
this.liquid = new LiquidEngine()
|
||||
|
||||
// Register custom filters (equivalent to Handlebars helpers)
|
||||
if (this.liquid && typeof this.liquid !== 'boolean') {
|
||||
this.liquid.registerFilter('formatDate', (date: any, format?: string) => {
|
||||
if (!date) return ''
|
||||
const d = new Date(date)
|
||||
if (format === 'short') {
|
||||
return d.toLocaleDateString()
|
||||
}
|
||||
if (format === 'long') {
|
||||
return d.toLocaleDateString('en-US', {
|
||||
year: 'numeric',
|
||||
month: 'long',
|
||||
day: 'numeric'
|
||||
})
|
||||
}
|
||||
return d.toLocaleString()
|
||||
})
|
||||
|
||||
this.liquid.registerFilter('formatCurrency', (amount: any, currency = 'USD') => {
|
||||
if (typeof amount !== 'number') return amount
|
||||
return new Intl.NumberFormat('en-US', {
|
||||
style: 'currency',
|
||||
currency: currency
|
||||
}).format(amount)
|
||||
})
|
||||
|
||||
this.liquid.registerFilter('capitalize', (str: any) => {
|
||||
if (typeof str !== 'string') return str
|
||||
return str.charAt(0).toUpperCase() + str.slice(1)
|
||||
})
|
||||
}
|
||||
return d.toLocaleString()
|
||||
})
|
||||
|
||||
Handlebars.registerHelper('formatCurrency', (amount: number, currency = 'USD') => {
|
||||
if (typeof amount !== 'number') return amount
|
||||
return new Intl.NumberFormat('en-US', {
|
||||
style: 'currency',
|
||||
currency: currency
|
||||
}).format(amount)
|
||||
})
|
||||
|
||||
Handlebars.registerHelper('ifEquals', function(this: any, arg1: any, arg2: any, options: any) {
|
||||
return (arg1 === arg2) ? options.fn(this) : options.inverse(this)
|
||||
})
|
||||
|
||||
Handlebars.registerHelper('capitalize', (str: string) => {
|
||||
if (typeof str !== 'string') return str
|
||||
return str.charAt(0).toUpperCase() + str.slice(1)
|
||||
})
|
||||
} catch (error) {
|
||||
console.warn('LiquidJS not available. Falling back to simple variable replacement. Install liquidjs or use a different templateEngine.')
|
||||
this.liquid = false // Mark as failed to avoid retries
|
||||
}
|
||||
}
|
||||
|
||||
async sendEmail(options: SendEmailOptions): Promise<string> {
|
||||
const emailId = await this.scheduleEmail({
|
||||
...options,
|
||||
scheduledAt: new Date()
|
||||
})
|
||||
async renderTemplate(templateSlug: string, variables: TemplateVariables): Promise<{ html: string; text: string; subject: string }> {
|
||||
this.ensureInitialized()
|
||||
const template = await this.getTemplateBySlug(templateSlug)
|
||||
|
||||
await this.processEmailItem(emailId)
|
||||
|
||||
return emailId
|
||||
}
|
||||
|
||||
async scheduleEmail(options: SendEmailOptions): Promise<string> {
|
||||
let html = options.html || ''
|
||||
let text = options.text || ''
|
||||
let subject = options.subject || ''
|
||||
let templateId: string | undefined = undefined
|
||||
|
||||
if (options.templateSlug) {
|
||||
const template = await this.getTemplateBySlug(options.templateSlug)
|
||||
|
||||
if (template) {
|
||||
templateId = template.id
|
||||
const variables = options.variables || {}
|
||||
const renderedContent = await this.renderEmailTemplate(template, variables)
|
||||
html = renderedContent.html
|
||||
text = renderedContent.text
|
||||
subject = this.renderHandlebarsTemplate(template.subject, variables)
|
||||
} else {
|
||||
throw new Error(`Email template not found: ${options.templateSlug}`)
|
||||
}
|
||||
if (!template) {
|
||||
throw new Error(`Email template not found: ${templateSlug}`)
|
||||
}
|
||||
|
||||
if (!subject && !options.subject) {
|
||||
throw new Error('Email subject is required')
|
||||
const emailContent = await this.renderEmailTemplate(template, variables)
|
||||
const subject = await this.renderTemplateString(template.subject, variables)
|
||||
|
||||
return {
|
||||
html: emailContent.html,
|
||||
text: emailContent.text,
|
||||
subject
|
||||
}
|
||||
|
||||
if (!html && !options.html) {
|
||||
throw new Error('Email HTML content is required')
|
||||
}
|
||||
|
||||
const queueData = {
|
||||
template: templateId,
|
||||
to: Array.isArray(options.to) ? options.to : [options.to],
|
||||
cc: options.cc ? (Array.isArray(options.cc) ? options.cc : [options.cc]) : undefined,
|
||||
bcc: options.bcc ? (Array.isArray(options.bcc) ? options.bcc : [options.bcc]) : undefined,
|
||||
from: options.from || this.getDefaultFrom(),
|
||||
replyTo: options.replyTo,
|
||||
subject: subject || options.subject,
|
||||
html,
|
||||
text,
|
||||
variables: options.variables,
|
||||
scheduledAt: options.scheduledAt?.toISOString(),
|
||||
status: 'pending' as const,
|
||||
attempts: 0,
|
||||
priority: options.priority || 5,
|
||||
}
|
||||
|
||||
const result = await this.payload.create({
|
||||
collection: this.emailsCollection as any,
|
||||
data: queueData,
|
||||
})
|
||||
|
||||
return result.id as string
|
||||
}
|
||||
|
||||
async processEmails(): Promise<void> {
|
||||
this.ensureInitialized()
|
||||
const currentTime = new Date().toISOString()
|
||||
|
||||
|
||||
const { docs: pendingEmails } = await this.payload.find({
|
||||
collection: this.emailsCollection as any,
|
||||
where: {
|
||||
@@ -200,6 +181,7 @@ export class MailingService implements IMailingService {
|
||||
}
|
||||
|
||||
async retryFailedEmails(): Promise<void> {
|
||||
this.ensureInitialized()
|
||||
const maxAttempts = this.config.retryAttempts || 3
|
||||
const retryDelay = this.config.retryDelay || 300000 // 5 minutes
|
||||
const retryTime = new Date(Date.now() - retryDelay).toISOString()
|
||||
@@ -256,10 +238,10 @@ export class MailingService implements IMailingService {
|
||||
const email = await this.payload.findByID({
|
||||
collection: this.emailsCollection as any,
|
||||
id: emailId,
|
||||
}) as QueuedEmail
|
||||
}) as BaseEmail
|
||||
|
||||
let emailObject: EmailObject = {
|
||||
from: email.from || this.getDefaultFrom(),
|
||||
const mailOptions = {
|
||||
from: email.from,
|
||||
to: email.to,
|
||||
cc: email.cc || undefined,
|
||||
bcc: email.bcc || undefined,
|
||||
@@ -267,23 +249,6 @@ export class MailingService implements IMailingService {
|
||||
subject: email.subject,
|
||||
html: email.html,
|
||||
text: email.text || undefined,
|
||||
variables: email.variables,
|
||||
}
|
||||
|
||||
// Apply emailWrapper hook if configured
|
||||
if (this.config.emailWrapper) {
|
||||
emailObject = await this.config.emailWrapper(emailObject)
|
||||
}
|
||||
|
||||
const mailOptions = {
|
||||
from: emailObject.from,
|
||||
to: emailObject.to,
|
||||
cc: emailObject.cc || undefined,
|
||||
bcc: emailObject.bcc || undefined,
|
||||
replyTo: emailObject.replyTo || undefined,
|
||||
subject: emailObject.subject,
|
||||
html: emailObject.html,
|
||||
text: emailObject.text || undefined,
|
||||
}
|
||||
|
||||
await this.transporter.sendMail(mailOptions)
|
||||
@@ -348,7 +313,7 @@ export class MailingService implements IMailingService {
|
||||
},
|
||||
limit: 1,
|
||||
})
|
||||
|
||||
|
||||
return docs.length > 0 ? docs[0] as EmailTemplate : null
|
||||
} catch (error) {
|
||||
console.error(`Template with slug '${templateSlug}' not found:`, error)
|
||||
@@ -356,14 +321,62 @@ export class MailingService implements IMailingService {
|
||||
}
|
||||
}
|
||||
|
||||
private renderHandlebarsTemplate(template: string, variables: Record<string, any>): string {
|
||||
try {
|
||||
const compiled = Handlebars.compile(template)
|
||||
return compiled(variables)
|
||||
} catch (error) {
|
||||
console.error('Handlebars template rendering error:', error)
|
||||
return template
|
||||
private async renderTemplateString(template: string, variables: Record<string, any>): Promise<string> {
|
||||
// Use custom template renderer if provided
|
||||
if (this.config.templateRenderer) {
|
||||
try {
|
||||
return await this.config.templateRenderer(template, variables)
|
||||
} catch (error) {
|
||||
console.error('Custom template renderer error:', error)
|
||||
return template
|
||||
}
|
||||
}
|
||||
|
||||
const engine = this.config.templateEngine || 'liquidjs'
|
||||
|
||||
// Use LiquidJS if configured
|
||||
if (engine === 'liquidjs') {
|
||||
try {
|
||||
await this.ensureLiquidJSInitialized()
|
||||
if (this.liquid && typeof this.liquid !== 'boolean') {
|
||||
return await this.liquid.parseAndRender(template, variables)
|
||||
}
|
||||
} catch (error) {
|
||||
console.error('LiquidJS template rendering error:', error)
|
||||
}
|
||||
}
|
||||
|
||||
// Use Mustache if configured
|
||||
if (engine === 'mustache') {
|
||||
try {
|
||||
const mustacheResult = await this.renderWithMustache(template, variables)
|
||||
if (mustacheResult !== null) {
|
||||
return mustacheResult
|
||||
}
|
||||
} catch (error) {
|
||||
console.warn('Mustache not available. Falling back to simple variable replacement. Install mustache package.')
|
||||
}
|
||||
}
|
||||
|
||||
// Fallback to simple variable replacement
|
||||
return this.simpleVariableReplacement(template, variables)
|
||||
}
|
||||
|
||||
private async renderWithMustache(template: string, variables: Record<string, any>): Promise<string | null> {
|
||||
try {
|
||||
const mustacheModule = await import('mustache')
|
||||
const Mustache = mustacheModule.default || mustacheModule
|
||||
return Mustache.render(template, variables)
|
||||
} catch (error) {
|
||||
return null
|
||||
}
|
||||
}
|
||||
|
||||
private simpleVariableReplacement(template: string, variables: Record<string, any>): string {
|
||||
return template.replace(/\{\{(\w+)\}\}/g, (match, key) => {
|
||||
const value = variables[key]
|
||||
return value !== undefined ? String(value) : match
|
||||
})
|
||||
}
|
||||
|
||||
private async renderEmailTemplate(template: EmailTemplate, variables: Record<string, any> = {}): Promise<{ html: string; text: string }> {
|
||||
@@ -375,11 +388,11 @@ export class MailingService implements IMailingService {
|
||||
let html = serializeRichTextToHTML(template.content)
|
||||
let text = serializeRichTextToText(template.content)
|
||||
|
||||
// Apply Handlebars variables to the rendered content
|
||||
html = this.renderHandlebarsTemplate(html, variables)
|
||||
text = this.renderHandlebarsTemplate(text, variables)
|
||||
// Apply template variables to the rendered content
|
||||
html = await this.renderTemplateString(html, variables)
|
||||
text = await this.renderTemplateString(text, variables)
|
||||
|
||||
return { html, text }
|
||||
}
|
||||
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,20 +1,13 @@
|
||||
import { Payload } from 'payload'
|
||||
import type { CollectionConfig, RichTextField } from 'payload'
|
||||
import { Transporter } from 'nodemailer'
|
||||
import {Email} from "../payload-types.js"
|
||||
|
||||
export interface EmailObject {
|
||||
to: string | string[]
|
||||
cc?: string | string[]
|
||||
bcc?: string | string[]
|
||||
from?: string
|
||||
replyTo?: string
|
||||
subject: string
|
||||
html: string
|
||||
text?: string
|
||||
variables?: Record<string, any>
|
||||
}
|
||||
export type BaseEmail<TEmail = Email, TEmailTemplate = EmailTemplate> = Omit<TEmail, 'id' | 'template'> & {template: Omit<TEmailTemplate, 'id'>}
|
||||
|
||||
export type EmailWrapperHook = (email: EmailObject) => EmailObject | Promise<EmailObject>
|
||||
export type TemplateRendererHook = (template: string, variables: Record<string, any>) => string | Promise<string>
|
||||
|
||||
export type TemplateEngine = 'liquidjs' | 'mustache' | 'simple'
|
||||
|
||||
export interface MailingPluginConfig {
|
||||
collections?: {
|
||||
@@ -27,7 +20,8 @@ export interface MailingPluginConfig {
|
||||
queue?: string
|
||||
retryAttempts?: number
|
||||
retryDelay?: number
|
||||
emailWrapper?: EmailWrapperHook
|
||||
templateRenderer?: TemplateRendererHook
|
||||
templateEngine?: TemplateEngine
|
||||
richTextEditor?: RichTextField['editor']
|
||||
onReady?: (payload: any) => Promise<void>
|
||||
initOrder?: 'before' | 'after'
|
||||
@@ -77,26 +71,15 @@ export interface QueuedEmail {
|
||||
updatedAt: string
|
||||
}
|
||||
|
||||
export interface SendEmailOptions {
|
||||
templateSlug?: string
|
||||
to: string | string[]
|
||||
cc?: string | string[]
|
||||
bcc?: string | string[]
|
||||
from?: string
|
||||
replyTo?: string
|
||||
subject?: string
|
||||
html?: string
|
||||
text?: string
|
||||
variables?: Record<string, any>
|
||||
scheduledAt?: Date
|
||||
priority?: number
|
||||
// Simple helper type for template variables
|
||||
export interface TemplateVariables {
|
||||
[key: string]: any
|
||||
}
|
||||
|
||||
export interface MailingService {
|
||||
sendEmail(options: SendEmailOptions): Promise<string>
|
||||
scheduleEmail(options: SendEmailOptions): Promise<string>
|
||||
processEmails(): Promise<void>
|
||||
retryFailedEmails(): Promise<void>
|
||||
renderTemplate(templateSlug: string, variables: TemplateVariables): Promise<{ html: string; text: string; subject: string }>
|
||||
}
|
||||
|
||||
export interface MailingContext {
|
||||
|
||||
7
src/types/mustache.d.ts
vendored
Normal file
7
src/types/mustache.d.ts
vendored
Normal file
@@ -0,0 +1,7 @@
|
||||
declare module 'mustache' {
|
||||
interface MustacheStatic {
|
||||
render(template: string, view?: any, partials?: any, tags?: string[]): string
|
||||
}
|
||||
const mustache: MustacheStatic
|
||||
export = mustache
|
||||
}
|
||||
@@ -1,5 +1,40 @@
|
||||
import { Payload } from 'payload'
|
||||
import { SendEmailOptions } from '../types/index.js'
|
||||
import { TemplateVariables } from '../types/index.js'
|
||||
|
||||
/**
|
||||
* Parse and validate email addresses
|
||||
* @internal
|
||||
*/
|
||||
export const parseAndValidateEmails = (emails: string | string[] | null | undefined): string[] | undefined => {
|
||||
if (!emails || emails === null) return undefined
|
||||
|
||||
let emailList: string[]
|
||||
if (Array.isArray(emails)) {
|
||||
emailList = emails
|
||||
} else {
|
||||
emailList = emails.split(',').map(email => email.trim()).filter(Boolean)
|
||||
}
|
||||
|
||||
// RFC 5322 compliant email validation
|
||||
const emailRegex = /^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$/
|
||||
const invalidEmails = emailList.filter(email => {
|
||||
// Check basic format
|
||||
if (!emailRegex.test(email)) return true
|
||||
// Check for common invalid patterns
|
||||
if (email.includes('..') || email.startsWith('.') || email.endsWith('.')) return true
|
||||
if (email.includes('@.') || email.includes('.@')) return true
|
||||
// Check domain has at least one dot
|
||||
const parts = email.split('@')
|
||||
if (parts.length !== 2 || !parts[1].includes('.')) return true
|
||||
return false
|
||||
})
|
||||
|
||||
if (invalidEmails.length > 0) {
|
||||
throw new Error(`Invalid email addresses: ${invalidEmails.join(', ')}`)
|
||||
}
|
||||
|
||||
return emailList
|
||||
}
|
||||
|
||||
export const getMailing = (payload: Payload) => {
|
||||
const mailing = (payload as any).mailing
|
||||
@@ -9,14 +44,9 @@ export const getMailing = (payload: Payload) => {
|
||||
return mailing
|
||||
}
|
||||
|
||||
export const sendEmail = async (payload: Payload, options: SendEmailOptions): Promise<string> => {
|
||||
export const renderTemplate = async (payload: Payload, templateSlug: string, variables: TemplateVariables): Promise<{ html: string; text: string; subject: string }> => {
|
||||
const mailing = getMailing(payload)
|
||||
return mailing.service.sendEmail(options)
|
||||
}
|
||||
|
||||
export const scheduleEmail = async (payload: Payload, options: SendEmailOptions): Promise<string> => {
|
||||
const mailing = getMailing(payload)
|
||||
return mailing.service.scheduleEmail(options)
|
||||
return mailing.service.renderTemplate(templateSlug, variables)
|
||||
}
|
||||
|
||||
export const processEmails = async (payload: Payload): Promise<void> => {
|
||||
|
||||
Reference in New Issue
Block a user