Difference between revisions of "API: Client mail"

From BrainyCP
Jump to: navigation, search
(Новая страница: « Администраторские функции требуют root-права API, чтобы использовать любой логин, размещен…»)
 
 
(6 intermediate revisions by 3 users not shown)
Line 1: Line 1:
  
−
Администраторские функции требуют root-права API, чтобы использовать любой логин, размещенный на сервере. Если root-прав нет, можно использовать только свой логин.
+
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>  
+
| <p dir="ltr" style="text-align: center;">'''Module'''</p>  
−
| <p dir="ltr" style="text-align: center;">'''Функция'''</p>  
+
| <p dir="ltr" style="text-align: center;">'''Function'''</p>  
−
| <p dir="ltr" style="text-align: center;">'''Входящие данные'''</p>  
+
| <p dir="ltr" style="text-align: center;">'''Incoming data'''</p>  
−
| <p dir="ltr" style="text-align: center;">'''Варианты ошибок'''</p>  
+
| <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;" |  
−
username (post)* — имя пользователя;
+
error: 0, mess: 'The mailbox list was successfully retrieved for: <name>';
  
−
password (post)* — пароль пользователя;
+
error: 1, mess: 'Nothing was found for:' <name> ';
  
−
mailclient (post)* — константа, имя модуля;
+
error: 1000, mess: 'You do not have administrator rights';
  
−
getlistmail (post)* — константа, тип операции;
+
error: 1001, mess: 'There is no such user in the ISP-panel: <user>'.
  
−
language (post) — может принимать значение: en/ru (по умолчанию ru);
+
|-
 +
| style="vertical-align: top;" |
 +
mailclient
 +
 
 +
| style="vertical-align: top;" |
 +
Client mail forwarding list.
 +
 
 +
getforwardmail
  
−
panel_user (post) — имя пользователя ISP, к которому применяется операция.
+
| 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>
 +
| 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>
 +
|}
  
−
| style="vertical-align: top;" |  
+
Other useful articles:
−
error:0, mess:'Список почтовых ящиков был успешно получен для: <name>';
+
 
 +
{| style="width: 1059px;"
 +
|-
 +
| style="width: 313px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_connection <font><font>API: connection</font></font>]'''
 +
 
 +
| style="width: 361px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Monitoring <font><font>API: monitoring</font></font>]'''
 +
 
 +
| style="width: 363px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Webserver_status <font><font>API: web server status</font></font>]'''
 +
 
 +
|-
 +
| style="width: 313px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_CMS_Autoinstaller <font><font>API: auto installer CMS</font></font>]'''
 +
 
 +
| style="width: 361px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Configuring_backups <font><font>API: configuring backups</font></font>]'''
 +
 
 +
| style="width: 363px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Transfer_between_servers <font><font>API: transfer between servers</font></font>]'''
 +
 
 +
|-
 +
| style="width: 313px;" |  
 +
'''[https://docs.brainycp.io/index.php/API:_Antivirus <font><font>API: antivirus</font></font>]'''
 +
 
 +
| style="width: 361px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Server_configuration <font><font>API: server settings</font></font>]'''
 +
 
 +
| style="width: 363px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Manage_webserver <font><font>API: web server management</font></font>]'''
  
−
error:1, mess:'Ничего не было найдено для:' <name>';
+
|-
 +
| style="width: 313px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Databases <font><font>API: database</font></font>]'''
  
−
error:1000, mess:'У вас нет прав администратора';
+
| style="width: 361px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_User_Certificates <font><font>API: custom certificates</font></font>]'''
  
−
error:1001, mess:'Такой пользователь отсутствует в ISP-панели:<user>'.
+
| style="width: 363px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Managing_mailboxes <font><font>API: mailbox management</font></font>]'''
  
 
|-
 
|-
−
| style="vertical-align: top;" |  
+
| style="width: 313px;" |
−
mailclient
+
'''[https://docs.brainycp.io/index.php/API:_Server_info <font><font>API: server information</font></font>]'''
 +
 
 +
| style="width: 361px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Mail <font><font>API: mail</font></font>]'''
 +
 
 +
| style="width: 363px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Manage_DNS-zones <font><font>API: DNS zone management</font></font>]'''
 +
 
 +
|-
 +
| style="width: 313px;" |  
 +
'''[https://docs.brainycp.io/index.php/API:_Traffic_usage <font><font>API: traffic usage</font></font>]'''
 +
 
 +
| style="width: 361px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Client_mail <font><font>API: client mailboxes</font></font>]'''
 +
 
 +
| style="width: 363px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Webserver_Installation <font><font>API: web server installation</font></font>]'''
  
−
| style="vertical-align: top;" |  
+
|-
−
Список почтовых перенаправление клиента.
+
| style="width: 313px;" |  
 +
'''[https://docs.brainycp.io/index.php/API:_Logging <font><font>API: logging</font></font>]'''
  
−
getforwardmail
+
| style="width: 361px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Nameserver <font><font>API: name server</font></font>]'''
  
−
| style="vertical-align: top;" |  
+
| style="width: 363px;" |  
−
username (post)* — имя пользователя;
+
'''[https://docs.brainycp.io/index.php/API:_host-accounts <font><font>API: host accounts</font></font>]'''
  
−
password (post)* — пароль пользователя;
+
|-
 +
| style="width: 313px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_App_manager <font><font>API: application manager</font></font>]'''
  
−
mailclient (post)* — константа, имя модуля;
+
| style="width: 361px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Certificates_of_services <font><font>API: service certificates</font></font>]'''
  
−
getforwardmail (post)* — константа, тип операции;
+
| style="width: 363px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_CRON <font><font>API: CRON</font></font>]'''
  
−
language (post) — может принимать значение: en/ru (по умолчанию ru);
+
|-
 +
| style="width: 313px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Process_manager <font><font>API: process manager</font></font>]'''
  
−
panel_user (post) — имя пользователя ISP, к которому применяется операция.
+
| style="width: 361px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Network_tools <font><font>API: network tools</font></font>]'''
  
−
| style="vertical-align: top;" |  
+
| style="width: 363px;" |  
−
error:0, mess:'Список почтовых ящиков был успешно получен для: <name>';
+
'''[https://docs.brainycp.io/index.php/API:_FTP-server <font><font>API: FTP server</font></font>]'''
  
−
error:1, mess:'Ничего не было найдено для:' <name>';
+
|-
 +
| style="width: 313px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_IP-address_manager <font><font>API: IP address manager</font></font>]'''
  
−
error:1000, mess:'У вас нет прав администратора';
+
| style="width: 361px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_Load_average <font><font>API: average load</font></font>]'''
  
−
error:1001, mess:'Такой пользователь отсутствует в ISP-панели:<user>'.
+
| style="width: 363px;" |
 +
'''[https://docs.brainycp.io/index.php/API:_MySQL_processlist <font><font>API: MySQL processlist</font></font>]'''
  
 
|}
 
|}

Latest revision as of 14:27, 17 November 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:

API: connection

API: monitoring

API: web server status

API: auto installer CMS

API: configuring backups

API: transfer between servers

API: antivirus

API: server settings

API: web server management

API: database

API: custom certificates

API: mailbox management

API: server information

API: mail

API: DNS zone management

API: traffic usage

API: client mailboxes

API: web server installation

API: logging

API: name server

API: host accounts

API: application manager

API: service certificates

API: CRON

API: process manager

API: network tools

API: FTP server

API: IP address manager

API: average load

API: MySQL processlist

Retrieved from "https://docs.brainycp.io/index.php?title=API:_Client_mail&oldid=1934"