Difference between revisions of "API: Client mail"
From BrainyCP
m (Fgsfds переименовал страницу API: почтовые ящики клиента в API: Client mail) |
|||
| Line 1: | Line 1: | ||
| − | + | 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. | |
{| border="1" cellpadding="5" | {| border="1" cellpadding="5" | ||
|- | |- | ||
| − | | <p dir="ltr" style="text-align: center;">''' | + | | <p dir="ltr" style="text-align: center;">'''Module'''</p> |
| − | | <p dir="ltr" style="text-align: center;">''' | + | | <p dir="ltr" style="text-align: center;">'''Function'''</p> |
| − | | <p dir="ltr" style="text-align: center;">''' | + | | <p dir="ltr" style="text-align: center;">'''Incoming data'''</p> |
| − | | <p dir="ltr" style="text-align: center;">''' | + | | <p dir="ltr" style="text-align: center;">'''Error variants'''</p> |
|- | |- | ||
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
| Line 15: | Line 15: | ||
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
| − | + | Client mail list. | |
getlistmail | getlistmail | ||
| + | | style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">username (post) * - username;</div> <div data-placeholder="Перевод" dir="ltr">password (post) * - user password;</div> <div data-placeholder="Перевод" dir="ltr">mailclient (post) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">getlistmail (post) * - constant, type of operation;</div> <div data-placeholder="Перевод" dir="ltr">language (post) - can take the value: en / ru (ru by default);</div> <div data-placeholder="Перевод" dir="ltr">panel_user (post) - ISP username to which the operation is applied.</div> | ||
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
| − | + | 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>'. | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | error:1001, mess:' | ||
|- | |- | ||
| Line 46: | Line 34: | ||
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
| − | + | Client mail forwarding list. | |
getforwardmail | getforwardmail | ||
| − | | style="vertical-align: top;" | | + | | style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">username (post) * - username;</div> <div data-placeholder="Перевод" dir="ltr">password (post) * - user password;</div> <div data-placeholder="Перевод" dir="ltr">mailclient (post) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">getforwardmail (post) * - constant, type of operation;</div> <div data-placeholder="Перевод" dir="ltr">language (post) - can take the value: en / ru (ru by default);</div> <div data-placeholder="Перевод" dir="ltr">panel_user (post) - ISP username to which the operation is applied.</div> |
| − | username (post)* | + | | style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'The mailbox list was successfully retrieved for: <name>';</div> <div data-placeholder="Перевод" dir="ltr">error: 1, mess: 'Nothing was found for:' <name> ';</div> <div data-placeholder="Перевод" dir="ltr">error: 1000, mess: 'You do not have administrator rights';</div> <div data-placeholder="Перевод" dir="ltr">error: 1001, mess: 'There is no such user in the ISP-panel: <user>'.</div> |
| − | |||
| − | password (post)* | ||
| − | |||
| − | mailclient (post)* | ||
| − | |||
| − | getforwardmail (post)* | ||
| − | |||
| − | language (post) | ||
| − | |||
| − | panel_user (post) | ||
| − | |||
| − | | style="vertical-align: top;" | | ||
| − | error:0, mess:' | ||
| − | |||
| − | error:1, mess:' | ||
| − | |||
| − | error:1000, mess:' | ||
| − | |||
| − | error:1001, mess:' | ||
| − | |||
|} | |} | ||
| − | + | Other useful articles: | |
{| style="width: 1191px;" | {| style="width: 1191px;" | ||
Revision as of 00:58, 11 April 2021
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:
