Skip to main content

Type Alias: EmailBuilder()

type EmailBuilder: (ctx) => MailMessage | null | Promise<MailMessage | null>;

Builder used to assemble a message on-demand. Return null to skip sending when conditions are not met (e.g. suppressing internal traffic alerts). Registered via EmailsOptions.triggers; builders execute sequentially.

Parameters​

ParameterType
ctxEmailContext

Returns​

MailMessage | null | Promise<MailMessage | null>

Examples​

ctx => ({ to: ctx.user.email!, subject: 'Welcome', html: '<p>Hi</p>' })
ctx => ctx.session?.ip?.startsWith('192.168.') ? null : adminAlert(ctx)