Resource: Mail Sender Settings ( /api/mailsender/default/settings )
Allows the retrieval of the mail sender (using SMTP) settings that Enterprise Tester will use when sending e-mail notifications.
Root Relation: DefaultMailsenderSettings
This resource supports the following methods: GET, PUT
Methods
GET
Retrieves default mail sender settings.
Required Permissions
- Administration/Organisation
Status Codes
These are the expected status codes returned by the service. In addition, some other status codes may be returned if either an internal error occurs or there is an authentication issue (such as an expired OAuth token).
| Status | Description |
|---|---|
| 200 - OK | Returned if the request was completed successfully. |
| 403 - Forbidden | Returned if the user does not have permission to retrieve the mail sender settings. |
Example of fetching current mail sender (SMTP) settings
Request Headers
| Key | Value | Description |
|---|---|---|
| Accept | application/json |
Response Headers
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json; charset=utf-8 |
Response Body
{
"Enabled": true,
"Type": "SMTP",
"FromAddress": "noreply@corp.com",
"EmailPrefix": "[ET]",
"HostName": "smtp.corp.com",
"Port": null,
"Timeout": 10000,
"SSL": true,
"UserName": "etmail",
"Password": "etpwd",
"Self": "http://localhost/apimailsender/default/settings"
}
Status Code
200 - OK
PUT
Updates default mail sender settings
Required Permissions
- Administration/Organisation
Status Codes
These are the expected status codes returned by the service. In addition, some other status codes may be returned if either an internal error occurs or there is an authentication issue (such as an expired OAuth token).
| Status | Description |
|---|---|
| 200 - OK | Returned if the request was completed successfully. |
| 403 - Forbidden | Returned if the user does not have permission to update the mail sender settings. |
Example of updating smtp settings for application.
Request Headers
| Key | Value | Description |
|---|---|---|
| Accept | application/json |
Request Body
{
"Enabled": true,
"Type": "SMTP",
"FromAddress": "noreply@corp.com",
"EmailPrefix": "[ET]",
"HostName": "smtp.corp.com",
"Port": null,
"Timeout": 10000,
"SSL": true,
"UserName": "etmail",
"Password": "etpwd"
}
Response Headers
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json; charset=utf-8 |
Response Body
{
"Enabled": true,
"Type": "SMTP",
"FromAddress": "noreply@corp.com",
"EmailPrefix": "[ET]",
"HostName": "smtp.corp.com",
"Port": null,
"Timeout": 10000,
"SSL": true,
"UserName": "etmail",
"Password": "etpwd",
"Self": "http://localhost/apimailsender/default/settings"
}
Status Code
200 - OK