CSMailSubscriptionHandlerReadData Method Content Studio 5.7 SDK
Content Studio Web Content Management System

[This is preliminary documentation and is subject to change.]

Gets a list of subscribers that should receive messages.

Namespace: ContentStudio.Document.Subscription.EventHandler
Assembly: CSSubscriptionEventHandler (in CSSubscriptionEventHandler.dll) Version: (

protected override IList<SubscriptionInformation> ReadData(
	int dataIndex


Type: SystemInt32
When data to read is paged this is the index if the data page to read. This first data page is zero the event handler increments this value for each subsequent calls.

Return Value

Type: IListSubscriptionInformation
A IListT of SubscriptionInformation that gets loaded with the subscribers found.

The event handler calls this method when it reads subscribers to send mail to. This method gets called until the returned collection is either null or empty.

Note Note
When you implement this method you must make sure to return an empty collection of data when there is no more data to return. Even if there is only one record returned the event handler will call this method again with the next dataIndex!

See Also