Difference between revisions of "API: Managing mailboxes"

From BrainyCP
Jump to: navigation, search
 
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
  
 
 
 
 
−
 
+
<div data-placeholder="Перевод" dir="ltr">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.</div> <div data-placeholder="Перевод" dir="ltr">Incoming data marked with an asterisk are required.</div>
−
Администраторские функции требуют root-права API, чтобы использовать любой логин, размещенный на сервере. Если root-прав нет, можно использовать только свой логин.
 
−
 
 
−
Входящие данные, отмеченные звездочкой, обязательны для заполнения.
 
−
 
 
 
{| 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>  
+
| style="width: 116px;" | <p dir="ltr" style="text-align: center;">'''Function'''</p>  
−
| <p dir="ltr" style="text-align: center;">'''Входящие данные'''</p>  
+
| style="width: 380px;" | <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;" |  
 
mailclient
 
mailclient
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top; width: 116px;" |  
−
Добавление почтового ящика.
+
Add mail.
  
 
addmail
 
addmail
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top; width: 380px;" | <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">addmail (post) * - constant, type of operation;</div> <div data-placeholder="Перевод" dir="ltr">email (post) * - mailbox in userbox @ domain format;</div> <div data-placeholder="Перевод" dir="ltr">password (post) * - password for the mailbox;</div> <div data-placeholder="Перевод" dir="ltr">quota (post) * - quota;</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: 'Mailbox added successfully: <boxname>';</div> <div data-placeholder="Перевод" dir="ltr">error: 1, mess: 'This mailbox already exists: <boxname>';</div> <div data-placeholder="Перевод" dir="ltr">error: 2, mess: 'Error in the parameter array';</div> <div data-placeholder="Перевод" dir="ltr">error: 3, mess: 'An error occurred while adding mailbox: <boxname>';</div> <div data-placeholder="Перевод" dir="ltr">error: 4, mess: 'The specified domain in the mailbox was not found in the system: <boxname>';</div> <div data-placeholder="Перевод" dir="ltr">error: 1000, mess: 'You do not have permission to administer this user';</div> <div data-placeholder="Перевод" dir="ltr">error: 1001, mess: 'There is no such user in the ISP-panel'.</div>
−
 
 
−
password (post)* — пароль пользователя;
 
−
 
 
−
mailclient (post)* — константа, имя модуля;
 
−
 
 
−
addmail (post)* — константа, тип операции;
 
−
 
 
−
email (post)* — почтовый ящик в формате userbox@domain;
 
−
 
 
−
password (post)* — пароль на почтовый ящик;
 
−
 
 
−
quota (post)* — квота;
 
−
 
 
−
language (post) — может принимать значение: en/ru (по умолчанию ru);
 
−
 
 
−
panel_user (post) — имя пользователя ISP, к которому применяется операция.
 
−
 
 
−
| style="vertical-align: top;" |  
 
−
error:0, mess:'Почтовый ящик успешно добавлен:<boxname>';
 
−
 
 
−
error:1, mess:'Такой почтовый ящик уже существует: <boxname>';
 
−
 
 
−
error:2, mess:'Ошибка в массиве параметров';
 
−
 
 
−
error:3, mess:'Возникла ошибка при добавлении почтового ящика:<boxname>';
 
−
 
 
−
error:4, mess:'Указанный домен в почтовом ящике не найден в системе:<boxname>';
 
−
 
 
−
error:1000, mess:'У вас нет прав для администрирования этого пользователя';
 
−
 
 
−
error:1001, mess:'Такой пользователь отсутствует в ISP-панели'.
 
−
 
 
 
|-
 
|-
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
 
mailclient
 
mailclient
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top; width: 116px;" |  
−
Удаление почтового ящика.
+
Delete mail.
  
 
delmail
 
delmail
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top; width: 380px;" | <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">delmail (post) * - constant, type of operation;</div> <div data-placeholder="Перевод" dir="ltr">email (post) * - mailbox in userbox @ domain format;</div> <div data-placeholder="Перевод" dir="ltr">password (post) * - password for the mailbox;</div> <div data-placeholder="Перевод" dir="ltr">quota (post) * - quota;</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: 'Mailbox successfully deleted';</div> <div data-placeholder="Перевод" dir="ltr">error: 1, mess: 'Error deleting mailbox: <err_msg>';</div> <div data-placeholder="Перевод" dir="ltr">error: 2, mess: 'Error in the parameter array';</div> <div data-placeholder="Перевод" dir="ltr">error: 1000, mess: 'You do not have permission to administer this user';</div> <div data-placeholder="Перевод" dir="ltr">error: 1001, mess: 'There is no such user in the ISP-panel'.</div>
−
 
 
−
password (post)* — пароль пользователя;
 
−
 
 
−
mailclient (post)* — константа, имя модуля;
 
−
 
 
−
delmail (post)* — константа, тип операции;
 
−
 
 
−
email (post)* — почтовый ящик в формате userbox@domain;
 
−
 
 
−
password (post)* — пароль на почтовый ящик;
 
−
 
 
−
quota (post)* — квота;
 
−
 
 
−
language (post) — может принимать значение: en/ru (по умолчанию ru);
 
−
 
 
−
panel_user (post) — имя пользователя ISP, к которому применяется операция.
 
−
 
 
−
| style="vertical-align: top;" |  
 
−
error:0, mess:'Почтовый ящик успешно удален';
 
−
 
 
−
error:1, mess:'Ошибка удаления почтового ящика: <err_msg>';
 
−
 
 
−
error:2, mess:'Ошибка в массиве параметров';
 
−
 
 
−
error:1000, mess:'У вас нет прав для администрирования этого пользователя';
 
−
 
 
−
error:1001, mess:'Такой пользователь отсутствует в ISP-панели'.
 
−
 
 
 
|-
 
|-
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
 
mailclient
 
mailclient
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top; width: 116px;" |  
−
Добавление почтового перенаправления.
+
Add mail&nbsp;forwarding.
  
 
addforward
 
addforward
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top; width: 380px;" | <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">addforward (post) * - constant, type of operation;</div> <div data-placeholder="Перевод" dir="ltr">source - source mailbox in userbox @ domain format;</div> <div data-placeholder="Перевод" dir="ltr">target - the destination mailbox in the userbox @ domain format (you can specify several separated by commas);</div> <div data-placeholder="Перевод" dir="ltr">save_local - save forwarded mail.</div>
−
username (post)* — имя пользователя;
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'Mailbox forwarding was successfully defined: <source> => <target>';</div> <div data-placeholder="Перевод" dir="ltr">error: 1, mess: 'Mailbox forwarding error: <err_msg>';</div> <div data-placeholder="Перевод" dir="ltr">error: 2, mess: 'Error in the parameter array';</div> <div data-placeholder="Перевод" dir="ltr">error: 1000, mess: 'You do not have permission to administer this user';</div> <div data-placeholder="Перевод" dir="ltr">error: 1001, mess: 'There is no such user in the ISP-panel'.</div>
−
 
 
−
password (post)* — пароль пользователя;
 
−
 
 
−
mailclient (post)* — константа, имя модуля;
 
−
 
 
−
addforward (post)* — константа, тип операции;
 
−
 
 
−
source — исходный почтовый ящик в формате userbox@domain;
 
−
 
 
−
target — почтовый ящик назначения в формате userbox@domain (можно указать несколько через запятую);
 
−
 
 
−
save_local — сохранять перенаправляемую почту.
 
−
 
 
−
| style="vertical-align: top;" |  
 
−
error:0, mess:'Перенаправление почтового ящика успешно определено: <source> => <target>';
 
−
 
 
−
error:1, mess:'Ошибка перенаправления почтового ящика: <err_msg>';
 
−
 
 
−
error:2, mess:'Ошибка в массиве параметров';
 
−
 
 
−
error:1000, mess:'У вас нет прав для администрирования этого пользователя';
 
−
 
 
−
error:1001, mess:'Такой пользователь отсутствует в ISP-панели'.
 
−
 
 
 
|-
 
|-
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
 
mailclient
 
mailclient
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top; width: 116px;" |  
−
Удаление почтового перенаправления.
+
Delete mail forwarding.
  
 
delforward
 
delforward
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top; width: 380px;" | <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">delforward (post) * - constant, type of operation;</div> <div data-placeholder="Перевод" dir="ltr">source - source mailbox in userbox @ domain format;</div> <div data-placeholder="Перевод" dir="ltr">target - the destination mailbox in the userbox @ domain format (you can specify several separated by commas).</div>
−
username (post)* — имя пользователя;
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'Mailbox forwarding was deleted';</div> <div data-placeholder="Перевод" dir="ltr">error: 1, mess: 'Error deleting mailbox forwarding: <err_msg>';</div> <div data-placeholder="Перевод" dir="ltr">error: 2, mess: 'Error in the parameter array';</div> <div data-placeholder="Перевод" dir="ltr">error: 1000, mess: 'You do not have permission to administer this user';</div> <div data-placeholder="Перевод" dir="ltr">error: 1001, mess: 'There is no such user in the ISP-panel'.</div>
−
 
 
−
password (post)* — пароль пользователя;
 
−
 
 
−
mailclient (post)* — константа, имя модуля;
 
−
 
 
−
delforward (post)* — константа, тип операции;
 
−
 
 
−
source — исходный почтовый ящик в формате userbox@domain;
 
−
 
 
−
target — почтовый ящик назначения в формате userbox@domain (можно указать несколько через запятую).
 
−
 
 
−
| style="vertical-align: top;" |  
 
−
error:0, mess:'Перенаправление почтового ящика было удалено';
 
−
 
 
−
error:1, mess:'Ошибка удаления перенаправления почтового ящика: <err_msg>';
 
−
 
 
−
error:2, mess:'Ошибка в массиве параметров';
 
−
 
 
−
error:1000, mess:'У вас нет прав для администрирования этого пользователя';
 
−
 
 
−
error:1001, mess:'Такой пользователь отсутствует в ISP-панели'.
 
−
 
 
 
|-
 
|-
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
 
mailclient
 
mailclient
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top; width: 116px;" |  
−
Включить spf-запись для домена.
+
Enable spf-reecord&nbsp;for domain.
  
 
onspf
 
onspf
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top; width: 380px;" | <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">onspf (post) * - constant, type of operation;</div> <div data-placeholder="Перевод" dir="ltr">domain - domain name.</div>
−
username (post)* — имя пользователя;
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'Entry for domain is enabled';</div> <div data-placeholder="Перевод" dir="ltr">error: 1, mess: 'Error in the parameter array';</div> <div data-placeholder="Перевод" dir="ltr">error: 2, mess: 'Error enabling SPF record for domain <domen>';</div> <div data-placeholder="Перевод" dir="ltr">error: 3, mess: 'SPF is already enabled for domain: <domen>'.</div>
−
 
 
−
password (post)* — пароль пользователя;
 
−
 
 
−
mailclient (post)* — константа, имя модуля;
 
−
 
 
−
onspf (post)* — константа, тип операции;
 
−
 
 
−
domain — имя домена.
 
−
 
 
−
| style="vertical-align: top;" |  
 
−
error:0, mess:'Запись для домена включена';
 
−
 
 
−
error:1, mess:'Ошибка в массиве параметров';
 
−
 
 
−
error:2, mess:'Ошибка включения записи SPF для домена <domen>';
 
−
 
 
−
error:3, mess:'SPF уже включен для домена: <domen>'.
 
−
 
 
 
|-
 
|-
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
 
mailclient
 
mailclient
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top; width: 116px;" |  
−
Отключить spf запись для домена.
+
Disable&nbsp;spf record for domain.
  
 
offspf
 
offspf
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top; width: 380px;" | <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">offspf (post) * - constant, type of operation;</div> <div data-placeholder="Перевод" dir="ltr">domain - domain name.</div>
−
username (post)* — имя пользователя;
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'The record is disabled for the domain';</div> <div data-placeholder="Перевод" dir="ltr">error: 1, mess: 'Error in the parameter array';</div> <div data-placeholder="Перевод" dir="ltr">error: 2, mess: 'Error disabling SPF record for domain <domen>';</div> <div data-placeholder="Перевод" dir="ltr">error: 3, mess: 'SPF is already disabled for domain: <domen>'.</div>
−
 
 
−
password (post)* — пароль пользователя;
 
−
 
 
−
mailclient (post)* — константа, имя модуля;
 
−
 
 
−
offspf (post)* — константа, тип операции;
 
−
 
 
−
domain — имя домена.
 
−
 
 
−
| style="vertical-align: top;" |  
 
−
error:0, mess:'Запись для домена выключена';
 
−
 
 
−
error:1, mess:'Ошибка в массиве параметров';
 
−
 
 
−
error:2, mess:'Ошибка отключения записи SPF для домена <domen>';
 
−
 
 
−
error:3, mess:'SPF уже выключен для домена: <domen>'.
 
−
 
 
 
|-
 
|-
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
 
mailclient
 
mailclient
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top; width: 116px;" |  
−
Включить dkim запись для домена.
+
Enable dkim record for domain.
  
 
ondkim
 
ondkim
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top; width: 380px;" | <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">ondkim (post) * - constant, operation type;</div> <div data-placeholder="Перевод" dir="ltr">domain - domain name.</div>
−
username (post)* — имя пользователя;
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'Entry for domain is enabled';</div> <div data-placeholder="Перевод" dir="ltr">error: 1, mess: 'Error in the parameter array';</div> <div data-placeholder="Перевод" dir="ltr">error: 2, mess: 'Error enabling dkim record for domain <domen>';</div> <div data-placeholder="Перевод" dir="ltr">error: 3, mess: 'dkim is already enabled for domain: <domen>'.</div>
−
 
 
−
password (post)* — пароль пользователя;
 
−
 
 
−
mailclient (post)* — константа, имя модуля;
 
−
 
 
−
ondkim (post)* — константа, тип операции;
 
−
 
 
−
domain — имя домена.
 
−
 
 
−
| style="vertical-align: top;" |  
 
−
error:0, mess:'Запись для домена включена';
 
−
 
 
−
error:1, mess:'Ошибка в массиве параметров';
 
−
 
 
−
error:2, mess:'Ошибка включения dkim записи для домена <domen>';
 
−
 
 
−
error:3, mess:'dkim уже включен для домена: <domen>'.
 
−
 
 
 
|-
 
|-
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
 
mailclient
 
mailclient
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top; width: 116px;" |  
−
Отключить dkim запись для домена.
+
Disable dkim record for domain.
  
 
offdkim
 
offdkim
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top; width: 380px;" | <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">offdkim (post) * - constant, operation type;</div> <div data-placeholder="Перевод" dir="ltr">domain - domain name.</div>
−
username (post)* — имя пользователя;
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'The record is disabled for the domain';</div> <div data-placeholder="Перевод" dir="ltr">error: 1, mess: 'Error in the parameter array';</div> <div data-placeholder="Перевод" dir="ltr">error: 2, mess: 'Error disabling Dkim record for domain <domen>';</div> <div data-placeholder="Перевод" dir="ltr">error: 3, mess: 'Dkim is already disabled for domain: <domen>'.</div>
−
 
 
−
password (post)* — пароль пользователя;
 
−
 
 
−
mailclient (post)* — константа, имя модуля;
 
−
 
 
−
offdkim (post)* — константа, тип операции;
 
−
 
 
−
domain — имя домена.
 
−
 
 
−
| style="vertical-align: top;" |  
 
−
error:0, mess:'Запись для домена выключена';
 
−
 
 
−
error:1, mess:'Ошибка в массиве параметров';
 
−
 
 
−
error:2, mess:'Ошибка отключения записи Dkim для домена <domen>';
 
−
 
 
−
error:3, mess:'Dkim уже выключен для домена: <domen>'.
 
−
 
 
 
|}
 
