Enables scripted content fragments to use email digest
Methods
Create
Create a new email digest subscription
Velocity
#set($emailDigestSubscriptionResponse = $core_v2_emailDigest.Create($context, $contextId, $frequencyInDays))
JavaScript
var emailDigestSubscriptionResponse = core_v2_emailDigest.Create(context, contextId, frequencyInDays);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
context | String | Context | Required | group | |
contextId | Int32 | Id of context | Required | ||
frequencyInDays | Int32 | Frequency in days | Required |
Returns
Delete
Delete an email digest subscription
Velocity
#set($additionalInfoResponse = $core_v2_emailDigest.Delete($subscriptionId))
JavaScript
var additionalInfoResponse = core_v2_emailDigest.Delete(subscriptionId);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
subscriptionId | Int32 | Id of subscription | Required |
Returns
Get
Get an email digest subscription
Velocity
#set($emailDigestSubscriptionResponse = $core_v2_emailDigest.Get($id))
JavaScript
var emailDigestSubscriptionResponse = core_v2_emailDigest.Get(id);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
id | Int32 | Id of the subscription | Required |
Returns
GetByGroup
Get an email digest subscription for a group
Velocity
#set($emailDigestSubscriptionResponse = $core_v2_emailDigest.GetByGroup($groupId))
JavaScript
var emailDigestSubscriptionResponse = core_v2_emailDigest.GetByGroup(groupId);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
groupId | Int32 | Id of the group | Required |
Returns
List
List email digest subscriptions
Velocity
#set($pagedListResponse = $core_v2_emailDigest.List($pageIndex, $pageSize))
JavaScript
var pagedListResponse = core_v2_emailDigest.List(pageIndex, pageSize);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
pageIndex | Int32 | Specify the page number of paged results to return. Zero-based index. | Required | 0 | |
pageSize | Int32 | Specify the number of results to return per page. | Required | 20 |
Returns
ListGroupSubscriptionsWithoutMembership
Velocity
#set($pagedListResponse = $core_v2_emailDigest.ListGroupSubscriptionsWithoutMembership($pageIndex, $pageSize))
JavaScript
var pagedListResponse = core_v2_emailDigest.ListGroupSubscriptionsWithoutMembership(pageIndex, pageSize);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
pageIndex | Int32 | Page Index | Required | ||
pageSize | Int32 | Page Size | Required |
Returns
Update
Update an email digest subscription
Velocity
#set($emailDigestSubscriptionResponse = $core_v2_emailDigest.Update($subscriptionId, $frequencyInDays))
JavaScript
var emailDigestSubscriptionResponse = core_v2_emailDigest.Update(subscriptionId, frequencyInDays);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
subscriptionId | Int32 | Id of subscription | Required | ||
frequencyInDays | Int32 | Frequency of description | Required |