All Classes Files Functions Variables Enumerations Enumerator Groups Pages
kerio::jsonapi::admin::Content Interface Reference

Public Member Functions

void addBlackLists (out kerio::web::ErrorList errors, in BlackListList items)
void getAntiSpamSetting (out AntiSpamSetting setting)
void getAntivirusSetting (out AntivirusSetting setting)
void getAttachmentRules (out AttachmentItemList filterRules)
void getAttachmentSetting (out AttachmentSetting setting)
void getAvailableAttachments (out kerio::web::StringList fileNames, out kerio::web::StringList mimeTypes)
void getBlackListList (out BlackListList list)
void getCustomRuleList (out CustomRuleList list, out long totalItems, in kerio::web::SearchQuery query)
void removeBlackLists (out kerio::web::ErrorList errors, in kerio::web::KIdList ids)
void removeUnusedCustomRules (in long number, in HourOrDay unit)
void setAntiSpamSetting (in AntiSpamSetting setting)
void setAntivirusSetting (out kerio::web::ErrorList errors, in AntivirusSetting setting)
void setAttachmentRules (in AttachmentItemList filterRules)
void setAttachmentSetting (in AttachmentSetting setting)
void setBlackLists (out kerio::web::ErrorList errors, in kerio::web::KIdList ids, in BlackList pattern)
void setCustomRuleList (in CustomRuleList list)
void testGreylistConnection ()
void updateAntivirusStatus (out IntegratedAvirUpdateStatus status)
void updateIntegratedAntivirus ()

Member Function Documentation

void kerio::jsonapi::admin::Content::addBlackLists ( out kerio::web::ErrorList  errors,
in BlackListList  items 
)

Add a blacklist item.

Parameters
errors- error message list
items- array of new items
void kerio::jsonapi::admin::Content::getAntiSpamSetting ( out AntiSpamSetting  setting)

Get antiSPAM settings.

Parameters
setting- new antivirus filter settings
void kerio::jsonapi::admin::Content::getAntivirusSetting ( out AntivirusSetting  setting)

Get antivirus filter settings.

Parameters
setting- new antivirus filter settings
void kerio::jsonapi::admin::Content::getAttachmentRules ( out AttachmentItemList  filterRules)

Get a list of attachment filter rules.

Parameters
filterRules- attachment filter rules
void kerio::jsonapi::admin::Content::getAttachmentSetting ( out AttachmentSetting  setting)

Obtain attachment filter settings.

Parameters
setting- current attachment filter settings
void kerio::jsonapi::admin::Content::getAvailableAttachments ( out kerio::web::StringList  fileNames,
out kerio::web::StringList  mimeTypes 
)

When adding a new attachment rule this can be used to find out available values.

Parameters
fileNames- list of available file names
mimeTypes- list of available MIME types
void kerio::jsonapi::admin::Content::getBlackListList ( out BlackListList  list)

Obtain all blacklist items.

Parameters
list- blacklist items
void kerio::jsonapi::admin::Content::getCustomRuleList ( out CustomRuleList  list,
out long  totalItems,
in kerio::web::SearchQuery  query 
)

Obtain all custom rules.

Parameters
list- custom rules
totalItems- amount of rules for given search condition, useful when a limit is defined in search query
query- condition and limit definition (orderBy is ignored)
void kerio::jsonapi::admin::Content::removeBlackLists ( out kerio::web::ErrorList  errors,
in kerio::web::KIdList  ids 
)

Remove blacklist items.

Parameters
errors- error message list
ids- identifier list of blacklists to be deleted
void kerio::jsonapi::admin::Content::removeUnusedCustomRules ( in long  number,
in HourOrDay  unit 
)

Remove custom rules which are not used for a specified time.

Parameters
number- how many hours/days is the rule unused
unit- which unit is used to measure
void kerio::jsonapi::admin::Content::setAntiSpamSetting ( in AntiSpamSetting  setting)

Set antiSPAM filter settings.

Parameters
setting- new antivirus filter settings
void kerio::jsonapi::admin::Content::setAntivirusSetting ( out kerio::web::ErrorList  errors,
in AntivirusSetting  setting 
)

Set antivirus filter settings.

Parameters
errors- error message; Value of inputIndex means type of antivirus (integrated = 0 and external = 1).
setting- new antivirus filter settingss
void kerio::jsonapi::admin::Content::setAttachmentRules ( in AttachmentItemList  filterRules)

Set list of attachment filter rules.

Parameters
filterRules- attachment filter rules
void kerio::jsonapi::admin::Content::setAttachmentSetting ( in AttachmentSetting  setting)

Set attachment filter settings.

Parameters
setting- new attachment filter settings
void kerio::jsonapi::admin::Content::setBlackLists ( out kerio::web::ErrorList  errors,
in kerio::web::KIdList  ids,
in BlackList  pattern 
)

Set blacklist item.

Parameters
errors- error message list
ids- list of blacklist global identifier(s)
pattern- pattern to use for new values
void kerio::jsonapi::admin::Content::setCustomRuleList ( in CustomRuleList  list)

Set custom rules.

Parameters
list- custom rule records
void kerio::jsonapi::admin::Content::testGreylistConnection ( )

Test connection to the greylisting service. Returns nothing if successful.

void kerio::jsonapi::admin::Content::updateAntivirusStatus ( out IntegratedAvirUpdateStatus  status)

Get progress of antivirus updating.

Parameters
status- status of the update process
void kerio::jsonapi::admin::Content::updateIntegratedAntivirus ( )

Force update of the integrated antivirus.


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