Element: tns:emailEntitlementRequest

Description

An emailEntitlementRequest message contains an element of emailEntitlementRequestType.

Derived By

Type emailEntitlementRequestType

Content Model

Contains elements as defined in the following table.

Component	Type	Occurs	Description
		1..1
entitlementIdentifier	entitlementIdentifierType	1..1	Required. An emailEntitlementRequest contains an entitlementIdentifier element identifying the entitlement certificate to be emailed. See entitlementIdentifierType.
ignoreExistingEmailList	boolean	0..1	Optional. If true, all email addresses must be specified explicitly in the request. It is not possible to specify which of a list of existing email addresses to exclude (exclude all or none). If not set, the value is false.
validateEmailAddresses	boolean	0..1	Optional. Perform simple validation of email addresses in the request? Default is false. regex: "^[_A-Za-z0-9-\\+\\.\\%]+@" +"([A-Za-z0-9-\\.]+)(\\.[A-Za-z]{1,10})$"
emailIdList	emailContactListType	0..1	See emailContactListType.
ccEmailIdList	emailContactListType	0..1
bccEmailIdList	emailContactListType	0..1
locale	string	0..1	Optional. A string containing one of the locale settings supported by Java, for example, en_US. Set to the preferred locale for the entitlement certificate and email templates. If the locale is valid and templates have been configured for that locale, the localized templates will be used to send the email.

Referenced By

Name	Type
emailEntitlement	Method

XML Example

The following XML fragment illustrates an emailEntitlementRequest message:

<emailEntitlementRequest>
   <entitlementIdentifier>
      <primaryKeys>
         <entitlementId>186c-6b21-0c49-7f17-bf7f-f1</entitlementId>
      </primaryKeys>
   </entitlementIdentifier>
   <emailIdList>
      <emailId>test@example.com</emailId>
   </emailIdList>
</emailEntitlementRequest>