kerio::jsonapi::webmail::filters::Filters Interface Reference

Public Member Functions
void	get (out unsignedlong dataStamp, out FilterRuleList filters)
void	getById (out FilterRawRule rule, in unsignedlong currentDataStamp, in kerio::web::KId id)
void	generateRule (out FilterRawRule rule, in FilterRule pattern)
void	set (out unsignedlong newDataStamp, in unsignedlong currentDataStamp, in FilterRuleList filters)
void	setById (out unsignedlong newDataStamp, in unsignedlong currentDataStamp, in FilterRawRule rule)

Member Function Documentation

void kerio::jsonapi::webmail::filters::Filters::generateRule	(	out FilterRawRule	rule,
		in FilterRule	pattern
	)

Obtain rule in a script form generated from pattern.

Parameters

rule	- the script
pattern	- structured rule

void kerio::jsonapi::webmail::filters::Filters::get	(	out unsignedlong	dataStamp,
		out FilterRuleList	filters
	)

Gets all user's messages filtering rules.

Parameters

dataStamp	- server as concurrent modification protection and it is an stamp which must be stored by client since it is required for future modification of received list of filter rules (using set method).
filters	- list of all messages filtering rules defined by user

void kerio::jsonapi::webmail::filters::Filters::getById	(	out FilterRawRule	rule,
		in unsignedlong	currentDataStamp,
		in kerio::web::KId	id
	)

Obtain particular rule in a script form.

Parameters

rule	- the script
currentDataStamp	- the stamp obtained via function get
id	- ID of rule

void kerio::jsonapi::webmail::filters::Filters::set	(	out unsignedlong	newDataStamp,
		in unsignedlong	currentDataStamp,
		in FilterRuleList	filters
	)

Sets all users’ messages filtering rules. All old users’ rules will be replaced by list of those new rules.

Parameters

newDataStamp	- a new stamp that replaces your current stamp and it is bound to new filters configuration you save by calling this method
currentDataStamp	- the stamp which was assigned to you by the server when you called method get or set last time. After a successful call of this method (setting filters list), you will get a new stamp as output parameter. This new stamp will be bound to new filters configuration.
filters	- list of all messages filtering rules defined by user

void kerio::jsonapi::webmail::filters::Filters::setById	(	out unsignedlong	newDataStamp,
		in unsignedlong	currentDataStamp,
		in FilterRawRule	rule
	)

Set particular rule.

Parameters

newDataStamp	- a new stamp
currentDataStamp	- the stamp obtained via function get
rule	- the new script

---

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

• Filters.idl