Get the SMTP settings
GET /api/2.0/settings/smtp
Request
Returns the current portal SMTP settings.
Authorization
An API key is a token that you provide when making API calls. Include the token in a header parameter called Authorization
.
Example: Authorization: 864FE52C-1C1C-469F-9308-51DAFEFE7436
.
Headers
- Accept
enum of string
Can be one of:
application/json
.
Examples
GET /api/2.0/settings/smtp HTTP/1.1
Accept: application/json
Host: example.com
curl --request GET \
--url https://example.com/api/2.0/settings/smtp \
--header 'Accept: application/json'
Responses
200
SMTP settings
- Host
string
- Port
array of integer
- SenderAddress
string
- SenderDisplayName
string
- CredentialsUserName
string
- CredentialsUserPassword
string
- EnableSSL
boolean
- EnableAuth
boolean
- UseNtlm
boolean
401
Unauthorized