recipient
The recipient
data type describes the recipient property of the recipients
data type.
Properties
The table below describes the properties included in the recipient
data type.
Property | Data type | Description | Notes |
address | String | Specifies a comma-separated list of well-formed email addresses for notification about messages added to the tenant log. | This property is required on a POST request. |
importance | String |
Specifies whether HCP should send email only about important log messages to the specified email addresses or send email about all log messages. Valid values are:
The default is MAJOR. These values are not case sensitive. | |
severity | String |
Specifies the severity level of the log messages about which to send email. Valid values are:
The default is ERROR. These values are not case sensitive. | |
type | String |
Specifies the types of log messages about which to send email. Valid values are comma-separated lists of one or more of:
The default is GENERAL. These values are not case sensitive. |
Example
Here’s an XML example of the recipient data type:
<recipient> <address>lgreen@example.com, sgold@example.com</address> <importance>MAJOR</importance> <severity>ERROR</severity> <type>GENERAL,SECURITY</type> </recipient>