EmailHelper.Queue Class

Contains simple services for queue management actions callable from UI.

Inheritance Hierarchy

System.Object
  CMS.EmailEngine.EmailHelper.Queue

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

Syntax

public static class Queue

The EmailHelper.Queue type exposes the following members.

Properties

	Name	Description
Public property Static member	SendingInProgess	Gets a value indicating whether there are active sending threads.

Methods

	Name	Description
Public method Static member	CancelSending	Cancels currently running mailout and optionally logs a web farm task propagating the cancellation.
Public method Static member	Delete(Int32)	Deletes an e-mail with the specified ID.
Public method Static member	Delete(Int32[])	Deletes e-mails with the specified IDs.
Public method Static member	DeleteAll	Deletes all e-mails waiting in the queue.
Public method Static member	DeleteAllFailed	Deletes all e-mails whose delivery failed.
Public method Static member	DeleteArchived	Deletes all archived e-mails.
Public method Static member	Send(Int32)	Sends an e-mail with the specified ID.
Public method Static member	Send(Int32[])	Sends e-mail messages with the specified IDs.
Public method Static member	SendAll()	Sends all e-mails waiting in the queue.
Public method Static member	SendAll(Int32)	Sends all e-mails for given siteId.
Public method Static member	SendAllFailed()	Sends all e-mails whose delivery failed.
Public method Static member	SendAllFailed(Int32)	Sends all e-mails whose delivery failed for given siteId.
Public method Static member	SendScheduled	Runs the e-mail queue mailout in a separate thread.
Public method Static member	SendScheduledAndFailed	Sends all e-mails waiting in the queue. Also sends all failed emails, which are newer than DateTime.