Updates current Mail Server configuration
Since Product Version: 3.2
Resource Information
Rate Limiting? |
Yes |
Sorting? |
No |
Paging? |
No |
Filtering? |
No |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Credential |
HTTP Methods |
PUT |
DevNet Discussions
Resource URL
/webacs/api/v3/op/settings/notification/mailServer UnmodifiedThis resource has not been modified since the previous API version.
Request Payload Parameters
Attribute | Description |
---|---|
applyToAlarms Boolean |
Indicates if this mail server settings should be applied to alarm categories (optional, default value will be "false") |
fromAddress String |
Mail address that will be used to send mail notifications (required) |
globalSubject String |
Subject that will be used in mail notifications (optional, default value will be empty string) |
primaryMailServerAddress String |
Hostname/IP for Primary SMTP Server (required) |
primaryMailServerPassword String |
Password for Primary SMTP Server (optional, default value will be empty string) |
primaryMailServerPort Integer |
Port for Primary SMTP Server (required) |
primaryMailServerUserName String |
Username for Primary SMTP Server (optional, default value will be empty string) |
secondaryMailServerAddress String |
Hostname/IP for Secondary SMTP Server (optional, default value will be empty string) |
secondaryMailServerPassword String |
Password for Secondary SMTP Server (optional, default value will be empty string) |
secondaryMailServerPort Integer |
Port for Secondary SMTP Server (optional, default value will be 0) |
secondaryMailServerUserName String |
Username for Secondary SMTP Server (optional, default value will be empty string) |
toAddress String |
Comma separated list of mail notification recipients (required) |
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Request Payload
https://localhost/webacs/api/v3/op/settings/notification/mailServer
<?xml version="1.0" ?>
<mailServerSettingsDTO>
<applyToAlarms>true</applyToAlarms>
<fromAddress>String value</fromAddress>
<globalSubject>String value</globalSubject>
<primaryMailServerAddress>String value</primaryMailServerAddress>
<primaryMailServerPassword>String value</primaryMailServerPassword>
<primaryMailServerPort>15</primaryMailServerPort>
<primaryMailServerUserName>String value</primaryMailServerUserName>
<secondaryMailServerAddress>String value</secondaryMailServerAddress>
<secondaryMailServerPassword>String value</secondaryMailServerPassword>
<secondaryMailServerPort>15</secondaryMailServerPort>
<secondaryMailServerUserName>String value</secondaryMailServerUserName>
<toAddress>String value</toAddress>
</mailServerSettingsDTO>
Sample JSON Request Payload
https://localhost/webacs/api/v3/op/settings/notification/mailServer.json
{
"mailServerSettingsDTO" : {
"applyToAlarms" : true,
"fromAddress" : "String value",
"globalSubject" : "String value",
"primaryMailServerAddress" : "String value",
"primaryMailServerPassword" : "String value",
"primaryMailServerPort" : 15,
"primaryMailServerUserName" : "String value",
"secondaryMailServerAddress" : "String value",
"secondaryMailServerPassword" : "String value",
"secondaryMailServerPort" : 15,
"secondaryMailServerUserName" : "String value",
"toAddress" : "String value"
}
}