Page.sendEmailReview (Method)
Emails a review copy of a page to the specified users and groups.
Returns:
Void
Arguments:
Name | Type | Required | Description |
---|---|---|---|
pageID | RealPageID_NonBaseTemplate | Required | A page's ID. |
subject | PlainText_NonNull_255 | Required | The email message's subject. |
message | PlainText_NonNull | Required | The message CommonSpot includes in the email. |
userGroupIDList | UserGroupID_ExcludingAnonAuthList_EmptyString | Optional. Defaults to an empty string. | A comma-delimited list of one or more user or group IDs. This ID cannot be 0 (the 'anonymous' group) or 1 (the 'authenticated' group). If this value is an empty string, you must specify at least one email address in the 'additionalEmailAddressesList' argument. |
additionalEmailAddressesList | EmailAddressList_EmptyString | Optional. Defaults to an empty string. | A comma-delimited list of additional email address to include. |
versionState | EmailReviewVersionState | Optional. Defaults to 'Read'. | The version state of the page: 'Read', 'Author', or 'Edit'. |
includeVisualDifferenceFile | Boolean | Optional. Defaults to '0'. | Boolean flag which when set to true indicates that CommonSpot will attach a file that shows what has changed using a 'red line' format. |
Context:
License Requirements | ReviewByEmail |
Permission Requirements | Contributor |
Deny Context | None |
Require Context | AuthoringEnabled |
Author Lock | (not required) |
Transaction Logging | Transaction logging is disabled for this method |
Customization | This method may be customized at the site level |
Error Codes:
Code | Error Message |
---|---|
31016 | Users, Groups or Additional Email Addresses must be specified. |
1005007 | Sending of emails is not configured. |
Notes:
None