ISPmanager API/Mail user

From ISPWiki

Jump to: navigation, search
Legend
  • Image:isp_lite.png - available in ISPmanager Lite
  • Image:isp_pro.png - available in ISPmanager Professional
  • Image:isp_cluster.png - available in ISPmanager Cluster

Contents

See also


Mail user

E-Mail

Spam filter

Image:isp_lite.png Image:isp_pro.png Image:isp_cluster.png
Spam filter . View. Change

Function: spamc

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

View data:

Change the data:

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

Image:isp_lite.png Image:isp_pro.png Image:isp_cluster.png
Email filtering

Function: email.sorter

Result: the list of elements

  • name - Name .


Create. Change. Email filter

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:

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'
If the forward value is selected the parameters are allowed to use: 'act_email','act_copy' and the parameters are denied: 'act_imap','act_imap_new','act_command'
If the redirect value is selected the parameters are allowed to use: 'act_email','act_copy' and the parameters are denied: 'act_imap','act_imap_new','act_command'
If the mirror value is selected the parameters are allowed to use: 'act_email','act_copy' and the parameters are denied: 'act_imap','act_imap_new','act_command'
If the imap value is selected the parameters are allowed to use: 'act_imap','act_copy' and the parameters are denied: 'act_email','act_command'
If the drop value is selected the parameters are denied: 'act_email','act_imap_new','act_imap','act_command','act_copy'
  • 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".)


Delete the selected mail filter

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


Email filter conditions

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 .


Create. Change. Condition

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 .


Delete the selected condition

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.
Was this helpful? Yes | No
Personal tools