Skip to main content

Test SMTP Email Provider

POST 
/email/smtp/_test

Test an SMTP Email provider. After testing the provider, the users will receive information about the test results.

Request​

Body

required

    senderAddress stringrequired

    Possible values: non-empty and <= 200 characters

    senderName stringrequired

    Possible values: non-empty and <= 200 characters

    tls boolean
    host stringrequired

    Possible values: non-empty and <= 500 characters

    Make sure to include the port.

    user string
    password string
    receiverAddress stringrequired

    Possible values: non-empty and <= 200 characters

    id string

    Zitadel SMTP provider id in case you are not sending the password and want to reuse the stored password

Responses​

A successful response.

Schema

    object

Loading...