Deprecated: Test SMTP Provider

POST 
/smtp/_test

deprecated

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

Deprecated: please move to the new endpoint TestEmailProviderSMTP.

Request

application/json

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

application/grpc

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

application/grpc-web+proto

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

200

A successful response.

application/json

Schema

Schema

object

Example (from schema)

{}

application/grpc

Schema

Schema

object

Example (from schema)

{}

application/grpc-web+proto

Schema

Schema

object

Example (from schema)

{}

403

Returned when the user does not have permission to access the resource.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

404

Returned when the resource does not exist.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

default

An unexpected error response.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...