Get SMTP email client config

Returns 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.

Responses

application/json

Schema
Example (from schema)
Example

Schema

enabled boolean
Determines whether the feature is enabled
client object
This model describes email client settings required for sending logs to mail
username object
Email login
anyOf
MOD1
MOD2
string email
name string
User name
password string
Email password
recipient object
This model describes recipient email settings required for sending logs to mail
username object
User login
anyOf
MOD1
MOD2
string email
subject string
Email subject
server object
This model describes email server settings required for sending logs to mail
host object
SMTP server address
anyOf
MOD1
MOD2
string hostname
security string
Possible values: [tls, ssl, none]
Security type
port integer
Port

{
  "enabled": false,
  "client": {
    "username": "[email protected]",
    "name": "John Doe",
    "password": "[email protected]"
  },
  "recipient": {
    "username": "[email protected]",
    "subject": "AA-12FB event logs"
  },
  "server": {
    "host": "example.com",
    "security": "tls",
    "port": 587
  }
}

{
  "enabled": false,
  "client": {
    "username": "[email protected]",
    "name": "John Doe",
    "password": "string"
  },
  "recipient": {
    "username": "[email protected]",
    "subject": "AA-12FB event logs"
  },
  "server": {
    "host": "smtp.gmail.com",
    "security": "tls",
    "port": 587
  }
}

Unauthorized request. Log In

application/json

Schema
Example (from schema)
Log In

Schema

error string
Error message

{
  "error": "Log In"
}

{
  "error": "Log In"
}

Get SMTP email client config​

Get SMTP email client config