AdminConfigSmtpTransportDto

Endpoints · All schemas

Field	Required	Description
host	Yes	SMTP server hostname
ignoreCert	Yes	Whether to ignore SSL certificate errors
password	Yes	SMTP password (write-only; empty preserves the existing password)
passwordConfigured	No	Read-only indicator that an SMTP password is stored. Set by the server; ignored on write.
port	Yes	SMTP server port
secure	Yes	Whether to use secure connection (TLS/SSL)
username	Yes	SMTP username

Complete definition

required lists fields that must be present. nullable allows a null value; it does not make the field optional. Response enums retain exact wire values for compatibility.

{
  "properties": {
    "host": {
      "description": "SMTP server hostname",
      "type": "string"
    },
    "ignoreCert": {
      "description": "Whether to ignore SSL certificate errors",
      "type": "boolean"
    },
    "password": {
      "description": "SMTP password (write-only; empty preserves the existing password)",
      "type": "string"
    },
    "passwordConfigured": {
      "description": "Read-only indicator that an SMTP password is stored. Set by the server; ignored on write.",
      "type": "boolean"
    },
    "port": {
      "description": "SMTP server port",
      "maximum": 65535,
      "minimum": 0,
      "type": "integer"
    },
    "secure": {
      "description": "Whether to use secure connection (TLS/SSL)",
      "type": "boolean"
    },
    "username": {
      "description": "SMTP username",
      "type": "string"
    }
  },
  "required": [
    "host",
    "ignoreCert",
    "password",
    "port",
    "secure",
    "username"
  ],
  "type": "object"
}