Merge pull request #43 from xtr-dev/dev

Remove verbose initialization logs
Update development documentation for silent plugin initialization
2025-12-10 16:23:23 +00:00 · 2025-09-14 18:36:19 +02:00 · 2025-09-14 18:33:34 +02:00 · 2025-09-14 18:18:20 +02:00 · 2025-09-14 18:07:19 +02:00 · 2025-09-14 18:00:23 +02:00
19 changed files with 740 additions and 612 deletions
--- a/DEVELOPMENT.md
+++ b/DEVELOPMENT.md
@@ -126,9 +126,10 @@ When you start the dev server, look for these messages:
 🎯 Test interface will be available at: /mailing-test
 ✅ Example email templates created successfully
 PayloadCMS Mailing Plugin initialized successfully
 ```
 **Note**: The plugin initializes silently on success (no "initialized successfully" message). If you see no errors, the plugin loaded correctly.
 ## Troubleshooting
 ### Server won't start
--- a/README.md
+++ b/README.md
@@ -28,26 +28,31 @@ npm install @xtr-dev/payload-mailing
 ## Quick Start
-### 1. Add the plugin to your Payload config
+### 1. Configure email in your Payload config and add the plugin
 ```typescript
 import { buildConfig } from 'payload/config'
 import { mailingPlugin } from '@xtr-dev/payload-mailing'
 import { nodemailerAdapter } from '@payloadcms/email-nodemailer'
 export default buildConfig({
  // ... your config
  email: nodemailerAdapter({
    defaultFromAddress: 'noreply@yoursite.com',
    defaultFromName: 'Your Site',
    transport: {
      host: 'smtp.gmail.com',
      port: 587,
      auth: {
        user: process.env.EMAIL_USER,
        pass: process.env.EMAIL_PASS,
      },
    },
  }),
  plugins: [
    mailingPlugin({
      defaultFrom: 'noreply@yoursite.com',
-      transport: {
+      defaultFromName: 'Your Site Name',
        host: 'smtp.gmail.com',
        port: 587,
        secure: false,
        auth: {
          user: process.env.EMAIL_USER,
          pass: process.env.EMAIL_PASS,
        },
      },
      retryAttempts: 3,
      retryDelay: 300000, // 5 minutes
      queue: 'email-queue', // optional
@@ -119,13 +124,6 @@ mailingPlugin({
    return yourCustomEngine.render(template, variables)
  },
  // Email transport
  transport: {
    host: 'smtp.gmail.com',
    port: 587,
    auth: { user: '...', pass: '...' }
  },
  // Collection names (optional)
  collections: {
    templates: 'email-templates',  // default
@@ -139,13 +137,21 @@ mailingPlugin({
  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!')
  },
  // beforeSend hook - modify emails before sending
  beforeSend: async (options, email) => {
    // Add attachments, modify headers, etc.
    options.attachments = [
      { filename: 'invoice.pdf', content: pdfBuffer }
    ]
    options.headers = {
      'X-Campaign-ID': email.campaignId
    }
    return options
  }
 })
 ```
@@ -227,7 +233,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"}}.
@@ -238,282 +244,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:
@@ -535,6 +265,56 @@ mailingPlugin({
 })
 ```
 ### beforeSend Hook
 Modify emails before they are sent to add attachments, custom headers, or make other changes:
 ```typescript
 mailingPlugin({
  // ... other config
  beforeSend: async (options, email) => {
    // Add attachments dynamically
    if (email.invoiceId) {
      const invoice = await generateInvoicePDF(email.invoiceId)
      options.attachments = [
        {
          filename: `invoice-${email.invoiceId}.pdf`,
          content: invoice.buffer,
          contentType: 'application/pdf'
        }
      ]
    }
    // Add custom headers
    options.headers = {
      'X-Campaign-ID': email.campaignId,
      'X-Customer-ID': email.customerId,
      'X-Priority': email.priority === 1 ? 'High' : 'Normal'
    }
    // Modify recipients based on conditions
    if (process.env.NODE_ENV === 'development') {
      // Redirect all emails to test address in dev
      options.to = ['test@example.com']
      options.subject = `[TEST] ${options.subject}`
    }
    // Add BCC for compliance
    if (email.requiresAudit) {
      options.bcc = ['audit@company.com']
    }
    return options
  }
 })
 ```
 The `beforeSend` hook receives:
 - `options`: The nodemailer mail options that will be sent
 - `email`: The full email document from the database
 You must return the modified options object.
 ### Initialization Hooks
 Control plugin initialization order and add post-initialization logic:
@@ -600,9 +380,9 @@ await processEmails(payload)
 await retryFailedEmails(payload)
 ```
-## PayloadCMS Task Integration
+## PayloadCMS Integration
-The plugin provides a ready-to-use PayloadCMS task for queuing template emails:
+The plugin provides PayloadCMS tasks for email processing:
 ### 1. Add the task to your Payload config
@@ -675,6 +455,27 @@ The task can also be triggered from the Payload admin panel with a user-friendly
 - ✅ **Error Handling**: Comprehensive error reporting
 - ✅ **Queue Management**: Leverage Payload's job queue system
 ### Immediate Processing
 The send email task now supports immediate processing. Enable the `processImmediately` option to send emails instantly:
 ```typescript
 await payload.jobs.queue({
  task: 'send-email',
  input: {
    processImmediately: true, // Send immediately (default: false)
    templateSlug: 'welcome-email',
    to: ['user@example.com'],
    variables: { name: 'John' }
  }
 })
 ```
 **Benefits**:
 - No separate workflow needed
 - Unified task interface
 - Optional immediate processing when needed
 ## Job Processing
 The plugin automatically adds a unified email processing job to PayloadCMS:
--- a/dev/payload-types.ts
+++ b/dev/payload-types.ts
@@ -248,6 +248,10 @@ export interface Email {
   * Sender email address (optional, uses default if not provided)
   */
  from?: string | null;
  /**
   * Sender display name (optional, e.g., "John Doe" for "John Doe <john@example.com>")
   */
  fromName?: string | null;
  /**
   * Reply-to email address
   */
@@ -543,6 +547,7 @@ export interface EmailsSelect<T extends boolean = true> {
  cc?: T;
  bcc?: T;
  from?: T;
  fromName?: T;
  replyTo?: T;
  subject?: T;
  html?: T;
@@ -675,6 +680,18 @@ export interface TaskSendEmail {
     * Optional comma-separated list of BCC email addresses
     */
    bcc?: string | null;
    /**
     * Optional sender email address (uses default if not provided)
     */
    from?: string | null;
    /**
     * Optional sender display name (e.g., "John Doe")
     */
    fromName?: string | null;
    /**
     * Optional reply-to email address
     */
    replyTo?: string | null;
    /**
     * Optional date/time to schedule email for future delivery
     */
@@ -684,7 +701,9 @@ export interface TaskSendEmail {
     */
    priority?: number | null;
  };
-  output?: unknown;
+  output: {
    id?: string | null;
  };
 }
 /**
 * This interface was referenced by `Config`'s JSON-Schema
--- a/dev/payload.config.ts
+++ b/dev/payload.config.ts
@@ -135,15 +135,6 @@ const buildConfigWithMemoryDB = async () => {
      mailingPlugin({
        defaultFrom: 'noreply@test.com',
        initOrder: 'after',
        transport: {
          host: 'localhost',
          port: 1025, // MailHog port for dev
          secure: false,
          auth: {
            user: 'test',
            pass: 'test',
          },
        },
        retryAttempts: 3,
        retryDelay: 60000, // 1 minute for dev
        queue: 'email-queue',
@@ -282,56 +273,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) => {
--- a/dev/seed.ts
+++ b/dev/seed.ts
@@ -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,
                      },
--- a/dev/test-hook-validation.ts
+++ b/dev/test-hook-validation.ts
@@ -0,0 +1,113 @@
 // Test hook validation in the dev environment
 import { getPayload } from 'payload'
 import config from './payload.config.js'
 async function testHookValidation() {
  const payload = await getPayload({ config: await config })
  console.log('\n🧪 Testing beforeSend hook validation...\n')
  // Test 1: Create an email to process
  const email = await payload.create({
    collection: 'emails',
    data: {
      to: ['test@example.com'],
      subject: 'Test Email for Validation',
      html: '<p>Testing hook validation</p>',
      text: 'Testing hook validation',
      status: 'pending'
    }
  })
  console.log('✅ Test email created:', email.id)
  // Get the mailing service
  const mailingService = (payload as any).mailing.service
  // Test 2: Temporarily replace the config with a bad hook
  const originalBeforeSend = mailingService.config.beforeSend
  console.log('\n📝 Test: Hook that removes "from" field...')
  mailingService.config.beforeSend = async (options: any, email: any) => {
    delete options.from
    return options
  }
  try {
    await mailingService.processEmails()
    console.log('❌ Should have thrown error for missing "from"')
  } catch (error: any) {
    if (error.message.includes('must not remove the "from" property')) {
      console.log('✅ Correctly caught missing "from" field')
    } else {
      console.log('❌ Unexpected error:', error.message)
    }
  }
  console.log('\n📝 Test: Hook that empties "to" array...')
  mailingService.config.beforeSend = async (options: any, email: any) => {
    options.to = []
    return options
  }
  try {
    await mailingService.processEmails()
    console.log('❌ Should have thrown error for empty "to"')
  } catch (error: any) {
    if (error.message.includes('must not remove or empty the "to" property')) {
      console.log('✅ Correctly caught empty "to" array')
    } else {
      console.log('❌ Unexpected error:', error.message)
    }
  }
  console.log('\n📝 Test: Hook that removes "subject"...')
  mailingService.config.beforeSend = async (options: any, email: any) => {
    delete options.subject
    return options
  }
  try {
    await mailingService.processEmails()
    console.log('❌ Should have thrown error for missing "subject"')
  } catch (error: any) {
    if (error.message.includes('must not remove the "subject" property')) {
      console.log('✅ Correctly caught missing "subject" field')
    } else {
      console.log('❌ Unexpected error:', error.message)
    }
  }
  console.log('\n📝 Test: Hook that removes both "html" and "text"...')
  mailingService.config.beforeSend = async (options: any, email: any) => {
    delete options.html
    delete options.text
    return options
  }
  try {
    await mailingService.processEmails()
    console.log('❌ Should have thrown error for missing content')
  } catch (error: any) {
    if (error.message.includes('must not remove both "html" and "text" properties')) {
      console.log('✅ Correctly caught missing content fields')
    } else {
      console.log('❌ Unexpected error:', error.message)
    }
  }
  // Restore original hook
  mailingService.config.beforeSend = originalBeforeSend
  console.log('\n✅ All validation tests completed!\n')
  // Clean up
  await payload.delete({
    collection: 'emails',
    id: email.id
  })
  process.exit(0)
 }
 testHookValidation().catch(console.error)
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
 {
  "name": "@xtr-dev/payload-mailing",
-  "version": "0.1.8",
+  "version": "0.4.3",
  "description": "Template-based email system with scheduling and job processing for PayloadCMS",
  "type": "module",
  "main": "dist/index.js",
--- a/src/collections/Emails.ts
+++ b/src/collections/Emails.ts
@@ -49,6 +49,13 @@ const Emails: CollectionConfig = {
        description: 'Sender email address (optional, uses default if not provided)',
      },
    },
    {
      name: 'fromName',
      type: 'text',
      admin: {
        description: 'Sender display name (optional, e.g., "John Doe" for "John Doe <john@example.com>")',
      },
    },
    {
      name: 'replyTo',
      type: 'text',
--- a/src/index.ts
+++ b/src/index.ts
@@ -27,3 +27,6 @@ export {
  retryFailedEmails,
  parseAndValidateEmails,
 } from './utils/helpers.js'
 // Email processing utilities
 export { processEmailById, processAllEmails } from './utils/emailProcessor.js'
--- a/src/jobs/index.ts
+++ b/src/jobs/index.ts
@@ -1,35 +1,14 @@
-import { processEmailsJob, ProcessEmailsJobData } from './processEmailsJob.js'
+import { processEmailsJob } from './processEmailsTask.js'
 import { sendEmailJob } from './sendEmailTask.js'
 import { MailingService } from '../services/MailingService.js'
 /**
 * All mailing-related jobs that get registered with Payload
 */
 export const mailingJobs = [
-  {
+  processEmailsJob,
    slug: 'processEmails',
    handler: async ({ job, req }: { job: any; req: any }) => {
      // Get mailing context from payload
      const payload = (req as any).payload
      const mailingContext = payload.mailing
      if (!mailingContext) {
        throw new Error('Mailing plugin not properly initialized')
      }
      // Use the existing mailing service from context
      await processEmailsJob(
        job as { data: ProcessEmailsJobData },
        { req, mailingService: mailingContext.service }
      )
      return {
        output: {
          success: true,
          message: 'Email queue processing completed successfully'
        }
      }
    },
    interfaceName: 'ProcessEmailsJob',
  },
  sendEmailJob,
 ]
-export * from './processEmailsJob.js'
+// Re-export everything from individual job files
 export * from './processEmailsTask.js'
 export * from './sendEmailTask.js'
--- a/src/jobs/processEmailsJob.ts
+++ b/src/jobs/processEmailsJob.ts
@@ -1,50 +0,0 @@
 import type { PayloadRequest } from 'payload'
 import { MailingService } from '../services/MailingService.js'
 export interface ProcessEmailsJobData {
  // No type needed - always processes both pending and failed emails
 }
 export const processEmailsJob = async (
  job: { data: ProcessEmailsJobData },
  context: { req: PayloadRequest; mailingService: MailingService }
 ) => {
  const { mailingService } = context
  try {
    console.log('🔄 Processing email queue (pending + failed emails)...')
    // Process pending emails first
    await mailingService.processEmails()
    // Then retry failed emails
    await mailingService.retryFailedEmails()
    console.log('✅ Email queue processing completed successfully (pending and failed emails)')
  } catch (error) {
    console.error('❌ Email queue processing failed:', error)
    throw error
  }
 }
 export const scheduleEmailsJob = async (
  payload: any,
  queueName: string,
  delay?: number
 ) => {
  if (!payload.jobs) {
    console.warn('PayloadCMS jobs not configured - emails will not be processed automatically')
    return
  }
  try {
    await payload.jobs.queue({
      queue: queueName,
      task: 'processEmails',
      input: {},
      waitUntil: delay ? new Date(Date.now() + delay) : undefined,
    })
  } catch (error) {
    console.error('Failed to schedule email processing job:', error)
  }
 }
--- a/src/jobs/processEmailsTask.ts
+++ b/src/jobs/processEmailsTask.ts
@@ -0,0 +1,93 @@
 import type { PayloadRequest, Payload } from 'payload'
 import { processAllEmails } from '../utils/emailProcessor.js'
 /**
 * Data passed to the process emails task
 */
 export interface ProcessEmailsTaskData {
  // Currently no data needed - always processes both pending and failed emails
 }
 /**
 * Handler function for processing emails
 * Used internally by the task definition
 */
 export const processEmailsTaskHandler = async (
  job: { data: ProcessEmailsTaskData },
  context: { req: PayloadRequest }
 ) => {
  const { req } = context
  const payload = (req as any).payload
  try {
    console.log('🔄 Processing email queue (pending + failed emails)...')
    // Use the shared email processing logic
    await processAllEmails(payload)
    console.log('✅ Email queue processing completed successfully')
  } catch (error) {
    console.error('❌ Email queue processing failed:', error)
    throw error
  }
 }
 /**
 * Task definition for processing emails
 * This is what gets registered with Payload's job system
 */
 export const processEmailsTask = {
  slug: 'process-emails',
  handler: async ({ job, req }: { job: any; req: any }) => {
    // Get mailing context from payload
    const payload = (req as any).payload
    const mailingContext = payload.mailing
    if (!mailingContext) {
      throw new Error('Mailing plugin not properly initialized')
    }
    // Use the task handler
    await processEmailsTaskHandler(
      job as { data: ProcessEmailsTaskData },
      { req }
    )
    return {
      output: {
        success: true,
        message: 'Email queue processing completed successfully'
      }
    }
  },
  interfaceName: 'ProcessEmailsTask',
 }
 // For backward compatibility, export as processEmailsJob
 export const processEmailsJob = processEmailsTask
 /**
 * Helper function to schedule an email processing job
 * Used by the plugin during initialization and can be used by developers
 */
 export const scheduleEmailsJob = async (
  payload: Payload,
  queueName: string,
  delay?: number
 ) => {
  if (!payload.jobs) {
    console.warn('PayloadCMS jobs not configured - emails will not be processed automatically')
    return
  }
  try {
    await payload.jobs.queue({
      queue: queueName,
      task: 'process-emails',
      input: {},
      waitUntil: delay ? new Date(Date.now() + delay) : undefined,
    } as any)
  } catch (error) {
    console.error('Failed to schedule email processing job:', error)
  }
 }
--- a/src/jobs/sendEmailTask.ts
+++ b/src/jobs/sendEmailTask.ts
@@ -1,5 +1,6 @@
 import { sendEmail } from '../sendEmail.js'
-import { Email } from '../payload-types.js'
+import { BaseEmailDocument } from '../types/index.js'
 import { processEmailById } from '../utils/emailProcessor.js'
 export interface SendEmailTaskInput {
  // Template mode fields
@@ -15,17 +16,73 @@ export interface SendEmailTaskInput {
  to: string | string[]
  cc?: string | string[]
  bcc?: string | string[]
-  scheduledAt?: string // ISO date string
+  from?: string
  fromName?: string
  replyTo?: string
  scheduledAt?: string | Date // ISO date string or Date object
  priority?: number
  processImmediately?: boolean // If true, process the email immediately instead of waiting for the queue
  // Allow any additional fields that users might have in their email collection
  [key: string]: any
 }
 /**
 * Transforms task input into sendEmail options by separating template and data fields
 */
 function transformTaskInputToSendEmailOptions(taskInput: SendEmailTaskInput) {
  const sendEmailOptions: any = {
    data: {}
  }
  // If using template mode, set template options
  if (taskInput.templateSlug) {
    sendEmailOptions.template = {
      slug: taskInput.templateSlug,
      variables: taskInput.variables || {}
    }
  }
  // Standard email fields that should be copied to data
  const standardFields = ['to', 'cc', 'bcc', 'from', 'fromName', 'replyTo', 'subject', 'html', 'text', 'scheduledAt', 'priority']
  // Fields that should not be copied to data
  const excludedFields = ['templateSlug', 'variables', 'processImmediately']
  // Copy standard fields to data
  standardFields.forEach(field => {
    if (taskInput[field] !== undefined) {
      sendEmailOptions.data[field] = taskInput[field]
    }
  })
  // Copy any additional custom fields that aren't excluded or standard fields
  Object.keys(taskInput).forEach(key => {
    if (!excludedFields.includes(key) && !standardFields.includes(key)) {
      sendEmailOptions.data[key] = taskInput[key]
    }
  })
  return sendEmailOptions
 }
 /**
 * Job definition for sending emails
 * Can be used through Payload's job queue system to send emails programmatically
 */
 export const sendEmailJob = {
  slug: 'send-email',
  label: 'Send Email',
  inputSchema: [
    {
      name: 'processImmediately',
      type: 'checkbox' as const,
      label: 'Process Immediately',
      defaultValue: false,
      admin: {
        description: 'Process and send the email immediately instead of waiting for the queue processor'
      }
    },
    {
      name: 'templateSlug',
      type: 'text' as const,
@@ -96,12 +153,37 @@ export const sendEmailJob = {
        description: 'Optional comma-separated list of BCC email addresses'
      }
    },
    {
      name: 'from',
      type: 'text' as const,
      label: 'From Email',
      admin: {
        description: 'Optional sender email address (uses default if not provided)'
      }
    },
    {
      name: 'fromName',
      type: 'text' as const,
      label: 'From Name',
      admin: {
        description: 'Optional sender display name (e.g., "John Doe")'
      }
    },
    {
      name: 'replyTo',
      type: 'text' as const,
      label: 'Reply To',
      admin: {
        description: 'Optional reply-to email address'
      }
    },
    {
      name: 'scheduledAt',
      type: 'date' as const,
      label: 'Schedule For',
      admin: {
-        description: 'Optional date/time to schedule email for future delivery'
+        description: 'Optional date/time to schedule email for future delivery',
        condition: (data: any) => !data.processImmediately
      }
    },
    {
@@ -116,62 +198,57 @@ export const sendEmailJob = {
      }
    }
  ],
  outputSchema: [
    {
      name: 'id',
      type: 'text' as const
    }
  ],
  handler: async ({ input, payload }: any) => {
    // Cast input to our expected type
    const taskInput = input as SendEmailTaskInput
    const shouldProcessImmediately = taskInput.processImmediately || false
    try {
-      // Prepare options for sendEmail based on task input
+      // Transform task input into sendEmail options using helper function
-      const sendEmailOptions: any = {
+      const sendEmailOptions = transformTaskInputToSendEmailOptions(taskInput)
        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)
+      const email = await sendEmail<BaseEmailDocument>(payload, sendEmailOptions)
      // If processImmediately is true, process the email now
      if (shouldProcessImmediately) {
        console.log(`⚡ Processing email ${email.id} immediately...`)
        await processEmailById(payload, String(email.id))
        console.log(`✅ Email ${email.id} processed and sent immediately`)
        return {
          output: {
            success: true,
            id: email.id,
            status: 'sent',
            processedImmediately: true
          }
        }
      }
      return {
        output: {
          success: true,
-          emailId: email.id,
+          id: email.id,
-          message: `Email queued successfully with ID: ${email.id}`,
+          status: 'queued',
-          mode: taskInput.templateSlug ? 'template' : 'direct',
+          processedImmediately: false
          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'
+      // Re-throw Error instances to preserve stack trace and error context
-      throw new Error(`Failed to queue email: ${errorMessage}`)
+      if (error instanceof Error) {
        throw error
      } else {
        // Only wrap non-Error values
        throw new Error(`Failed to process email: ${String(error)}`)
      }
    }
  }
 }
--- a/src/payload-types.ts
+++ b/src/payload-types.ts
@@ -143,6 +143,10 @@ export interface Email {
   * Sender email address (optional, uses default if not provided)
   */
  from?: string | null;
  /**
   * Sender display name (optional, e.g., "John Doe" for "John Doe <john@example.com>")
   */
  fromName?: string | null;
  /**
   * Reply-to email address
   */
@@ -336,6 +340,7 @@ export interface EmailsSelect<T extends boolean = true> {
  cc?: T;
  bcc?: T;
  from?: T;
  fromName?: T;
  replyTo?: T;
  subject?: T;
  html?: T;
--- a/src/plugin.ts
+++ b/src/plugin.ts
@@ -9,12 +9,6 @@ import { mailingJobs, scheduleEmailsJob } from './jobs/index.js'
 export const mailingPlugin = (pluginConfig: MailingPluginConfig) => (config: Config): Config => {
  const queueName = pluginConfig.queue || 'default'
  // Validate queueName
  if (!queueName || typeof queueName !== 'string') {
    throw new Error('Invalid queue configuration: queue must be a non-empty string')
  }
  // Handle templates collection configuration
  const templatesConfig = pluginConfig.collections?.templates
  const templatesSlug = typeof templatesConfig === 'string' ? templatesConfig : 'email-templates'
@@ -74,10 +68,15 @@ export const mailingPlugin = (pluginConfig: MailingPluginConfig) => (config: Con
    }),
  } satisfies CollectionConfig
  // Filter out any existing collections with the same slugs to prevent duplicates
  const existingCollections = (config.collections || []).filter(
    (collection) => collection.slug !== templatesSlug && collection.slug !== emailsSlug
  )
  return {
    ...config,
    collections: [
-      ...(config.collections || []),
+      ...existingCollections,
      templatesCollection,
      emailsCollection,
    ],
@@ -107,12 +106,9 @@ export const mailingPlugin = (pluginConfig: MailingPluginConfig) => (config: Con
        },
      } as MailingContext
      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)
      }
--- a/src/sendEmail.ts
+++ b/src/sendEmail.ts
@@ -1,9 +1,9 @@
 import { Payload } from 'payload'
 import { getMailing, renderTemplate, parseAndValidateEmails } from './utils/helpers.js'
-import {Email} from "./payload-types.js"
+import { BaseEmailDocument } from './types/index.js'
 // Options for sending emails
-export interface SendEmailOptions<T extends Email = Email> {
+export interface SendEmailOptions<T extends BaseEmailDocument = BaseEmailDocument> {
  // Template-based email
  template?: {
    slug: string
@@ -35,14 +35,14 @@ export interface SendEmailOptions<T extends Email = Email> {
 * })
 * ```
 */
-export const sendEmail = async <T extends Email = Email>(
+export const sendEmail = async <TEmail extends BaseEmailDocument = BaseEmailDocument>(
  payload: Payload,
-  options: SendEmailOptions<T>
+  options: SendEmailOptions<TEmail>
-): Promise<T> => {
+): Promise<TEmail> => {
  const mailing = getMailing(payload)
  const collectionSlug = options.collectionSlug || mailing.collections.emails || 'emails'
-  let emailData: Partial<T> = { ...options.data } as Partial<T>
+  let emailData: Partial<TEmail> = { ...options.data } as Partial<TEmail>
  // If using a template, render it first
  if (options.template) {
@@ -58,7 +58,7 @@ export const sendEmail = async <T extends Email = Email>(
      subject,
      html,
      text,
-    } as Partial<T>
+    } as Partial<TEmail>
  }
  // Validate required fields
@@ -89,6 +89,44 @@ export const sendEmail = async <T extends Email = Email>(
  if (emailData.bcc) {
    emailData.bcc = parseAndValidateEmails(emailData.bcc as string | string[])
  }
  if (emailData.replyTo) {
    const validated = parseAndValidateEmails(emailData.replyTo as string | string[])
    // replyTo should be a single email, so take the first one if array
    emailData.replyTo = validated && validated.length > 0 ? validated[0] : undefined
  }
  if (emailData.from) {
    const validated = parseAndValidateEmails(emailData.from as string | string[])
    // from should be a single email, so take the first one if array
    emailData.from = validated && validated.length > 0 ? validated[0] : undefined
  }
  // Sanitize fromName to prevent header injection
  if (emailData.fromName) {
    emailData.fromName = emailData.fromName
      .trim()
      // Remove/replace newlines and carriage returns to prevent header injection
      .replace(/[\r\n]/g, ' ')
      // Remove control characters (except space and printable characters)
      .replace(/[\x00-\x1F\x7F-\x9F]/g, '')
      // Note: We don't escape quotes here as that's handled in MailingService
  }
  // Normalize Date objects to ISO strings for consistent database storage
  if (emailData.scheduledAt instanceof Date) {
    emailData.scheduledAt = emailData.scheduledAt.toISOString()
  }
  if (emailData.sentAt instanceof Date) {
    emailData.sentAt = emailData.sentAt.toISOString()
  }
  if (emailData.lastAttemptAt instanceof Date) {
    emailData.lastAttemptAt = emailData.lastAttemptAt.toISOString()
  }
  if (emailData.createdAt instanceof Date) {
    emailData.createdAt = emailData.createdAt.toISOString()
  }
  if (emailData.updatedAt instanceof Date) {
    emailData.updatedAt = emailData.updatedAt.toISOString()
  }
  // Create the email in the collection with proper typing
  const email = await payload.create({
@@ -96,7 +134,12 @@ export const sendEmail = async <T extends Email = Email>(
    data: emailData
  })
-  return email as T
+  // Validate that the created email has the expected structure
  if (!email || typeof email !== 'object' || !email.id) {
    throw new Error('Failed to create email: invalid response from database')
  }
  return email as TEmail
 }
 export default sendEmail
--- a/src/services/MailingService.ts
+++ b/src/services/MailingService.ts
@@ -1,25 +1,20 @@
 import { Payload } from 'payload'
 import { Liquid } from 'liquidjs'
 import nodemailer, { Transporter } from 'nodemailer'
 import {
  MailingPluginConfig,
  TemplateVariables,
  MailingService as IMailingService,
-  EmailTemplate,
+  BaseEmail, BaseEmailTemplate, BaseEmailDocument, BaseEmailTemplateDocument
  QueuedEmail,
  MailingTransportConfig,
  EmailObject
 } from '../types/index.js'
 import { serializeRichTextToHTML, serializeRichTextToText } from '../utils/richTextSerializer.js'
 export class MailingService implements IMailingService {
  public payload: Payload
  private config: MailingPluginConfig
-  private transporter!: Transporter | any
+  private emailAdapter: any
  private templatesCollection: string
  private emailsCollection: string
  private liquid: Liquid | null | false = null
  private transporterInitialized = false
  constructor(payload: Payload, config: MailingPluginConfig) {
    this.payload = payload
@@ -31,49 +26,55 @@ export class MailingService implements IMailingService {
    const emailsConfig = config.collections?.emails
    this.emailsCollection = typeof emailsConfig === 'string' ? emailsConfig : 'emails'
-    // Only initialize transporter if payload is properly set
+    // Use Payload's configured email adapter
-    if (payload && payload.db) {
+    if (!this.payload.email) {
-      this.initializeTransporter()
+      throw new Error('Payload email configuration is required. Please configure email in your Payload config.')
    }
-  }
+    this.emailAdapter = this.payload.email
  private initializeTransporter(): void {
    if (this.transporterInitialized) return
    if (this.config.transport) {
      if ('sendMail' in this.config.transport) {
        this.transporter = this.config.transport
      } else {
        this.transporter = nodemailer.createTransport(this.config.transport as MailingTransportConfig)
      }
    } else if (this.payload.email && 'sendMail' in this.payload.email) {
      // Use Payload's configured mailer (cast to any to handle different adapter types)
      this.transporter = this.payload.email as any
    } else {
      throw new Error('Email transport configuration is required either in plugin config or Payload config')
    }
    this.transporterInitialized = true
  }
  private ensureInitialized(): void {
    if (!this.payload || !this.payload.db) {
      throw new Error('MailingService payload not properly initialized')
    }
-    if (!this.transporterInitialized) {
+    if (!this.emailAdapter) {
-      this.initializeTransporter()
+      throw new Error('Email adapter not configured. Please ensure Payload has email configured.')
    }
  }
  /**
   * Sanitizes a display name for use in email headers to prevent header injection
   * and ensure proper formatting
   */
  private sanitizeDisplayName(name: string): string {
    return name
      .trim()
      // Remove/replace newlines and carriage returns to prevent header injection
      .replace(/[\r\n]/g, ' ')
      // Remove control characters (except space and printable characters)
      .replace(/[\x00-\x1F\x7F-\x9F]/g, '')
      // Escape quotes to prevent malformed headers
      .replace(/"/g, '\\"')
  }
  /**
   * Formats an email address with optional display name
   */
  private formatEmailAddress(email: string, displayName?: string | null): string {
    if (displayName && displayName.trim()) {
      const sanitizedName = this.sanitizeDisplayName(displayName)
      return `"${sanitizedName}" <${email}>`
    }
    return email
  }
  private getDefaultFrom(): string {
    const fromEmail = this.config.defaultFrom
    const fromName = this.config.defaultFromName
    // Check if fromName exists, is not empty after trimming, and fromEmail exists
    if (fromName && fromName.trim() && fromEmail) {
-      // Escape quotes in the display name to prevent malformed headers
+      return this.formatEmailAddress(fromEmail, fromName)
      const escapedName = fromName.replace(/"/g, '\\"')
      return `"${escapedName}" <${fromEmail}>`
    }
    return fromEmail || ''
@@ -133,7 +134,7 @@ export class MailingService implements IMailingService {
    }
    const emailContent = await this.renderEmailTemplate(template, variables)
-    const subject = await this.renderTemplateString(template.subject, variables)
+    const subject = await this.renderTemplateString(template.subject || '', variables)
    return {
      html: emailContent.html,
@@ -224,7 +225,7 @@ export class MailingService implements IMailingService {
    }
  }
-  private async processEmailItem(emailId: string): Promise<void> {
+  async processEmailItem(emailId: string): Promise<void> {
    try {
      await this.payload.update({
        collection: this.emailsCollection as any,
@@ -238,10 +239,18 @@ export class MailingService implements IMailingService {
      const email = await this.payload.findByID({
        collection: this.emailsCollection as any,
        id: emailId,
-      }) as QueuedEmail
+      }) as BaseEmailDocument
-      let emailObject: EmailObject = {
+      // Combine from and fromName for nodemailer using proper sanitization
-        from: email.from || this.getDefaultFrom(),
+      let fromField: string
      if (email.from) {
        fromField = this.formatEmailAddress(email.from, email.fromName)
      } else {
        fromField = this.getDefaultFrom()
      }
      let mailOptions: any = {
        from: fromField,
        to: email.to,
        cc: email.cc || undefined,
        bcc: email.bcc || undefined,
@@ -249,26 +258,34 @@ export class MailingService implements IMailingService {
        subject: email.subject,
        html: email.html,
        text: email.text || undefined,
        variables: email.variables,
      }
-      // Apply emailWrapper hook if configured
+      // Call beforeSend hook if configured
-      if (this.config.emailWrapper) {
+      if (this.config.beforeSend) {
-        emailObject = await this.config.emailWrapper(emailObject)
+        try {
          mailOptions = await this.config.beforeSend(mailOptions, email)
          // Validate required properties remain intact after hook execution
          if (!mailOptions.from) {
            throw new Error('beforeSend hook must not remove the "from" property')
          }
          if (!mailOptions.to || (Array.isArray(mailOptions.to) && mailOptions.to.length === 0)) {
            throw new Error('beforeSend hook must not remove or empty the "to" property')
          }
          if (!mailOptions.subject) {
            throw new Error('beforeSend hook must not remove the "subject" property')
          }
          if (!mailOptions.html && !mailOptions.text) {
            throw new Error('beforeSend hook must not remove both "html" and "text" properties')
          }
        } catch (error) {
          console.error('Error in beforeSend hook:', error)
          throw new Error(`beforeSend hook failed: ${error instanceof Error ? error.message : 'Unknown error'}`)
        }
      }
-      const mailOptions = {
+      // Send email using Payload's email adapter
-        from: emailObject.from,
+      await this.emailAdapter.sendEmail(mailOptions)
        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)
      await this.payload.update({
        collection: this.emailsCollection as any,
@@ -304,7 +321,7 @@ export class MailingService implements IMailingService {
    const email = await this.payload.findByID({
      collection: this.emailsCollection as any,
      id: emailId,
-    }) as QueuedEmail
+    }) as BaseEmail
    const newAttempts = (email.attempts || 0) + 1
@@ -319,7 +336,7 @@ export class MailingService implements IMailingService {
    return newAttempts
  }
-  private async getTemplateBySlug(templateSlug: string): Promise<EmailTemplate | null> {
+  private async getTemplateBySlug(templateSlug: string): Promise<BaseEmailTemplateDocument | null> {
    try {
      const { docs } = await this.payload.find({
        collection: this.templatesCollection as any,
@@ -331,7 +348,7 @@ export class MailingService implements IMailingService {
        limit: 1,
      })
-      return docs.length > 0 ? docs[0] as EmailTemplate : null
+      return docs.length > 0 ? docs[0] as BaseEmailTemplateDocument : null
    } catch (error) {
      console.error(`Template with slug '${templateSlug}' not found:`, error)
      return null
@@ -396,7 +413,7 @@ export class MailingService implements IMailingService {
    })
  }
-  private async renderEmailTemplate(template: EmailTemplate, variables: Record<string, any> = {}): Promise<{ html: string; text: string }> {
+  private async renderEmailTemplate(template: BaseEmailTemplateDocument, variables: Record<string, any> = {}): Promise<{ html: string; text: string }> {
    if (!template.content) {
      return { html: '', text: '' }
    }
--- a/src/types/index.ts
+++ b/src/types/index.ts
@@ -1,25 +1,67 @@
 import { Payload } from 'payload'
-import type { CollectionConfig, RichTextField, TypedCollection } from 'payload'
+import type { CollectionConfig, RichTextField } from 'payload'
 import { Transporter } from 'nodemailer'
-export interface EmailObject {
+// JSON value type that matches Payload's JSON field type
-  to: string | string[]
+export type JSONValue = string | number | boolean | { [k: string]: unknown } | unknown[] | null | undefined
-  cc?: string | string[]
+
-  bcc?: string | string[]
+// Generic base interfaces that work with any ID type and null values
-  from?: string
+export interface BaseEmailDocument {
-  replyTo?: string
+  id: string | number
  template?: any
  to: string[]
  cc?: string[] | null
  bcc?: string[] | null
  from?: string | null
  fromName?: string | null
  replyTo?: string | null
  subject: string
  html: string
-  text?: string
+  text?: string | null
-  variables?: Record<string, any>
+  variables?: JSONValue
  scheduledAt?: string | Date | null
  sentAt?: string | Date | null
  status?: 'pending' | 'processing' | 'sent' | 'failed' | null
  attempts?: number | null
  lastAttemptAt?: string | Date | null
  error?: string | null
  priority?: number | null
  createdAt?: string | Date | null
  updatedAt?: string | Date | null
 }
-export type EmailWrapperHook = (email: EmailObject) => EmailObject | Promise<EmailObject>
+export interface BaseEmailTemplateDocument {
  id: string | number
  name: string
  slug: string
  subject?: string | null
  content?: any
  createdAt?: string | Date | null
  updatedAt?: string | Date | null
 }
 export type BaseEmail<TEmail extends BaseEmailDocument = BaseEmailDocument, TEmailTemplate extends BaseEmailTemplateDocument = BaseEmailTemplateDocument> = Omit<TEmail, 'id' | 'template'> & {template: Omit<TEmailTemplate, 'id'> | TEmailTemplate['id'] | undefined | null}
 export type BaseEmailTemplate<TEmailTemplate extends BaseEmailTemplateDocument = BaseEmailTemplateDocument> = Omit<TEmailTemplate, 'id'>
 export type TemplateRendererHook = (template: string, variables: Record<string, any>) => string | Promise<string>
 export type TemplateEngine = 'liquidjs' | 'mustache' | 'simple'
 export interface BeforeSendMailOptions {
  from: string
  to: string[]
  cc?: string[]
  bcc?: string[]
  replyTo?: string
  subject: string
  html: string
  text?: string
  attachments?: any[]
  [key: string]: any
 }
 export type BeforeSendHook = (options: BeforeSendMailOptions, email: BaseEmailDocument) => BeforeSendMailOptions | Promise<BeforeSendMailOptions>
 export interface MailingPluginConfig {
  collections?: {
    templates?: string | Partial<CollectionConfig>
@@ -27,58 +69,37 @@ export interface MailingPluginConfig {
  }
  defaultFrom?: string
  defaultFromName?: string
  transport?: Transporter | MailingTransportConfig
  queue?: string
  retryAttempts?: number
  retryDelay?: number
  emailWrapper?: EmailWrapperHook
  templateRenderer?: TemplateRendererHook
  templateEngine?: TemplateEngine
  richTextEditor?: RichTextField['editor']
  beforeSend?: BeforeSendHook
  onReady?: (payload: any) => Promise<void>
  initOrder?: 'before' | 'after'
 }
 export interface MailingTransportConfig {
  host: string
  port: number
  secure?: boolean
  auth?: {
    user: string
    pass: string
  }
 }
 export interface EmailTemplate {
  id: string
  name: string
  slug: string
  subject: string
  content: any // Lexical editor state
  createdAt: string
  updatedAt: string
 }
 export interface QueuedEmail {
  id: string
-  template?: string
+  template?: string | null
  to: string[]
-  cc?: string[]
+  cc?: string[] | null
-  bcc?: string[]
+  bcc?: string[] | null
-  from?: string
+  from?: string | null
-  replyTo?: string
+  fromName?: string | null
  replyTo?: string | null
  subject: string
  html: string
-  text?: string
+  text?: string | null
-  variables?: Record<string, any>
+  variables?: JSONValue
-  scheduledAt?: string
+  scheduledAt?: string | Date | null
-  sentAt?: string
+  sentAt?: string | Date | null
  status: 'pending' | 'processing' | 'sent' | 'failed'
  attempts: number
-  lastAttemptAt?: string
+  lastAttemptAt?: string | Date | null
-  error?: string
+  error?: string | null
-  priority?: number
+  priority?: number | null
  createdAt: string
  updatedAt: string
 }
@@ -90,6 +111,7 @@ export interface TemplateVariables {
 export interface MailingService {
  processEmails(): Promise<void>
  processEmailItem(emailId: string): Promise<void>
  retryFailedEmails(): Promise<void>
  renderTemplate(templateSlug: string, variables: TemplateVariables): Promise<{ html: string; text: string; subject: string }>
 }
--- a/src/utils/emailProcessor.ts
+++ b/src/utils/emailProcessor.ts
@@ -0,0 +1,61 @@
 import type { Payload } from 'payload'
 /**
 * Processes a single email by ID using the mailing service
 * @param payload Payload instance
 * @param emailId The ID of the email to process
 * @returns Promise that resolves when email is processed
 */
 export async function processEmailById(payload: Payload, emailId: string): Promise<void> {
  // Get mailing context from payload
  const mailingContext = (payload as any).mailing
  if (!mailingContext) {
    throw new Error(
      'Mailing plugin not found on payload instance. ' +
      'Ensure the mailingPlugin is properly configured in your Payload config plugins array.'
    )
  }
  if (!mailingContext.service) {
    throw new Error(
      'Mailing service not available. ' +
      'The plugin may not have completed initialization. ' +
      'Check that email configuration is properly set up in your Payload config.'
    )
  }
  // Process the specific email
  await mailingContext.service.processEmailItem(emailId)
 }
 /**
 * Processes all pending and failed emails using the mailing service
 * @param payload Payload instance
 * @returns Promise that resolves when all emails are processed
 */
 export async function processAllEmails(payload: Payload): Promise<void> {
  // Get mailing context from payload
  const mailingContext = (payload as any).mailing
  if (!mailingContext) {
    throw new Error(
      'Mailing plugin not found on payload instance. ' +
      'Ensure the mailingPlugin is properly configured in your Payload config plugins array.'
    )
  }
  if (!mailingContext.service) {
    throw new Error(
      'Mailing service not available. ' +
      'The plugin may not have completed initialization. ' +
      'Check that email configuration is properly set up in your Payload config.'
    )
  }
  // Process pending emails first
  await mailingContext.service.processEmails()
  // Then retry failed emails
  await mailingContext.service.retryFailedEmails()
 }
Author	SHA1	Message	Date
Bas	bba223410d	Merge pull request #43 from xtr-dev/dev Remove verbose initialization logs	2025-09-14 18:36:19 +02:00
Bas van den Aakster	0d295603ef	Update development documentation for silent plugin initialization - Remove reference to removed 'PayloadCMS Mailing Plugin initialized successfully' log - Add note explaining that plugin initializes silently on success - Clarify that absence of errors indicates successful initialization - Keep documentation aligned with actual plugin behavior - Bump version to 0.4.3	2025-09-14 18:33:34 +02:00
Bas van den Aakster	bd1842d45c	Remove verbose initialization logs - Remove 'PayloadCMS Mailing Plugin initialized successfully' log - Remove 'Scheduled initial email processing job in queue' log - Keep error logging for failed job scheduling - Reduce console noise during plugin initialization - Bump version to 0.4.2	2025-09-14 18:18:20 +02:00
Bas	a40d87c63c	Merge pull request #42 from xtr-dev/dev BREAKING CHANGE: Remove sendEmailWorkflow, add immediate processing t…	2025-09-14 18:07:19 +02:00
Bas van den Aakster	ccd8ef35c3	Fix error handling and improve error messages - Fix inconsistent error handling in sendEmailTask by re-throwing original Error instances - Preserve stack traces and error context instead of creating new Error wrappers - Improve generic error messages in emailProcessor utilities with specific details - Add actionable guidance for common configuration issues - Help developers understand what went wrong and how to fix it - Bump version to 0.4.1	2025-09-14 18:00:23 +02:00
Bas van den Aakster	a12d4c1bee	BREAKING CHANGE: Remove sendEmailWorkflow, add immediate processing to sendEmailTask - Remove entire workflows directory and sendEmailWorkflow - Factor out email processing logic into reusable utilities (emailProcessor.ts) - Add processImmediately option to sendEmailTask input schema - Update sendEmailTask to process emails immediately when requested - Update processEmailsTask to use shared processing utilities - Remove workflow-related exports and plugin configuration - Simplify documentation to focus on unified task approach - Export new email processing utilities (processEmailById, processAllEmails) - Bump version to 0.4.0 (breaking change - workflows removed) Migration: Use sendEmailTask with processImmediately: true instead of sendEmailWorkflow	2025-09-14 17:53:29 +02:00
Bas	fde8eb538d	Merge pull request #41 from xtr-dev/dev Dev	2025-09-14 17:47:19 +02:00
Bas van den Aakster	845b379da3	Fix error handling and improve naming consistency - Use native error chaining in workflow (Error constructor with cause option) - Fix job scheduling to use 'task' instead of 'workflow' property - Rename processEmailsJob.ts to processEmailsTask.ts for consistency - Update all imports and references while maintaining backward compatibility - Add processEmailsTask export with processEmailsJob alias - Bump version to 0.3.1	2025-09-14 17:34:53 +02:00
Bas van den Aakster	dd205dba41	Make workflow documentation more concise - Simplified workflow section to focus on key advantage - Removed verbose comparison table and features list - Kept essential usage example with processImmediately option - More readable and focused on the main differentiator	2025-09-14 17:21:57 +02:00
Bas van den Aakster	a6564e2a29	Add sendEmail workflow with immediate processing option - Create sendEmailWorkflow as a Payload workflow alternative to task - Add processImmediately option (disabled by default) to send emails immediately - Expose processEmailItem method in MailingService for individual email processing - Add comprehensive input schema with conditional fields - Update plugin to register both tasks and workflows - Add detailed documentation comparing tasks vs workflows - Includes status tracking and error handling - Bump version to 0.3.0 (new feature)	2025-09-14 17:20:21 +02:00
Bas van den Aakster	8f200da449	Refactor and clean up job organization - Properly encapsulate processEmailsJob in its own file with handler and definition - Clean up index.ts to remove duplicate code and just export job definitions - Add comprehensive JSDoc comments for better documentation - Separate job handler logic from job definition for clarity - Fix job scheduling to use correct field names - Bump version to 0.2.1	2025-09-14 17:16:01 +02:00
Bas	ff94d72d49	Merge pull request #40 from xtr-dev/dev BREAKING CHANGE: Remove custom transport support, use Payload's email…	2025-09-14 17:02:50 +02:00
Bas van den Aakster	ddee7d5a76	BREAKING CHANGE: Remove custom transport support, use Payload's email config - Removed custom transport configuration from plugin - Plugin now requires Payload email to be configured - Simplified setup by relying on Payload's email adapter - Updated README with new configuration requirements - Bump version to 0.2.0 (breaking change) Users must now configure email in their Payload config using an email adapter like @payloadcms/email-nodemailer instead of configuring transport in the plugin.	2025-09-14 16:57:30 +02:00
Bas	0083e8e1fa	Merge pull request #39 from xtr-dev/dev Remove redundant queueName validation and debug log, bump version to …	2025-09-14 16:29:13 +02:00
Bas van den Aakster	63a7eef8d8	Remove redundant queueName validation and debug log, bump version to 0.1.24	2025-09-14 16:28:24 +02:00
Bas	6cf055178b	Merge pull request #38 from xtr-dev/dev Add debug log for email transporter configuration and bump version to…	2025-09-14 16:15:41 +02:00
Bas van den Aakster	aa978090fa	Add debug log for email transporter configuration and bump version to 0.1.23	2025-09-14 16:14:56 +02:00
Bas	556d910e30	Merge pull request #37 from xtr-dev/dev Remove conditional transporter initialization and bump version to 0.1.22	2025-09-14 13:53:32 +02:00
Bas van den Aakster	b4bad70634	Remove conditional transporter initialization and bump version to 0.1.22	2025-09-14 13:52:49 +02:00
Bas	efdfaf5889	Merge pull request #36 from xtr-dev/dev Add beforeSend hook for email customization	2025-09-14 12:37:38 +02:00
Bas van den Aakster	ea7d8dfdd5	Add validation for beforeSend hook to ensure required properties remain intact - Validate that 'from' field is not removed - Validate that 'to' field is not removed or emptied - Validate that 'subject' field is not removed - Validate that at least 'html' or 'text' content exists - Throw clear error messages if validation fails - Bump version to 0.1.21	2025-09-14 12:27:43 +02:00
Bas van den Aakster	0d6d07de85	Add beforeSend hook for email customization - Add BeforeSendHook type and BeforeSendMailOptions interface - Implement hook execution in MailingService before sending emails - Hook allows adding attachments, headers, and modifying email options - Add comprehensive documentation with examples - Bump version to 0.1.20	2025-09-14 12:19:52 +02:00
Bas	f12ac8172e	Merge pull request #35 from xtr-dev/dev Fix model overwrite error when plugin is initialized multiple times	2025-09-14 10:24:58 +02:00
Bas van den Aakster	347cd33e13	Fix model overwrite error when plugin is initialized multiple times - Filter out existing collections with same slugs before adding plugin collections - Prevents 'Cannot overwrite model once compiled' errors in Next.js apps - Fixes issue during hot reload and multiple getPayload() calls - Bump version to 0.1.19	2025-09-14 10:22:34 +02:00
Bas	672ab3236a	Merge pull request #34 from xtr-dev/dev Add fromName field support to emails collection	2025-09-14 00:10:22 +02:00
Bas van den Aakster	c7db65980a	Fix security vulnerabilities in fromName field handling - Add sanitizeDisplayName() method to prevent header injection attacks - Remove newlines, carriage returns, and control characters from display names - Fix quote escaping inconsistency between getDefaultFrom() and processEmailItem() - Create formatEmailAddress() helper method for consistent email formatting - Add fromName sanitization in sendEmail() function for input validation - Prevent malformed email headers and potential security issues Security improvements: - Header injection prevention (removes \r\n and control characters) - Consistent quote escaping across all display name usage - Proper sanitization at both input and output stages 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>	2025-09-14 00:07:53 +02:00
Bas van den Aakster	624dc12471	Bump package version to 0.1.18 in `package.json`.	2025-09-14 00:06:14 +02:00
Bas van den Aakster	e20ebe27bf	Add fromName field support to emails collection - Add fromName field to Emails collection schema for sender display name - Update BaseEmailDocument and QueuedEmail interfaces to include fromName - Add SendEmailTaskInput support for fromName field in job tasks - Update MailingService to combine fromName and from into proper "Name <email>" format - Add fromName, from, and replyTo fields to job input schema for admin UI - Update field copying logic to handle new sender-related fields Users can now specify a display name for emails (e.g., "John Doe <john@example.com>"). 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>	2025-09-14 00:03:04 +02:00
Bas	7f04275d39	Merge pull request #33 from xtr-dev/dev Dev	2025-09-13 23:53:56 +02:00
Bas van den Aakster	20afe30e88	Fix scheduledAt type in SendEmailTaskInput and add Date normalization - Update SendEmailTaskInput.scheduledAt to support string \| Date types - Add Date object normalization to ISO strings in sendEmail processing - Ensure consistent database storage format for all timestamp fields - Convert Date objects to ISO strings before database operations Resolves remaining "Type Date is not assignable to type string" error for scheduledAt field in job task input. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>	2025-09-13 23:53:25 +02:00
Bas van den Aakster	02b3fecadf	Bump package version to 0.1.17 in `package.json`.	2025-09-13 23:52:53 +02:00
Bas	ea87f14308	Merge pull request #32 from xtr-dev/dev Dev	2025-09-13 23:48:28 +02:00
Bas van den Aakster	6886027727	Bump package version to 0.1.16 in `package.json`.	2025-09-13 23:45:39 +02:00
Bas van den Aakster	965569be06	Add Date type support for timestamp fields - Update scheduledAt, sentAt, lastAttemptAt, createdAt, updatedAt fields to support Date \| string \| null - Support both Date objects and ISO string formats for all timestamp fields - Update BaseEmailDocument, BaseEmailTemplateDocument, and QueuedEmail interfaces consistently - Update documentation to reflect Date object compatibility Fixes type constraint error where customer timestamp fields use Date objects but plugin interfaces only supported string formats. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>	2025-09-13 23:44:57 +02:00
Bas	ff788c1ecf	Merge pull request #31 from xtr-dev/dev Fix variables field type to support all JSON-compatible values	2025-09-13 23:41:43 +02:00
Bas van den Aakster	c12438aaa2	Bump package version to 0.1.15 in `package.json`.	2025-09-13 23:40:31 +02:00
Bas van den Aakster	4dcbc1446a	Fix variables field type to support all JSON-compatible values - Replace restrictive Record<string, any> with flexible JSONValue type for variables field - Add JSONValue type alias that matches Payload's JSON field type specification - Support string, number, boolean, objects, arrays, null, and undefined for variables - Update both BaseEmailDocument and QueuedEmail interfaces consistently - Update documentation to reflect JSONValue support Fixes type constraint error where customer Email.variables field type (string \| number \| boolean \| {...} \| unknown[] \| null \| undefined) was not assignable to Record<string, any>. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>	2025-09-13 23:38:46 +02:00
Bas	72f3d7f66d	Merge pull request #30 from xtr-dev/dev Add null value support to BaseEmailDocument interface	2025-09-13 23:35:25 +02:00
Bas van den Aakster	ecc0b0a73e	Fix type inconsistencies and missing null checks - Update QueuedEmail interface to include `\| null` for optional fields to match BaseEmailDocument - Add missing null checks for replyTo and from fields in sendEmail processing - Add proper email validation for replyTo and from fields (single email addresses) - Ensure type consistency across all email-related interfaces Fixes potential type conflicts between QueuedEmail and BaseEmailDocument, and ensures all nullable email fields are properly validated. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>	2025-09-13 23:32:44 +02:00
Bas van den Aakster	a959673fc1	Bump package version to 0.1.14 in `package.json`.	2025-09-13 23:31:23 +02:00
Bas van den Aakster	8809db6aff	Add null value support to BaseEmailDocument interface - Update BaseEmailDocument to support `\| null` for optional fields (cc, bcc, from, replyTo, text, etc.) - Update BaseEmailTemplateDocument to support `\| null` for optional fields - Add explicit null checks in sendEmail processing to handle null values properly - Update CUSTOM-TYPES.md documentation to reflect null value compatibility Fixes type constraint error where customer Email types had `cc?: string[] \| null` but BaseEmailDocument only supported `cc?: string[]`. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>	2025-09-13 23:27:53 +02:00
Bas	5905f732de	Merge pull request #29 from xtr-dev/dev Support custom ID types (string/number) for improved compatibility	2025-09-13 23:24:55 +02:00
Bas van den Aakster	4c495a72b0	Remove duplicate BaseEmailDocument definition - Remove duplicate BaseEmailDocument interface from sendEmail.ts - Import BaseEmailDocument from types/index.ts instead - Update sendEmailTask.ts to import from types/index.ts - Maintain single source of truth for BaseEmailDocument type definition 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>	2025-09-13 23:22:23 +02:00
Bas van den Aakster	8518c716e8	Bump package version to 0.1.13 in `package.json`.	2025-09-13 23:21:33 +02:00
Bas van den Aakster	570190be01	Support custom ID types (string/number) for improved compatibility - Replace hardcoded payload-types imports with generic BaseEmailDocument interface - Update sendEmail and sendEmailTask to work with both string and number IDs - Refactor MailingService to use generic document types instead of specific ones - Add BaseEmailDocument and BaseEmailTemplateDocument interfaces supporting id: string \| number - Export BaseEmailDocument for users to extend with their custom fields - Fix TypeScript compilation error in template subject handling - Add CUSTOM-TYPES.md documentation for users with different ID types Fixes compatibility issue where plugin required number IDs but user projects used string IDs. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>	2025-09-13 23:18:37 +02:00
Bas	685875d1b9	Merge pull request #28 from xtr-dev/dev Dev	2025-09-13 23:11:16 +02:00
Bas van den Aakster	79044b7bc3	Remove unused BaseEmail imports - Remove BaseEmail import from sendEmail.ts (no longer used after type refactoring) - Remove BaseEmail import from sendEmailTask.ts (no longer used after type refactoring) - BaseEmail types are still used in MailingService.ts for proper type casting 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>	2025-09-13 23:10:20 +02:00
Bas van den Aakster	e7304fe1a2	Improve type safety, error handling, and code maintainability - Simplify sendEmail generic constraints for better type safety - Add validation before type assertions in sendEmail - Preserve error stack traces in sendEmailTask error handling - Extract field copying logic into reusable helper function - Improve code documentation and separation of concerns 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>	2025-09-13 23:06:02 +02:00
Bas van den Aakster	790eedfee7	Bump package version to 0.1.12 in `package.json`.	2025-09-13 23:01:06 +02:00
Bas van den Aakster	9520ec5ed1	Refactor email types for enhanced consistency and type safety - Replace `EmailTemplate` with `BaseEmailTemplate` for stricter type validation. - Update `sendEmail` and `sendEmailTask` to utilize refined `BaseEmail` structure. - Simplify type definitions in `MailingService` and related modules.	2025-09-13 23:00:41 +02:00
Bas	768b70a003	Merge pull request #27 from xtr-dev/dev Align `sendEmail` and `sendEmailTask` with updated `BaseEmail` typing	2025-09-13 22:49:05 +02:00
Bas van den Aakster	e91ab7e54e	Bump package version to 0.1.11 in `package.json`.	2025-09-13 22:48:55 +02:00
Bas van den Aakster	06f9c2cb5b	Align `sendEmail` and `sendEmailTask` with updated `BaseEmail` typing - Refactor `sendEmail` to return extended type with `id` for better type inference. - Update `sendEmailTask` to use `BaseEmail` instead of `Email`. - Add `outputSchema` in `sendEmailTask` for consistent output structure.	2025-09-13 22:46:30 +02:00
Bas	21b22a033a	Merge pull request #26 from xtr-dev/dev Refactor `sendEmail` to improve type safety and align with `BaseEmail…	2025-09-13 22:41:28 +02:00
Bas van den Aakster	6ad90874cf	Refactor `sendEmail` to improve type safety and align with `BaseEmail` interface - Replace `Email` with `BaseEmail` for stricter type validation. - Update `SendEmailOptions` and `sendEmail` typing for improved extensibility.	2025-09-13 22:39:28 +02:00
Bas	03f1f62fbf	Merge pull request #25 from xtr-dev/dev Remove `emailWrapper` hook and all associated references.	2025-09-13 22:34:48 +02:00
Bas van den Aakster	e55e4197d3	Bump package version to 0.1.9 in `package.json`.	2025-09-13 22:32:19 +02:00
Bas van den Aakster	2e6feccf54	Remove `emailWrapper` hook and all associated references. - Simplified email sending logic by dropping custom layout wrapping. - Updated service, config, types, and readme to remove `emailWrapper` usage. - Retained focus on core email functionality while ensuring consistent formatting.	2025-09-13 22:31:05 +02:00