edgeport - v1.0.3
    Preparing search index...

    Interface SmtpConnectOptions

    Options for opening an SMTP submission session.

    1.0.0

    interface SmtpConnectOptions {
        auth?: {
            mechanism?: "PLAIN" | "LOGIN";
            password: string;
            username: string;
        };
        hostname: string;
        port?: number;
        timeoutMs?: number;
        tls?: "off"
        | "starttls"
        | "implicit";
    }

    Hierarchy (View Summary)

    Index
    auth? hostname port? timeoutMs? tls?
    auth?: { mechanism?: "PLAIN" | "LOGIN"; password: string; username: string }

    Credentials; when omitted, no AUTH is attempted.

    Type Declaration

    • Optionalmechanism?: "PLAIN" | "LOGIN"

      Mechanism to use; defaults to 'PLAIN'.

    • password: string

      Login password or app token.

    • username: string

      Login user (often the full email address).

    hostname: string

    Mail server hostname (also used for TLS certificate validation).

    port?: number

    TCP port; defaults to 587 for starttls and 465 for implicit.

    timeoutMs?: number

    Per-step read deadline in milliseconds.

    tls?: "off" | "starttls" | "implicit"

    Transport security:

    • 'starttls' (default): connect in plaintext, upgrade via STARTTLS.
    • 'implicit': TLS from the first byte (SMTPS, port 465).
    • 'off': plaintext with no upgrade (for trusted internal relays / dev servers).

    Settings
    Member Visibility

    On This Page
    Properties