Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
/rest/{version}/systemsettings/email
Descriptor | Value |
|---|---|
HTTP Method | PUT |
Description | Sets values for the Email configuration fields. |
Required Permission | Manage System Settings |
| Version Introduced | 2.5.0.7 |
Request Header Parameters
Parameter | Value | Required | Description |
|---|---|---|---|
Accept | String | Yes | A value of ‘application/json’ must be provided. |
Request POST Data Parameters
Values must be passed in as a JSON Object
Parameter | Value | Required | Description |
|---|---|---|---|
host | String | Yes | Email server hostname. |
port | Integer | Yes | Port for email server. |
sender | String | Yes | Email address ThreadFix emails will be sent from. |
| user | String | Yes | User account to validate email server authorization. |
| password | String | Yes | Password for user account. |
| tls | Boolean | Yes | Set to 'True' to enable TLS. |
| smtpAuthorization | Boolean | Yes | Set to 'True' to use SMTP Authorization. |
| filter | String | No* | Comma separated email filters, supports * wildcard. Non matching email addresses will be rejected at sending time for security reasons. * Although not required for purposes of configuring the email settings, filters are needed to define the allowed email addresses; without any filters, no emails will be sent. |
Sample Call:
| Code Block | ||
|---|---|---|
| ||
curl --insecure -X PUT -H "Content-Type: application/json" -H "Authorization: APIKEY {apiKey}"
-d '{"host": "server.company.com", "port": "587", "sender": "sender@email.com", "user": "emailaccount", "password": "password", "tls": false, "smtpAuthorization": false, "filter": "*@email.com"}'
http://localhost:8080/threadfix/rest/latest/systemsettings/email |
Sample Output:
| Code Block | ||
|---|---|---|
| ||
{
"message": "",
"success": true,
"responseCode": -1,
"object": {
"filter": "*@email.com",
"password": null,
"smtpAuthorization": false,
"port": "587",
"sender": "sender@email.com",
"host": "server.company.com",
"tls": false,
"user": "emailaccount"
}
} |
| Page Tree | ||
|---|---|---|
|