Setu-TS
    Preparing search index...

    Interface MailProviderOptions

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

    0.1.0

    interface MailProviderOptions {
        accessKeyId?: string;
        apiKey?: string;
        auth?: { pass: string; user: string };
        client?: ISesClient;
        endpoint?: string;
        host?: string;
        http?: IMailHttp;
        port?: number;
        region?: string;
        secretAccessKey?: string;
        secure?: boolean;
        sink?: (message: OutgoingMail) => void;
        transport?: ISmtpTransport;
    }
    Index
    accessKeyId? apiKey? auth? client? endpoint? host? http? port? region? secretAccessKey? secure? sink? transport?
    accessKeyId?: string

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

    apiKey?: string

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

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

    (smtp) SMTP auth credentials.

    client?: ISesClient

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

    endpoint?: string

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

    host?: string

    (smtp) SMTP server host.

    http?: IMailHttp

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

    port?: number

    (smtp) SMTP server port. Default 587.

    region?: string

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

    secretAccessKey?: string

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

    secure?: boolean

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

    sink?: (message: OutgoingMail) => void

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

    transport?: ISmtpTransport

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

    Settings
    Member Visibility

    On This Page
    Properties