|}
  
−
Другие полезные статьи:
+
Other useful articles:
  
−
{| style="width: 1191px;"
+
{| style="width: 1135px;"
 
|-
 
|-
−
|  
+
| style="width: 323px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_подключение API: подключение]'''
+
'''[https://docs.brainycp.io/index.php/API:_connection <font><font>API: connection</font></font>]'''
  
−
|  
+
| style="width: 396px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_мониторинг API: мониторинг]'''
+
'''[https://docs.brainycp.io/index.php/API:_Monitoring <font><font>API: monitoring</font></font>]'''
  
−
|  
+
| style="width: 394px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_статус_веб-сервера API: статус веб-сервера]'''
+
'''[https://docs.brainycp.io/index.php/API:_Webserver_status <font><font>API: web server status</font></font>]'''
  
 
|-
 
|-
−
|  
+
| style="width: 323px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_автоустановщик_CMS API: автоустановщик CMS]'''
+
'''[https://docs.brainycp.io/index.php/API:_CMS_Autoinstaller <font><font>API: auto installer CMS</font></font>]'''
  
−
|  
+
| style="width: 396px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_настройка_бекапов API: настройка бекапов]'''
+
'''[https://docs.brainycp.io/index.php/API:_Configuring_backups <font><font>API: configuring backups</font></font>]'''
  
−
|  
+
| style="width: 394px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_трансфер_между_серверами API: трансфер между серверами]'''
+
'''[https://docs.brainycp.io/index.php/API:_Transfer_between_servers <font><font>API: transfer between servers</font></font>]'''
  
 
|-
 
|-
−
|  
+
| style="width: 323px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_антивирус API: антивирус]'''
+
'''[https://docs.brainycp.io/index.php/API:_Antivirus <font><font>API: antivirus</font></font>]'''
  
−
|  
+
| style="width: 396px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_настройки_сервера API: настройки сервера]'''
+
'''[https://docs.brainycp.io/index.php/API:_Server_configuration <font><font>API: server settings</font></font>]'''
  
−
|  
+
| style="width: 394px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_управление_веб-сервером API: управление веб-сервером]'''
+
'''[https://docs.brainycp.io/index.php/API:_Manage_webserver <font><font>API: web server management</font></font>]'''
  
 
|-
 
|-
−
|  
+
| style="width: 323px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_базы_данных API: базы данных]'''
+
'''[https://docs.brainycp.io/index.php/API:_Databases <font><font>API: database</font></font>]'''
  
−
|  
+
| style="width: 396px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_пользовательские_сертификаты API: пользовательские сертификаты]'''
+
'''[https://docs.brainycp.io/index.php/API:_User_Certificates <font><font>API: custom certificates</font></font>]'''
  
−
|  
+
| style="width: 394px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_управление_почтовыми_ящиками API: управление почтовыми ящиками]'''
+
'''[https://docs.brainycp.io/index.php/API:_Managing_mailboxes <font><font>API: mailbox management</font></font>]'''
  
 
|-
 
|-
−
|  
+
| style="width: 323px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_информация_о_сервере API: информация о сервере]'''
+
'''[https://docs.brainycp.io/index.php/API:_Server_info <font><font>API: server information</font></font>]'''
  
−
|  
+
| style="width: 396px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_почта API: почта]'''
+
'''[https://docs.brainycp.io/index.php/API:_Mail <font><font>API: mail</font></font>]'''
  
−
|  
+
| style="width: 394px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_управление_DNS-зонами API: управление DNS-зонами]'''
+
'''[https://docs.brainycp.io/index.php/API:_Manage_DNS-zones <font><font>API: DNS zone management</font></font>]'''
  
 
|-
 
|-
−
|  
+
| style="width: 323px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_использование_трафика API: использование трафика]'''
+
'''[https://docs.brainycp.io/index.php/API:_Traffic_usage <font><font>API: traffic usage</font></font>]'''
  
−
|  
+
| style="width: 396px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_почтовые_ящики_клиента API: почтовые ящики клиента]'''
+
'''[https://docs.brainycp.io/index.php/API:_Client_mail <font><font>API: client mailboxes</font></font>]'''
  
−
|  
+
| style="width: 394px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_установка_веб-сервера API: установка веб-сервера]'''
+
'''[https://docs.brainycp.io/index.php/API:_Webserver_Installation <font><font>API: web server installation</font></font>]'''
  
 
|-
 
|-
−
|  
+
| style="width: 323px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_логирование API: логирование]'''
+
'''[https://docs.brainycp.io/index.php/API:_Logging <font><font>API: logging</font></font>]'''
  
−
|  
+
| style="width: 396px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_сервер_имен API: сервер имен]'''
+
'''[https://docs.brainycp.io/index.php/API:_Nameserver <font><font>API: name server</font></font>]'''
  
−
|  
+
| style="width: 394px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_хост-аккаунты API: хост-аккаунты]'''
+
'''[https://docs.brainycp.io/index.php/API:_host-accounts <font><font>API: host accounts</font></font>]'''
  
 
|-
 
|-
−
|  
+
| style="width: 323px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_менеджер_приложений API: менеджер приложений]'''
+
'''[https://docs.brainycp.io/index.php/API:_App_manager <font><font>API: application manager</font></font>]'''
  
−
|  
+
| style="width: 396px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_сертификаты_сервисов API: сертификаты сервисов]'''
+
'''[https://docs.brainycp.io/index.php/API:_Certificates_of_services <font><font>API: service certificates</font></font>]'''
  
−
|  
+
| style="width: 394px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_CRON API: CRON]'''
+
'''[https://docs.brainycp.io/index.php/API:_CRON <font><font>API: CRON</font></font>]'''
  
 
|-
 
|-
−
|  
+
| style="width: 323px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_менеджер_процессов API: менеджер процессов]'''
+
'''[https://docs.brainycp.io/index.php/API:_Process_manager <font><font>API: process manager</font></font>]'''
  
−
|  
+
| style="width: 396px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_сетевые_инструменты API: сетевые инструменты]'''
+
'''[https://docs.brainycp.io/index.php/API:_Network_tools <font><font>API: network tools</font></font>]'''
  
−
|  
+
| style="width: 394px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_FTP-сервер API: FTP-сервер]'''
+
'''[https://docs.brainycp.io/index.php/API:_FTP-server <font><font>API: FTP server</font></font>]'''
  
 
|-
 
|-
−
|  
+
| style="width: 323px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_менеджер_IP-адресов API: менеджер IP-адресов]'''
+
'''[https://docs.brainycp.io/index.php/API:_IP-address_manager <font><font>API: IP address manager</font></font>]'''
  
−
|  
+
| style="width: 396px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_средняя_нагрузка API: средняя нагрузка]'''
+
'''[https://docs.brainycp.io/index.php/API:_Load_average <font><font>API: average load</font></font>]'''
  
−
|  
+
| style="width: 394px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_MySQL_processlist API: MySQL processlist]'''
+
'''[https://docs.brainycp.io/index.php/API:_MySQL_processlist <font><font>API: MySQL processlist</font></font>]'''
  
 
|}
 
|}

