Merge pull request #14 from xtr-dev/dev

Add defaultFromName config option and bump to v0.0.7

package.json

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

src/services/MailingService.ts

@@ -15,7 +15,7 @@ import { serializeRichTextToHTML, serializeRichTextToText } from '../utils/richT
 export class MailingService implements IMailingService {
   private payload: Payload
   private config: MailingPluginConfig
-  private transporter!: Transporter
+  private transporter!: Transporter | any
   private templatesCollection: string
   private emailsCollection: string
 
@@ -40,11 +40,28 @@ export class MailingService implements IMailingService {
       } 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')
+      throw new Error('Email transport configuration is required either in plugin config or Payload config')
     }
   }
 
+  private getDefaultFrom(): string {
+    const fromEmail = this.config.defaultFrom
+    const fromName = this.config.defaultFromName
+
+    // Check if fromName exists, is not empty after trimming, and fromEmail exists
+    if (fromName && fromName.trim() && fromEmail) {
+      // Escape quotes in the display name to prevent malformed headers
+      const escapedName = fromName.replace(/"/g, '\\"')
+      return `"${escapedName}" <${fromEmail}>`
+    }
+
+    return fromEmail || ''
+  }
+
   private registerHandlebarsHelpers(): void {
     Handlebars.registerHelper('formatDate', (date: Date, format?: string) => {
       if (!date) return ''
@@ -125,7 +142,7 @@ export class MailingService implements IMailingService {
       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.config.defaultFrom,
+      from: options.from || this.getDefaultFrom(),
       replyTo: options.replyTo,
       subject: subject || options.subject,
       html,
@@ -242,7 +259,7 @@ export class MailingService implements IMailingService {
       }) as QueuedEmail
 
       let emailObject: EmailObject = {
-        from: email.from || this.config.defaultFrom,
+        from: email.from || this.getDefaultFrom(),
         to: email.to,
         cc: email.cc || undefined,
         bcc: email.bcc || undefined,
@@ -259,7 +276,7 @@ export class MailingService implements IMailingService {
       }
 
       const mailOptions = {
-        from: emailObject.from || this.config.defaultFrom,
+        from: emailObject.from,
         to: emailObject.to,
         cc: emailObject.cc || undefined,
         bcc: emailObject.bcc || undefined,

src/types/index.ts

@@ -22,6 +22,7 @@ export interface MailingPluginConfig {
     emails?: string | Partial<CollectionConfig>
   }
   defaultFrom?: string
+  defaultFromName?: string
   transport?: Transporter | MailingTransportConfig
   queue?: string
   retryAttempts?: number