SmtpConfigRead

Fields

SMTP server configuration returned to the client (no password).

7 fields

enabled · required

boolean

from_address · required

string

host · required

string

implicit_tls · required

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_set · required

boolean

port · required

integer

user · required

string or null

Raw schema (JSON)

{
  "description": "SMTP server configuration returned to the client (no password).",
  "properties": {
    "enabled": {
      "title": "Enabled",
      "type": "boolean"
    },
    "from_address": {
      "title": "From Address",
      "type": "string"
    },
    "host": {
      "title": "Host",
      "type": "string"
    },
    "implicit_tls": {
      "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_set": {
      "title": "Password Set",
      "type": "boolean"
    },
    "port": {
      "title": "Port",
      "type": "integer"
    },
    "user": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "User"
    }
  },
  "required": [
    "enabled",
    "host",
    "port",
    "user",
    "from_address",
    "implicit_tls",
    "password_set"
  ],
  "title": "SmtpConfigRead",
  "type": "object"
}

Used by endpoints

2 endpoints send or return this schema, on its own or inside another schema.

• GET /api/v1/settings/smtp — Get Smtp Config
• PUT /api/v1/settings/smtp — Update Smtp Config

Used by schemas

No other schema contains this one.

More details

• Specification: OpenAPI JSON