function MailPlugin
Since 0.1.0
MailPlugin(options?: MailPluginOptions): IPlugin

Creates the MailPlugin.

Registers an IMailer under CAPABILITIES.MAIL. The default provider is 'log' (zero dependency, every runtime).

Examples

Example 1

import { MailPlugin } from '@setu-ts/mail-plugin';

app.register(MailPlugin({
  provider: 'sendgrid',
  options: { apiKey: config.get('SENDGRID_API_KEY') },
  defaults: { from: 'noreply@myapp.com' },
}));

Parameters

optional
options: MailPluginOptions

Plugin configuration

Return Type

IPlugin

The plugin instance

Usage

import { MailPlugin } from "mail-plugin/src/index.ts";