Latest revision as of 14:37, 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

Add mail.

addmail

username (post) * - username;
password (post) * - user password;
mailclient (post) * - constant, module name;
addmail (post) * - constant, type of operation;
email (post) * - mailbox in userbox @ domain format;
password (post) * - password for the mailbox;
quota (post) * - quota;
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: 'Mailbox added successfully: <boxname>';
error: 1, mess: 'This mailbox already exists: <boxname>';
error: 2, mess: 'Error in the parameter array';
error: 3, mess: 'An error occurred while adding mailbox: <boxname>';
error: 4, mess: 'The specified domain in the mailbox was not found in the system: <boxname>';
error: 1000, mess: 'You do not have permission to administer this user';
error: 1001, mess: 'There is no such user in the ISP-panel'.

mailclient

Delete mail.

delmail

username (post) * - username;
password (post) * - user password;
mailclient (post) * - constant, module name;
delmail (post) * - constant, type of operation;
email (post) * - mailbox in userbox @ domain format;
password (post) * - password for the mailbox;
quota (post) * - quota;
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: 'Mailbox successfully deleted';
error: 1, mess: 'Error deleting mailbox: <err_msg>';
error: 2, mess: 'Error in the parameter array';
error: 1000, mess: 'You do not have permission to administer this user';
error: 1001, mess: 'There is no such user in the ISP-panel'.

