SmtpConfigUpdate

Fields

Payload for updating SMTP server configuration.

7 fields

enabled: boolean
from_address: string
host: string
implicit_tls: boolean
When True, implicit TLS (SSL/TLS on connect, typically port 465) is used. When False, STARTTLS (upgrade after connect, typically port 587) is used. Plain (unencrypted) SMTP is not supported.
password: string or null
port: integer
user: string or null

Raw schema (JSON)

{
  "description": "Payload for updating SMTP server configuration.",
  "properties": {
    "enabled": {
      "default": false,
      "title": "Enabled",
      "type": "boolean"
    },
    "from_address": {
      "default": "noreply@testlookup.io",
      "maxLength": 255,
      "title": "From Address",
      "type": "string"
    },
    "host": {
      "default": "localhost",
      "maxLength": 255,
      "title": "Host",
      "type": "string"
    },
    "implicit_tls": {
      "default": true,
      "description": "When True, implicit TLS (SSL/TLS on connect, typically port 465) is used. When False, STARTTLS (upgrade after connect, typically port 587) is used. Plain (unencrypted) SMTP is not supported.",
      "title": "Implicit Tls",
      "type": "boolean"
    },
    "password": {
      "anyOf": [
        {
          "maxLength": 1000,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Password"
    },
    "port": {
      "default": 587,
      "maximum": 65535,
      "minimum": 1,
      "title": "Port",
      "type": "integer"
    },
    "user": {
      "anyOf": [
        {
          "maxLength": 255,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "User"
    }
  },
  "title": "SmtpConfigUpdate",
  "type": "object"
}

Used by endpoints

One endpoint sends or returns this schema, on its own or inside another schema.

PUT /api/v1/settings/smtp — Update Smtp Config

Used by schemas

No other schema contains this one.

More details

Specification: OpenAPI JSON