@xtr-dev/payload-mailing
Version:
Template-based email system with scheduling and job processing for PayloadCMS
51 lines • 1.33 kB
TypeScript
import type { PayloadRequest, Payload } from 'payload';
/**
* Data passed to the process emails task
*/
export interface ProcessEmailsTaskData {
}
/**
* Handler function for processing emails
* Used internally by the task definition
*/
export declare const processEmailsTaskHandler: (job: {
data: ProcessEmailsTaskData;
}, context: {
req: PayloadRequest;
}) => Promise<void>;
/**
* Task definition for processing emails
* This is what gets registered with Payload's job system
*/
export declare const processEmailsTask: {
slug: string;
handler: ({ job, req }: {
job: any;
req: any;
}) => Promise<{
output: {
success: boolean;
message: string;
};
}>;
interfaceName: string;
};
export declare const processEmailsJob: {
slug: string;
handler: ({ job, req }: {
job: any;
req: any;
}) => Promise<{
output: {
success: boolean;
message: string;
};
}>;
interfaceName: string;
};
/**
* Helper function to schedule an email processing job
* Used by the plugin during initialization and can be used by developers
*/
export declare const scheduleEmailsJob: (payload: Payload, queueName: string, delay?: number) => Promise<void>;
//# sourceMappingURL=processEmailsTask.d.ts.map