mailclient

Add mail forwarding.

addforward

username (post) * - username;
password (post) * - user password;
mailclient (post) * - constant, module name;
addforward (post) * - constant, type of operation;
source - source mailbox in userbox @ domain format;
target - the destination mailbox in the userbox @ domain format (you can specify several separated by commas);
save_local - save forwarded mail.
error: 0, mess: 'Mailbox forwarding was successfully defined: <source> => <target>';
error: 1, mess: 'Mailbox forwarding error: <err_msg>';
error: 2, mess: 'Error in the parameter array';
error: 1000, mess: 'You do not have permission to administer this user';
error: 1001, mess: 'There is no such user in the ISP-panel'.

mailclient

Delete mail forwarding.

delforward

username (post) * - username;
password (post) * - user password;
mailclient (post) * - constant, module name;
delforward (post) * - constant, type of operation;
source - source mailbox in userbox @ domain format;
target - the destination mailbox in the userbox @ domain format (you can specify several separated by commas).
error: 0, mess: 'Mailbox forwarding was deleted';
error: 1, mess: 'Error deleting mailbox forwarding: <err_msg>';
error: 2, mess: 'Error in the parameter array';
error: 1000, mess: 'You do not have permission to administer this user';
error: 1001, mess: 'There is no such user in the ISP-panel'.

