kerio::jsonapi::admin::Queue Interface Reference

Public Member Functions
void	get (out MessageInQueueList list, out long totalItems, out kerio::web::ByteValueWithUnits volume, in kerio::web::SearchQuery query)
void	getProcessed (out MessageInProcessList list, out long totalItems, in kerio::web::SearchQuery query)
void	remove (out long deleteItems, in kerio::web::KIdList messageIds)
void	removeAll (out long deleteItems)
void	removeMatching (out long deleteItems, in string senderPattern, in string recipientPattern)
void	run ()
void	tryToSend (in kerio::web::KIdList messageIds)

Member Function Documentation

void kerio::jsonapi::admin::Queue::get	(	out MessageInQueueList	list,
		out long	totalItems,
		out kerio::web::ByteValueWithUnits	volume,
		in kerio::web::SearchQuery	query
	)

Obtain a list of queued messages.

Parameters

list	- awaiting messages
totalItems	- number of listed messages
volume	- space occupied by messages in the queue
query	- search conditions

void kerio::jsonapi::admin::Queue::getProcessed	(	out MessageInProcessList	list,
		out long	totalItems,
		in kerio::web::SearchQuery	query
	)

List messages that are being processed by the server.

Parameters

list	- processed messages
totalItems	- number of processed messages
query	- search conditions

void kerio::jsonapi::admin::Queue::remove	(	out long	deleteItems,
		in kerio::web::KIdList	messageIds
	)

Remove selected messages from the message queue.

Parameters

deletedItems	- number of items deleted from the message queue
messageIds	- identifiers of messages to be deleted

void kerio::jsonapi::admin::Queue::removeAll

(

out long

deleteItems

)

Remove all message from the queue.

Parameters

deletedItems

- number of items deleted from the message queue

void kerio::jsonapi::admin::Queue::removeMatching	(	out long	deleteItems,
		in string	senderPattern,
		in string	recipientPattern
	)

Remove all messages matching a pattern from the message queue.

Parameters

deletedItems	- number of items deleted from the message queue
senderPattern	- sender pattern with wildcards
recipientPattern	- recipient pattern with wildcards

void kerio::jsonapi::admin::Queue::run

(

)

Try to process message queue immediately.

void kerio::jsonapi::admin::Queue::tryToSend

(

in kerio::web::KIdList

messageIds

)

Try to send selected messages.

Parameters

messageIds

- identifiers of messages to be sent immediately

---

The documentation for this interface was generated from the following file:

• Queue.idl