API: Client mail
From BrainyCP
Revision as of 13:11, 26 July 2021 by Alenka (talk | contribs) (Protected "API: Client mail" ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite)))
Administrative functions require API root rights in order to use any login hosted on the server. If you do not have root rights, you can only use your login.
Incoming data marked with an asterisk are required.
| Module |
Function |
Incoming data |
Error variants |
|
mailclient |
Client mail list. getlistmail |
username (post) * - username; password (post) * - user password; mailclient (post) * - constant, module name; getlistmail (post) * - constant, type of operation; language (post) - can take the value: en / ru (ru by default); panel_user (post) - ISP username to which the operation is applied.
|
error: 0, mess: 'The mailbox list was successfully retrieved for: <name>'; error: 1, mess: 'Nothing was found for:' <name> '; error: 1000, mess: 'You do not have administrator rights'; error: 1001, mess: 'There is no such user in the ISP-panel: <user>'. |
|
mailclient |
Client mail forwarding list. getforwardmail |
username (post) * - username; password (post) * - user password; mailclient (post) * - constant, module name; getforwardmail (post) * - constant, type of operation; language (post) - can take the value: en / ru (ru by default); panel_user (post) - ISP username to which the operation is applied.
|
error: 0, mess: 'The mailbox list was successfully retrieved for: <name>'; error: 1, mess: 'Nothing was found for:' <name> '; error: 1000, mess: 'You do not have administrator rights'; error: 1001, mess: 'There is no such user in the ISP-panel: <user>'.
|
Other useful articles:
