Documentation
    Preparing search index...

    Interface MailpitEventsOptions

    Configuration options for a MailpitEvents instance.

    interface MailpitEventsOptions {
        auth?: MailpitAuthCredentials;
        reconnectOptions?: Omit<Options, "WebSocket">;
        wsOptions?: ClientOptions;
    }
    Index

    Properties

    Optional basic auth credentials.

    reconnectOptions?: Omit<Options, "WebSocket">

    Optional reconnection tuning for the underlying ReconnectingWebSocket. Controls retry behaviour, delays, backoff factor, and connection timeout. The WebSocket constructor field is managed internally and cannot be overridden here.

    wsOptions?: ClientOptions

    Node.js only Optional options passed to the underlying ws WebSocket constructor. Silently ignored in browsers (native WebSocket has no options object).