Beignet API reference
    Preparing search index...

    Interface CreateSmtpMailProviderOptions

    Options for the SMTP mail provider factory.

    interface CreateSmtpMailProviderOptions {
        from?: string;
        host?: string;
        pass?: string;
        port?: number;
        requireTls?: boolean;
        user?: string;
    }
    Index
    from? host? pass? port? requireTls? user?
    from?: string

    Default sender address. Overrides MAIL_FROM.

    host?: string

    SMTP server hostname. Overrides MAIL_HOST.

    pass?: string

    SMTP password. Overrides MAIL_PASS.

    port?: number

    SMTP server port. Port 465 uses SSL. Overrides MAIL_PORT.

    requireTls?: boolean

    Require encrypted SMTP transport. Non-465 ports must negotiate STARTTLS; port 465 always uses implicit TLS. Overrides MAIL_REQUIRE_TLS.

    Disable this only for a trusted local SMTP capture service.

    true
    user?: string

    SMTP username. Overrides MAIL_USER.

    Settings
    Member Visibility

    On This Page
    Properties