mailclient

Enable spf-reecord for domain.

onspf

username (post) * - username;
password (post) * - user password;
mailclient (post) * - constant, module name;
onspf (post) * - constant, type of operation;
domain - domain name.
error: 0, mess: 'Entry for domain is enabled';
error: 1, mess: 'Error in the parameter array';
error: 2, mess: 'Error enabling SPF record for domain <domen>';
error: 3, mess: 'SPF is already enabled for domain: <domen>'.

mailclient

Disable spf record for domain.

offspf

username (post) * - username;
password (post) * - user password;
mailclient (post) * - constant, module name;
offspf (post) * - constant, type of operation;
domain - domain name.
error: 0, mess: 'The record is disabled for the domain';
error: 1, mess: 'Error in the parameter array';
error: 2, mess: 'Error disabling SPF record for domain <domen>';
error: 3, mess: 'SPF is already disabled for domain: <domen>'.

mailclient

Enable dkim record for domain.

ondkim

username (post) * - username;
password (post) * - user password;
mailclient (post) * - constant, module name;
ondkim (post) * - constant, operation type;
domain - domain name.
error: 0, mess: 'Entry for domain is enabled';
error: 1, mess: 'Error in the parameter array';
error: 2, mess: 'Error enabling dkim record for domain <domen>';
error: 3, mess: 'dkim is already enabled for domain: <domen>'.

mailclient

Disable dkim record for domain.

offdkim

username (post) * - username;
password (post) * - user password;
mailclient (post) * - constant, module name;
offdkim (post) * - constant, operation type;
domain - domain name.
error: 0, mess: 'The record is disabled for the domain';
error: 1, mess: 'Error in the parameter array';
error: 2, mess: 'Error disabling Dkim record for domain <domen>';
error: 3, mess: 'Dkim is already disabled for domain: <domen>'.

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:_Managing_mailboxes&oldid=1942"