| Function name |
Function signature |
| filters_destroy |
int filters_destroy (object:filters filters) |
|
This function destroys a filters object
|
| filters_remove_socket_filter |
int filters_remove_socket_filter (object:filters filters, object:socket_filter filter) |
|
This function removes a socket filter from the current filter object , returns 0 on succes, -1 on failure
|
| filters_remove_active_filter |
int filters_remove_active_filter (object:filters filters, object:active_filter filter) |
|
This function removes an active filter from the current filter object, returns 0 on success, -1 on failure
|
| filters_remove_socket_filter_by_name |
int filters_remove_socket_filter_by_name (object:filters filters, string name) |
|
This function removes a socket filter identified by name, returns 0 on success, -1 on failure
|
| filters_save |
int filters_save (object:filters filters, object:session s) |
|
This function saves the current filters configuration
|
| filters_add_socket_filter |
object:socket_filter filters_add_socket_filter (object:filters filters, object:session session, string name, string address, string protocol_file) |
|
This function creates a socket filter. It takes as arguments the name of the filter, the address of the socket and the path to a protocol file which contains communication details with the application listening on the supplied socket address (eg spamassasin)
|
| filters_remove_active_filter_by_priority |
int filters_remove_active_filter_by_priority (object:filters filters, int priority) |
|
This function removes an active filter identified by its priority, returns 0 on success, -1 on failure
|
| filters_socket_count |
int filters_socket_count (object:filters filters) |
|
This function returns the number of socket filters
|
| filters_add_active_filter |
object:active_filter filters_add_active_filter (object:filters filters, object:session session, int priority, string name, string type) |
|
This function makes a script/socket filter identified by the name parameter active. The method must suply the priority of the filter (the lower the priority, the faster the filter will be executed) and the type of the filter (script/socket)
|
| filters_active_count |
int filters_active_count (object:filters filters) |
|
This function returns the number of active filters
|
| filters_remove_script_filter_by_name |
int filters_remove_script_filter_by_name (object:filters filters, string name) |
|
This function removes a script filter identified by the name parameter, returns 0 on success, -1 on failure
|
| filters_script_count |
int filters_script_count (object:filters filters) |
|
This function returns the number of script filters
|
| filters_load |
object:filters filters_load (object:session s, object:context_list context) |
| filters_add_script_filter |
object:script_filter filters_add_script_filter (object:filters filters, object:session session, string name, string type, string file) |
|
This function creates a new script filter. It takes as arguments the name of the filter, it's type (which must be "sieve") and the valid path to a file containing the sieve implementation of the filter
|
| filters_remove_script_filter |
int filters_remove_script_filter (object:filters filters, object:script_filter filter) |
|
This function removes a script filter from the current filter object, returns 0 on succes, -1 on failure
|
