@mxraven/mail - v0.2.0
    Preparing search index...

    Interface ClientOptions

    Options for a Client.

    interface ClientOptions {
        connectTimeout?: number;
        host: string;
        localName?: string;
        poolSize?: number;
        port?: number;
        readTimeout?: number;
        secret: string;
        tls?: ConnectionOptions;
        username: string;
        writeTimeout?: number;
    }
    Index
    connectTimeout? host localName? poolSize? port? readTimeout? secret tls? username writeTimeout?
    connectTimeout?: number

    The TCP connect deadline in milliseconds. Defaults to 30000.

    host: string

    The submission server host. A port must not be included.

    localName?: string

    The name sent in EHLO. Defaults to localhost.

    poolSize?: number

    The maximum number of pooled connections. Defaults to 5.

    port?: number

    The submission server port. Defaults to defaultAddressPort.

    readTimeout?: number

    The per-read deadline in milliseconds. Defaults to 300000.

    secret: string

    The submission API key secret.

    tls?: ConnectionOptions

    STARTTLS options, for example a custom CA or servername.

    username: string

    The submission API key username, for example mxr_tx_ab12cd34ef56.

    writeTimeout?: number

    The per-write deadline in milliseconds. Defaults to 300000.

    Settings
    Member Visibility

    On This Page
    Properties