Set SMTP email client config
Setup SMTP email client config that will be used to send logs on email.
There are email sending limits of various email service providers (500, 1000 per/day, etc.). In some cases you may need to enable untrusted applications in common online mail services.
- application/json
Request Body required
- enabled boolean
Determines whether the feature is enabled
client object
This model describes email client settings required for sending logs to mail
username emailEmail login
name stringUser name
password stringEmail password
recipient object
This model describes recipient email settings required for sending logs to mail
username emailUser login
subject stringEmail subject
server object
This model describes email server settings required for sending logs to mail
host hostnameSMTP server address
security stringPossible values: [
tls
,ssl
,none
]Security type
port integerPort
- 200
- 400
- 401
OK
- Bad client username
- Bad receiver username
- Bad host address
- Bad security type. Available types: [tls, ssl, none]
- Missed json body or wrong param. Response sample:
"error": "Wrong JSON body"
- Required field is not provided. Response sample:
"error": "Wrong JSON body: no value for `param`"
where param
- is a required field that was not provided
- Field was of the wrong type. Response sample:
"error": "Wrong JSON body: value `param` was of the wrong type"
where param
- is a field of the wrong type
- application/json
- Schema
- Example (from schema)
- Bad client username
- Bad receiver username
- Bad host address
- Bad security type
- Base
- No value
- Wrong param type
Schema
- error string
Error message
{
"error": true
}
{
"error": "Bad client username"
}
{
"error": "Bad receiver username"
}
{
"error": "Bad host address"
}
{
"error": "Bad security type. Available types: [tls, ssl, none]"
}
{
"error": "Wrong JSON body"
}
{
"error": "Wrong JSON body: no value for `param`"
}
{
"error": "Wrong JSON body: value `param` was of the wrong type"
}
Unauthorized request. Log In
- application/json
- Schema
- Example (from schema)
- Log In
Schema
- error string
Error message
{
"error": "Log In"
}
{
"error": "Log In"
}