Koha/api/v1/swagger/definitions/smtp_server.json
Tomas Cohen Arazi 95aa8fc64b Bug 22343: API routes for SMTP servers CRUD
This patch introduces API routes for handling SMTP servers.

Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com>
Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>

Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
2020-10-02 10:54:40 +02:00

57 lines
1.2 KiB
JSON

{
"type": "object",
"properties": {
"smtp_server_id": {
"type": "integer",
"description": "Internal SMTP server identifier",
"readOnly": true
},
"name": {
"type": "string",
"description": "Name of the SMTP server"
},
"host": {
"type": "string",
"description": "SMTP host name"
},
"port": {
"type": "integer",
"description": "TCP port number"
},
"timeout": {
"type": "integer",
"description": "Maximum time in seconds to wait for server"
},
"ssl_mode": {
"type": "string",
"enum": [
"disabled",
"ssl",
"starttls"
],
"description": "If SSL/TLS will be used"
},
"user_name": {
"type": [
"string",
"null"
],
"description": "The user name to use for authentication (optional)"
},
"password": {
"type": [
"string",
"null"
],
"description": "The password to use for authentication (optional)"
},
"debug": {
"type": "boolean",
"description": "If the SMTP connection is set to debug mode"
}
},
"additionalProperties": false,
"required": [
"name"
]
}