emailNotification

Content Platform Tenant Management Help

Version
9.7.x
File Size
4269 KB
Audience
anonymous
Part Number
MK-95HCPH002-19

The emailNotification data type describes the emailNotification resource for tenants.

Properties

The table below describes the properties included in the emailNotification data type.

Property Data type Description Notes
emailTemplate

email

Template

Specifies the template for email messages HCP sends to the specified recipients.

The email template specified in the request body replaces the current email template. To restore the default email template, specify the emailTemplate property with no value.

For information about the default email template, see Email template defaults.

enabled Boolean

Specifies whether email notification is enabled for the tenant. Valid values are:

true
Email notification is enabled.
false
Email notification is disabled.

The default is false.

Email notification at the tenant level is supported only if HCP is configured to support it at the system level.
recipients recipients Specifies the set of recipients for email notification.

The set of recipients specified in the request body replaces the set of recipients currently configured for email notification. To remove all email recipients, specify an empty set.

Recipients are added to the Bcc list for each email.

Example

Here’s an XML example of the emailNotification data type:

<emailNotification>
    <enabled>true</enabled>
    <emailTemplate>
         <from>log@$location</from>
         <subject>$severity - $shortText</subject>
         <body>A message was written to the tenant log on $date.\n\n$reason\n\n
             $action</body>
    </emailTemplate>
    <recipients>
         <recipient>
              <address>lgreen@example.com, sgold@example.com</address>
              <importance>MAJOR</importance>
              <severity>ERROR</severity>
              <type>GENERAL,SECURITY</type>
          </recipient>
          <recipient>
              <address>mwhite@example.com</address>
              <importance>ALL</importance>
              <severity>WARNING</severity>
              <type>COMPLIANCE</type>
          </recipient>
    </recipients>
</emailNotification>