Bug 27424: Add ability to specify an SMTP server in the database as the default server
[koha.git] / api / v1 / swagger / definitions / smtp_server.yaml
1 ---
2 type: object
3 properties:
4   smtp_server_id:
5     type: integer
6     description: Internal SMTP server identifier
7     readOnly: true
8   name:
9     type: string
10     description: Name of the SMTP server
11   host:
12     type: string
13     description: SMTP host name
14   port:
15     type: integer
16     description: TCP port number
17   timeout:
18     type: integer
19     description: Maximum time in seconds to wait for server
20   ssl_mode:
21     type: string
22     enum:
23       - disabled
24       - ssl
25       - starttls
26     description: If SSL/TLS will be used
27   user_name:
28     type:
29       - string
30       - "null"
31     description: The user name to use for authentication (optional)
32   password:
33     type:
34       - string
35       - "null"
36     description: The password to use for authentication (optional)
37   debug:
38     type: boolean
39     description: If the SMTP connection is set to debug mode
40   is_default:
41     type: boolean
42     description: Is this the default SMTP server
43 additionalProperties: false
44 required:
45   - name