interface MailProviderOptions
Since 0.1.0

Provider-specific options. Fields are consumed only by the matching provider; unrelated fields are ignored (mirrors SecretsProviderOptions).

Properties

optional
host: string

(smtp) SMTP server host.

optional
port: number

(smtp) SMTP server port. Default 587.

optional
secure: boolean

(smtp) Use an implicit TLS connection. Default false.

optional
auth: { user: string; pass: string; }

(smtp) SMTP auth credentials.

(smtp) Injected transport facade; bypasses the lazy nodemailer import.

optional
region: string

(ses) AWS region for the lazily-loaded client.

optional
accessKeyId: string

(ses) AWS access key id for the lazily-loaded client.

optional
secretAccessKey: string

(ses) AWS secret access key for the lazily-loaded client.

(ses) Injected client facade; bypasses the lazy SDK import.

optional
apiKey: string

(sendgrid) SendGrid API key sent as a Bearer token.

optional
endpoint: string

(sendgrid) API endpoint. Default https://api.sendgrid.com/v3/mail/send.

optional
http: IMailHttp

(sendgrid) Injected fetch-shaped function; defaults to global fetch.

optional
sink: (message: OutgoingMail) => void

(log) Called with each sent message — a read-back seam for tests/hooks.

Usage

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