EmailInfoProvider.DeleteArchived Method

Deletes expired archived e-mails. Size of deleted "batch" is specified by batchSize.

Namespace: CMS.EmailEngine
Assembly: CMS.EmailEngine (in CMS.EmailEngine.dll) Version: 13.0.131

Syntax

public static int DeleteArchived(
	int siteId,
	DateTime expirationDate,
	int batchSize
)

Parameters

siteId

Type: System.Int32
Site ID

expirationDate

Type: System.DateTime
Every archived email older that expiration date will be deleted

batchSize

Type: System.Int32
Number of emails to be deleted at once

Return Value

Type: Int32
Returns number of deleted emails.