From ISPWiki

See also

• ISPmanager API/Reseller
• ISPmanager API/Server administrator
• ISPmanager API/User (siteadmin)

Mail user

E-Mail

Spam filter

Function: spamc

The function is simultaneously used to view and change form's data

View data:

• Result: parameters list

Change the data:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• spamass_u_l - Enable the spam filter . (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature usersa.
  Active parameter allows the use of the following parameters: 'required_score','rewrite_subject','report_safe','spam_action'

• required_score - Required score .
• rewrite_subject - Add to the "Subject" field .
• report_safe - Report type .
• spam_action - Action .

Email filtering

Function: email.sorter

Result: the list of elements

• name - Name .

Function: email.sorter.edit

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • elid - unique identifier ("name" element of "email.sorter" function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • elid - unique identifier ("name" element of "email.sorter" function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• name - Name.
• pos - Place before .
• cond_param - Parameter .
  If the cond_none value is selected the parameters are denied: 'cond_value'

• cond - Condition .
• cond_value - Value.
• act - Supported action .
  If the command value is selected the parameters are allowed to use: 'act_command','act_copy' and the parameters are denied: 'act_email','act_imap','act_imap_new'

• act_email - Email .
• act_imap - IMAP folder .
  If the new_folder value is selected the parameters are allowed to use: 'act_imap_new'

• act_imap_new - New IMAP folder.
• act_command - Program.
• copy - Use a copy. (Optional parameter. To enable the option click "on".)

Function: email.sorter.delete

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "name" element of "email.sorter" function.

Result: successful operation or error message

Function: email.sorter.cond

Parameters:

• elid - unique identifier ("name" element of "email.sorter" function).

Result: elements list

• id - The list element unique identifier
• cond_param - Parameter .
• cond - Condition .
• cond_value - Value .

Function: email.sorter.cond.edit

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • plid - parent list unique identifier ("name" element of "email.sorter" function).
  • elid - unique identifier ("id" element of "email.sorter.cond" function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • plid - parent list unique identifier ("name" element of "email.sorter" function).
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • plid - parent list unique identifier ("name" element of "email.sorter" function).
  • elid - unique identifier ("id" element of "email.sorter.cond" function)
  • additional query parameters ...
• Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

• cond_param - Parameter .
• cond - condition.
• cond_value - Value .

Function: email.sorter.cond.delete

Parameters:

• plid - parent list unique identifier ("name" element of "email.sorter" function).
• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "email.sorter.cond" function.

Result: successful operation or error message

• Use the "featurelist" API function to get the list of active features.