Merge pull request #21 from xtr-dev/dev

Dev

README.md

@@ -6,12 +6,19 @@
 
 ## Features
 
-✅ **Template System**: Create reusable email templates with Handlebars syntax  
+✅ **Template System**: Create reusable email templates with LiquidJS, Mustache, or simple variables
-✅ **Outbox Scheduling**: Schedule emails for future delivery  
+
-✅ **Job Integration**: Automatic processing via PayloadCMS jobs queue  
+✅ **Type Safety**: Full TypeScript support using your generated Payload types
-✅ **Retry Failed Sends**: Automatic retry mechanism for failed emails  
+
-✅ **Template Variables**: Dynamic content with validation  
+✅ **Flexible Template Engines**: LiquidJS, Mustache, or bring your own template renderer
-✅ **Developer API**: Simple methods for sending emails programmatically
+
+✅ **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,50 @@ 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'
+import { sendEmail } from '@xtr-dev/payload-mailing'
+import { Email } from './payload-types' // Your generated types
 
-// Send immediately using template slug
+// Option 1: Using templates with full type safety
-const emailId = await sendEmail(payload, {
+const email = await sendEmail<Email>(payload, {
-  templateSlug: 'welcome-email',
+  template: {
-  to: 'user@example.com',
+    slug: 'welcome-email',
-  variables: {
+    variables: {
-    firstName: 'John',
+      firstName: 'John',
-    welcomeUrl: 'https://yoursite.com/welcome'
+      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
+// Option 2: Direct HTML email (no template)
-const scheduledId = await scheduleEmail(payload, {
+const directEmail = await sendEmail<Email>(payload, {
-  templateSlug: 'reminder-email',
+  data: {
-  to: 'user@example.com',
+    to: ['user@example.com', 'another@example.com'],
-  scheduledAt: new Date(Date.now() + 24 * 60 * 60 * 1000), // 24 hours
+    subject: 'Welcome!',
-  variables: {
+    html: '<h1>Welcome John!</h1><p>Thanks for joining!</p>',
-    eventName: 'Product Launch',
+    text: 'Welcome John! Thanks for joining!',
-    eventDate: new Date('2024-01-15')
+    // 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 +109,72 @@ const scheduledId = await scheduleEmail(payload, {
 ### Plugin Options
 
 ```typescript
-interface MailingPluginConfig {
+mailingPlugin({
-  collections?: {
+  // Template engine (optional)
-    templates?: string    // default: 'email-templates'
+  templateEngine: 'liquidjs',  // 'liquidjs' | 'mustache' | 'simple'
-    emails?: string      // default: 'emails'
+
+  // 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
+  emailWrapper: (email) => ({    // optional layout wrapper
+    ...email,
+    html: `<html><body>${email.html}</body></html>`
+  }),
+  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
+### Template Engine Options
-  retryDelay?: number    // default: 300000 (5 minutes)
+
-  emailWrapper?: EmailWrapperHook // optional email layout wrapper
+Choose your preferred template engine:
-  richTextEditor?: RichTextField['editor'] // optional custom rich text editor
+
-  onReady?: (payload: any) => Promise<void> // optional callback after plugin initialization
+```typescript
-  initOrder?: 'before' | 'after' // default: 'before'
+// 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
@@ -473,73 +552,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)
+### LiquidJS (Default)
-- `{{formatCurrency amount 'USD'}}` - Format currency
+- Variables: `{{ user.name }}`
-- `{{capitalize string}}` - Capitalize first letter
+- Logic: `{% if user.isPremium %}Premium content{% endif %}`
-- `{{#ifEquals value1 value2}}...{{/ifEquals}}` - Conditional equality
+- 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, {
+import {
-  templateSlug: 'order-confirmation', // optional - use template slug
+  renderTemplate,    // Render email templates with variables
-  to: ['customer@example.com'],       // string or array of emails
+  processEmails,     // Process pending emails manually
-  cc: ['manager@example.com'],        // optional - array of emails
+  retryFailedEmails, // Retry failed emails
-  bcc: ['archive@example.com'],       // optional - array of emails  
+  getMailing        // Get mailing service instance
-  from: 'orders@yoursite.com',        // optional, uses default
+} from '@xtr-dev/payload-mailing'
-  replyTo: 'support@yoursite.com',    // optional
+
-  subject: 'Custom subject',          // required if no template
+// Render a template
-  html: '<h1>Custom HTML</h1>',       // required if no template
+const { html, text, subject } = await renderTemplate(payload, 'welcome', {
-  text: 'Custom text version',        // optional
+  name: 'John',
-  variables: {                        // template variables
+  activationUrl: 'https://example.com/activate'
-    orderNumber: '12345',
-    customerName: 'John Doe'
-  },
-  priority: 1                         // optional, 1-10 (1 = highest)
 })
+
+// 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, {
+import { buildConfig } from 'payload/config'
-  templateSlug: 'newsletter',
+import { sendTemplateEmailTask } from '@xtr-dev/payload-mailing'
-  to: ['user1@example.com', 'user2@example.com'],
+
-  scheduledAt: new Date('2024-01-15T10:00:00Z'),
+export default buildConfig({
-  variables: {
+  // ... your config
-    month: 'January',
+  jobs: {
-    highlights: ['Feature A', 'Feature B']
+    tasks: [
+      sendTemplateEmailTask,
+      // ... your other tasks
+    ]
   }
 })
 ```
 
-### processEmails(payload)
+### 2. Queue emails from your code
-
-Manually process pending emails:
 
 ```typescript
-import { processEmails } from '@xtr-dev/payload-mailing'
+import type { SendTemplateEmailInput } from '@xtr-dev/payload-mailing'
-await processEmails(payload)
+
+// 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
+### Task Benefits
-import { retryFailedEmails } from '@xtr-dev/payload-mailing'
+
-await retryFailedEmails(payload)
+- ✅ **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 +849,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:**
+**🚀 Major API Simplification:**
-- Removed email layouts system in favor of `emailWrapper` hook for better flexibility
+- **REMOVED**: `sendEmail()` and `scheduleEmail()` wrapper methods
-- Email fields (`to`, `cc`, `bcc`) now use `hasMany: true` for proper array handling  
+- **REMOVED**: `SendEmailOptions` custom types
-- Templates now use slug-based lookup instead of ID-based for developer-friendly API
+- **ADDED**: Direct Payload collection usage with full type safety
-- Email collection renamed from "outbox" to "emails"
+- **ADDED**: `renderTemplate()` helper for template rendering
-- Unified job processing: single `process-email-queue` job handles both pending and failed emails
+- **ADDED**: Support for LiquidJS, Mustache, and custom template engines
+- **IMPROVED**: Webpack compatibility with proper dynamic imports
 
-**✨ New Features:**
+**Template Engine Enhancements:**
-- Rich text editor with automatic HTML/text conversion
+- **NEW**: LiquidJS support (default) with modern syntax and logic
-- Template slugs for easier template reference
+- **NEW**: Mustache support for logic-less templates
-- `emailWrapper` hook for consistent email layouts
+- **NEW**: Custom template renderer hook for maximum flexibility
-- Custom rich text editor configuration support
+- **NEW**: Simple variable replacement as fallback
-- Initialization hooks (`onReady`, `initOrder`) for better plugin lifecycle control
+- **FIXED**: All webpack compatibility issues resolved
-- Improved Handlebars variable interpolation with defensive programming
 
-**🐛 Bug Fixes:**
+**Developer Experience:**
-- Fixed text version uppercase conversion in headings
+- **IMPROVED**: Full TypeScript inference using generated Payload types
-- Fixed Handlebars interpolation issues in text version
+- **IMPROVED**: Comprehensive migration guide and documentation
-- Improved plugin initialization order to prevent timing issues
+- **IMPROVED**: Better error handling and async patterns
-
+- **SIMPLIFIED**: Cleaner codebase with fewer abstractions
-**💡 Improvements:**
-- Better admin UI with proper array input controls
-- More robust error handling and logging
-- Enhanced TypeScript definitions
-- Simplified template creation workflow
 
 ## License
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xtr-dev/payload-mailing",
-  "version": "0.0.12",
+  "version": "0.1.5",
   "description": "Template-based email system with scheduling and job processing for PayloadCMS",
   "type": "module",
   "main": "dist/index.js",

src/index.ts

@@ -11,13 +11,17 @@ 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'
 
 // Utility functions for developers
 export {
   getMailing,
-  sendEmail,
+  renderTemplate,
-  scheduleEmail,
   processEmails,
   retryFailedEmails,
+  sendEmail,
+  type BaseEmailData,
+  type SendEmailOptions,
 } from './utils/helpers.js'

src/jobs/index.ts

@@ -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[] => {
+export const mailingJobs = [
-  return [
+  {
-    {
+    slug: 'processEmails',
-      slug: 'processEmails',
+    handler: async ({ job, req }: { job: any; req: any }) => {
-      handler: async ({ job, req }: { job: any; req: any }) => {
+      // Get mailing context from payload
-        return processEmailsJob(
+      const payload = (req as any).payload
-          job as { data: ProcessEmailsJobData },
+      const mailingContext = payload.mailing
-          { req, mailingService }
+      if (!mailingContext) {
-        )
+        throw new Error('Mailing plugin not properly initialized')
-      },
+      }
-      interfaceName: 'ProcessEmailsJob',
-    },
-  ]
-}
 
-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'

src/jobs/processEmailsJob.ts

@@ -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') {
+    console.log('🔄 Processing email queue (pending + failed emails)...')
-      await mailingService.processEmails()
+
-      console.log('Email processing completed successfully')
+    // Process pending emails first
-    } else if (type === 'retry-failed') {
+    await mailingService.processEmails()
-      await mailingService.retryFailedEmails()
+
-      console.log('Failed email retry completed successfully')
+    // 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)
   }
 }

src/jobs/sendEmailTask.ts

@@ -0,0 +1,178 @@
+import { sendEmail, type BaseEmailData } from '../utils/helpers.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<BaseEmailData>(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

src/plugin.ts

@@ -3,53 +3,8 @@ 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'
 
-// Helper function to schedule the email processing job
-async function scheduleEmailProcessingJob(payload: any, queueName: string, delayMs: number = 60000): Promise<boolean> {
-  if (!queueName || typeof queueName !== 'string') {
-    throw new Error('Invalid queueName: must be a non-empty string')
-  }
-
-  const jobSlug = 'process-email-queue'
-
-  // Check if there's already a scheduled job for this task
-  const existingJobs = await payload.find({
-    collection: 'payload-jobs',
-    where: {
-      and: [
-        {
-          taskSlug: {
-            equals: jobSlug,
-          },
-        },
-        {
-          hasCompleted: {
-            equals: false,
-          },
-        },
-      ],
-    },
-    limit: 1,
-  })
-
-  // If no existing job, schedule a new one
-  if (existingJobs.docs.length === 0) {
-    await payload.create({
-      collection: 'payload-jobs',
-      data: {
-        taskSlug: jobSlug,
-        input: {},
-        queue: queueName,
-        waitUntil: new Date(Date.now() + delayMs),
-      },
-    })
-    console.log(`🔄 Scheduled email processing job in queue: ${queueName}`)
-    return true
-  } else {
-    console.log(`✅ Email processing job already scheduled in queue: ${queueName}`)
-    return false
-  }
-}
 
 export const mailingPlugin = (pluginConfig: MailingPluginConfig) => (config: Config): Config => {
   const queueName = pluginConfig.queue || 'default'
@@ -59,6 +14,7 @@ export const mailingPlugin = (pluginConfig: MailingPluginConfig) => (config: Con
     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'
@@ -129,61 +85,7 @@ export const mailingPlugin = (pluginConfig: MailingPluginConfig) => (config: Con
       ...(config.jobs || {}),
       tasks: [
         ...(config.jobs?.tasks || []),
-        {
+        ...mailingJobs,
-          slug: 'process-email-queue',
-          handler: async ({ job, req }: { job: any; req: any }) => {
-            const payload = (req as any).payload
-            let jobResult = null
-
-            try {
-              const mailingService = new MailingService(payload, pluginConfig)
-
-              console.log('🔄 Processing email queue (pending + failed emails)...')
-
-              // Process pending emails first
-              await mailingService.processEmails()
-
-              // Then retry failed emails
-              await mailingService.retryFailedEmails()
-
-              jobResult = {
-                output: {
-                  success: true,
-                  message: 'Email queue processed successfully (pending and failed emails)'
-                }
-              }
-
-              console.log('✅ Email queue processing completed successfully')
-
-            } catch (error) {
-              console.error('❌ Error processing email queue:', error)
-              const errorMessage = error instanceof Error ? error.message : 'Unknown error'
-
-              jobResult = new Error(`Email queue processing failed: ${errorMessage}`)
-            }
-
-            // Always reschedule the next job (success or failure) using duplicate prevention
-            let rescheduled = false
-            try {
-              rescheduled = await scheduleEmailProcessingJob(payload, queueName, 300000) // Reschedule in 5 minutes
-              if (rescheduled) {
-                console.log(`🔄 Rescheduled next email processing job in ${queueName} queue`)
-              }
-            } catch (rescheduleError) {
-              console.error('❌ Failed to reschedule email processing job:', rescheduleError)
-              // If rescheduling fails, we should warn but not fail the current job
-              // since the email processing itself may have succeeded
-              console.warn('⚠️  Email processing completed but next job could not be scheduled')
-            }
-
-            // Return the original result or throw the error
-            if (jobResult instanceof Error) {
-              throw jobResult
-            }
-            return jobResult
-          },
-          interfaceName: 'ProcessEmailQueueJob',
-        },
       ],
     },
     onInit: async (payload: any) => {
@@ -191,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
@@ -207,9 +109,10 @@ export const mailingPlugin = (pluginConfig: MailingPluginConfig) => (config: Con
 
       console.log('PayloadCMS Mailing Plugin initialized successfully')
 
-      // Schedule the email processing job if not already scheduled
+      // Schedule the initial email processing job
       try {
-        await scheduleEmailProcessingJob(payload, queueName)
+        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)
       }

src/services/MailingService.ts

@@ -3,7 +3,7 @@ import { Liquid } from 'liquidjs'
 import nodemailer, { Transporter } from 'nodemailer'
 import {
   MailingPluginConfig,
-  SendEmailOptions,
+  TemplateVariables,
   MailingService as IMailingService,
   EmailTemplate,
   QueuedEmail,
@@ -13,12 +13,13 @@ import {
 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
@@ -30,10 +31,15 @@ export class MailingService implements IMailingService {
     const emailsConfig = config.collections?.emails
     this.emailsCollection = typeof emailsConfig === 'string' ? emailsConfig : 'emails'
 
-    this.initializeTransporter()
+    // 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 {
@@ -107,72 +124,26 @@ export class MailingService implements IMailingService {
     }
   }
 
-  async sendEmail(options: SendEmailOptions): Promise<string> {
+  async renderTemplate(templateSlug: string, variables: TemplateVariables): Promise<{ html: string; text: string; subject: string }> {
-    const emailId = await this.scheduleEmail({
+    this.ensureInitialized()
-      ...options,
+    const template = await this.getTemplateBySlug(templateSlug)
-      scheduledAt: new Date()
-    })
 
-    await this.processEmailItem(emailId)
+    if (!template) {
-
+      throw new Error(`Email template not found: ${templateSlug}`)
-    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 = await this.renderTemplate(template.subject, variables)
-      } else {
-        throw new Error(`Email template not found: ${options.templateSlug}`)
-      }
     }
 
-    if (!subject && !options.subject) {
+    const emailContent = await this.renderEmailTemplate(template, variables)
-      throw new Error('Email subject is required')
+    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({
@@ -210,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()
@@ -366,7 +338,7 @@ export class MailingService implements IMailingService {
     }
   }
 
-  private async renderTemplate(template: string, variables: Record<string, any>): Promise<string> {
+  private async renderTemplateString(template: string, variables: Record<string, any>): Promise<string> {
     // Use custom template renderer if provided
     if (this.config.templateRenderer) {
       try {
@@ -434,8 +406,8 @@ export class MailingService implements IMailingService {
     let text = serializeRichTextToText(template.content)
 
     // Apply template variables to the rendered content
-    html = await this.renderTemplate(html, variables)
+    html = await this.renderTemplateString(html, variables)
-    text = await this.renderTemplate(text, variables)
+    text = await this.renderTemplateString(text, variables)
 
     return { html, text }
   }

src/types/index.ts

@@ -1,5 +1,5 @@
 import { Payload } from 'payload'
-import type { CollectionConfig, RichTextField } from 'payload'
+import type { CollectionConfig, RichTextField, TypedCollection } from 'payload'
 import { Transporter } from 'nodemailer'
 
 export interface EmailObject {
@@ -83,26 +83,15 @@ export interface QueuedEmail {
   updatedAt: string
 }
 
-export interface SendEmailOptions {
+// Simple helper type for template variables
-  templateSlug?: string
+export interface TemplateVariables {
-  to: string | string[]
+  [key: string]: any
-  cc?: string | string[]
-  bcc?: string | string[]
-  from?: string
-  replyTo?: string
-  subject?: string
-  html?: string
-  text?: string
-  variables?: Record<string, any>
-  scheduledAt?: Date
-  priority?: number
 }
 
 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 {

src/utils/helpers.ts

@@ -1,5 +1,55 @@
 import { Payload } from 'payload'
-import { SendEmailOptions } from '../types/index.js'
+import { TemplateVariables } from '../types/index.js'
+
+// Base type for email data that all emails must have
+export interface BaseEmailData {
+  to: string | string[]
+  cc?: string | string[]
+  bcc?: string | string[]
+  subject?: string
+  html?: string
+  text?: string
+  scheduledAt?: string | Date
+  priority?: number
+  [key: string]: any
+}
+
+// Options for sending emails
+export interface SendEmailOptions<T extends BaseEmailData = BaseEmailData> {
+  // Template-based email
+  template?: {
+    slug: string
+    variables?: Record<string, any>
+  }
+  // Direct email data
+  data?: Partial<T>
+  // Common options
+  collectionSlug?: string // defaults to 'emails'
+}
+
+/**
+ * Parse and validate email addresses
+ * @internal
+ */
+export const parseAndValidateEmails = (emails: string | string[] | undefined): string[] | undefined => {
+  if (!emails) return undefined
+
+  let emailList: string[]
+  if (Array.isArray(emails)) {
+    emailList = emails
+  } else {
+    emailList = emails.split(',').map(email => email.trim()).filter(Boolean)
+  }
+
+  // Basic email validation
+  const emailRegex = /^[^\s@]+@[^\s@]+\.[^\s@]+$/
+  const invalidEmails = emailList.filter(email => !emailRegex.test(email))
+  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 +59,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)
+  return mailing.service.renderTemplate(templateSlug, variables)
-}
-
-export const scheduleEmail = async (payload: Payload, options: SendEmailOptions): Promise<string> => {
-  const mailing = getMailing(payload)
-  return mailing.service.scheduleEmail(options)
 }
 
 export const processEmails = async (payload: Payload): Promise<void> => {
@@ -27,4 +72,84 @@ export const processEmails = async (payload: Payload): Promise<void> => {
 export const retryFailedEmails = async (payload: Payload): Promise<void> => {
   const mailing = getMailing(payload)
   return mailing.service.retryFailedEmails()
+}
+
+/**
+ * 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 BaseEmailData = BaseEmailData>(
+  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')
+  }
+
+  if (!emailData.subject || !emailData.html) {
+    throw new Error('Fields "subject" and "html" are required when not using a template')
+  }
+
+  // Process email addresses using shared validation
+  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[])
+  }
+
+  // Convert scheduledAt to ISO string if it's a Date
+  if (emailData.scheduledAt instanceof Date) {
+    emailData.scheduledAt = emailData.scheduledAt.toISOString()
+  }
+
+  // Create the email in the collection
+  const email = await payload.create({
+    collection: collectionSlug as any,
+    data: emailData as any
+  })
+
+  return email as unknown as T
 }

template-syntax-migration.md

@@ -1,160 +0,0 @@
-# Template Engine Options
-
-The plugin now supports flexible template rendering with multiple options:
-
-1. **String-based Configuration** (easy setup with built-in engines)
-2. **Custom Template Renderer Hook** (maximum flexibility)
-3. **Simple Variable Replacement** (fallback, no dependencies)
-
-## Configuration Options
-
-### String-based Template Engine Configuration
-Easy setup using built-in template engines:
-
-```typescript
-// Using LiquidJS (default, requires: npm install liquidjs)
-mailingPlugin({
-  templateEngine: 'liquidjs'
-})
-
-// Using Mustache (requires: npm install mustache)
-mailingPlugin({
-  templateEngine: 'mustache'
-})
-
-// Using simple variable replacement (no dependencies)
-mailingPlugin({
-  templateEngine: 'simple'
-})
-```
-
-### Custom Template Renderer Hook
-```typescript
-// Example with Handlebars
-import Handlebars from 'handlebars'
-
-mailingPlugin({
-  templateRenderer: async (template: string, variables: Record<string, any>) => {
-    const compiled = Handlebars.compile(template)
-    return compiled(variables)
-  }
-})
-
-// Example with Mustache
-import Mustache from 'mustache'
-
-mailingPlugin({
-  templateRenderer: async (template: string, variables: Record<string, any>) => {
-    return Mustache.render(template, variables)
-  }
-})
-
-// Example with Nunjucks
-import nunjucks from 'nunjucks'
-
-mailingPlugin({
-  templateRenderer: async (template: string, variables: Record<string, any>) => {
-    return nunjucks.renderString(template, variables)
-  }
-})
-```
-
-### Using LiquidJS (Optional)
-Install the optional dependency:
-```bash
-npm install liquidjs
-# or
-pnpm add liquidjs
-```
-
-### Fallback Mode
-If no custom renderer is provided and neither LiquidJS nor Mustache are installed, simple `{{variable}}` replacement is used.
-
-## Template Syntax Reference
-
-### Mustache Syntax (Logic-less)
-```mustache
-Hello {{user.name}},
-
-{{#user.isPremium}}
-  Welcome to premium! Your balance is {{balance}}.
-{{/user.isPremium}}
-
-{{#orders}}
-  Order: {{id}} - {{date}}
-{{/orders}}
-```
-
-### LiquidJS Syntax (With Logic)
-```liquid
-Hello {{user.name}},
-
-{% if user.isPremium %}
-  Welcome to premium! Your balance is {{balance | formatCurrency}}.
-{% endif %}
-
-{% for order in orders %}
-  Order: {{order.id}} - {{order.date | formatDate: "short"}}
-{% endfor %}
-```
-
-### Simple Variable Replacement
-```
-Hello {{user.name}},
-Your balance is {{balance}}.
-```
-
-## Migration from Handlebars
-
-### Variables
-- **Handlebars**: `{{variable}}`
-- **LiquidJS**: `{{variable}}` (same)
-
-### Conditionals
-- **Handlebars**: `{{#if condition}}content{{/if}}`
-- **LiquidJS**: `{% if condition %}content{% endif %}`
-
-### Loops
-- **Handlebars**: `{{#each items}}{{this}}{{/each}}`
-- **LiquidJS**: `{% for item in items %}{{item}}{% endfor %}`
-
-### Filters/Helpers
-- **Handlebars**: `{{formatDate date "short"}}`
-- **LiquidJS**: `{{date | formatDate: "short"}}`
-
-### Available Filters
-- `formatDate` - Format dates (short, long, or default)
-- `formatCurrency` - Format currency amounts
-- `capitalize` - Capitalize first letter
-
-### Comparison Operations (LiquidJS Advantage)
-- **Handlebars**: Required `{{#ifEquals}}` helper
-- **LiquidJS**: Built-in: `{% if user.role == "admin" %}`
-
-## Example Migration
-
-### Before (Handlebars)
-```handlebars
-Hello {{user.name}},
-
-{{#if user.isPremium}}
-  Welcome to premium! Your balance is {{formatCurrency balance}}.
-{{/if}}
-
-{{#each orders}}
-  Order: {{this.id}} - {{formatDate this.date "short"}}
-{{/each}}
-```
-
-### After (LiquidJS)
-```liquid
-Hello {{user.name}},
-
-{% if user.isPremium %}
-  Welcome to premium! Your balance is {{balance | formatCurrency}}.
-{% endif %}
-
-{% for order in orders %}
-  Order: {{order.id}} - {{order.date | formatDate: "short"}}
-{% endfor %}
-```