Difference between revisions of "API: Managing mailboxes"

From BrainyCP
Jump to: navigation, search
m (Protected "API: Managing mailboxes" ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite)))
Line 100: Line 100:
 
Other useful articles:
 
Other useful articles:
  
−
{| style="width: 1191px;"
+
{| style="width: 1144px;"
 
|-
 
|-
−
|  
+
| style="width: 325px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_подключение API: подключение]'''
+
'''[https://docs.brainycp.io/index.php/API:_подключение <font><font>API: connection</font></font>]'''
  
−
|  
+
| style="width: 414px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_мониторинг API: мониторинг]'''
+
'''[https://docs.brainycp.io/index.php/API:_мониторинг <font><font>API: monitoring</font></font>]'''
  
−
|  
+
| style="width: 383px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_статус_веб-сервера API: статус веб-сервера]'''
+
'''[https://docs.brainycp.io/index.php/API:_статус_веб-сервера <font><font>API: web server status</font></font>]'''
  
 
|-
 
|-
−
|  
+
| style="width: 325px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_автоустановщик_CMS API: автоустановщик CMS]'''
+
'''[https://docs.brainycp.io/index.php/API:_автоустановщик_CMS <font><font>API: auto installer CMS</font></font>]'''
  
−
|  
+
| style="width: 414px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_настройка_бекапов API: настройка бекапов]'''
+
'''[https://docs.brainycp.io/index.php/API:_настройка_бекапов <font><font>API: configuring backups</font></font>]'''
  
−
|  
+
| style="width: 383px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_трансфер_между_серверами API: трансфер между серверами]'''
+
'''[https://docs.brainycp.io/index.php/API:_трансфер_между_серверами <font><font>API: transfer between servers</font></font>]'''
  
 
|-
 
|-
−
|  
+
| style="width: 325px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_антивирус API: антивирус]'''
+
'''[https://docs.brainycp.io/index.php/API:_антивирус <font><font>API: antivirus</font></font>]'''
  
−
|  
+
| style="width: 414px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_настройки_сервера API: настройки сервера]'''
+
'''[https://docs.brainycp.io/index.php/API:_настройки_сервера <font><font>API: server settings</font></font>]'''
  
−
|  
+
| style="width: 383px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_управление_веб-сервером API: управление веб-сервером]'''
+
'''[https://docs.brainycp.io/index.php/API:_управление_веб-сервером <font><font>API: web server management</font></font>]'''
  
 
|-
 
|-
−
|  
+
| style="width: 325px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_базы_данных API: базы данных]'''
+
'''[https://docs.brainycp.io/index.php/API:_базы_данных <font><font>API: database</font></font>]'''
  
−
|  
+
| style="width: 414px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_пользовательские_сертификаты API: пользовательские сертификаты]'''
+
'''[https://docs.brainycp.io/index.php/API:_пользовательские_сертификаты <font><font>API: custom certificates</font></font>]'''
  
−
|  
+
| style="width: 383px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_управление_почтовыми_ящиками API: управление почтовыми ящиками]'''
+
'''[https://docs.brainycp.io/index.php/API:_управление_почтовыми_ящиками <font><font>API: mailbox management</font></font>]'''
  
 
|-
 
|-
−
|  
+
| style="width: 325px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_информация_о_сервере API: информация о сервере]'''
+
'''[https://docs.brainycp.io/index.php/API:_информация_о_сервере <font><font>API: server information</font></font>]'''
  
−
|  
+
| style="width: 414px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_почта API: почта]'''
+
'''[https://docs.brainycp.io/index.php/API:_почта <font><font>API: mail</font></font>]'''
  
−
|  
+
| style="width: 383px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_управление_DNS-зонами API: управление DNS-зонами]'''
+
'''[https://docs.brainycp.io/index.php/API:_управление_DNS-зонами <font><font>API: DNS zone management</font></font>]'''
  
 
|-
 
|-
−
|  
+
| style="width: 325px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_использование_трафика API: использование трафика]'''
+
'''[https://docs.brainycp.io/index.php/API:_использование_трафика <font><font>API: traffic usage</font></font>]'''
  
−
|  
+
| style="width: 414px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_почтовые_ящики_клиента API: почтовые ящики клиента]'''
+
'''[https://docs.brainycp.io/index.php/API:_почтовые_ящики_клиента <font><font>API: client mailboxes</font></font>]'''
  
−
|  
+
| style="width: 383px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_установка_веб-сервера API: установка веб-сервера]'''
+
'''[https://docs.brainycp.io/index.php/API:_установка_веб-сервера <font><font>API: web server installation</font></font>]'''
  
 
|-
 
|-
−
|  
+
| style="width: 325px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_логирование API: логирование]'''
+
'''[https://docs.brainycp.io/index.php/API:_логирование <font><font>API: logging</font></font>]'''
  
−
|  
+
| style="width: 414px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_сервер_имен API: сервер имен]'''
+
'''[https://docs.brainycp.io/index.php/API:_сервер_имен <font><font>API: name server</font></font>]'''
  
−
|  
+
| style="width: 383px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_хост-аккаунты API: хост-аккаунты]'''
+
'''[https://docs.brainycp.io/index.php/API:_хост-аккаунты <font><font>API: host accounts</font></font>]'''
  
 
|-
 
|-
−
|  
+
| style="width: 325px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_менеджер_приложений API: менеджер приложений]'''
+
'''[https://docs.brainycp.io/index.php/API:_менеджер_приложений <font><font>API: application manager</font></font>]'''
  
−
|  
+
| style="width: 414px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_сертификаты_сервисов API: сертификаты сервисов]'''
+
'''[https://docs.brainycp.io/index.php/API:_сертификаты_сервисов <font><font>API: service certificates</font></font>]'''
  
−
|  
+
| style="width: 383px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_CRON API: CRON]'''
+
'''[https://docs.brainycp.io/index.php/API:_CRON <font><font>API: CRON</font></font>]'''
  
 
|-
 
|-
−
|  
+
| style="width: 325px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_менеджер_процессов API: менеджер процессов]'''
+
'''[https://docs.brainycp.io/index.php/API:_менеджер_процессов <font><font>API: process manager</font></font>]'''
  
−
|  
+
| style="width: 414px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_сетевые_инструменты API: сетевые инструменты]'''
+
'''[https://docs.brainycp.io/index.php/API:_сетевые_инструменты <font><font>API: network tools</font></font>]'''
  
−
|  
+
| style="width: 383px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_FTP-сервер API: FTP-сервер]'''
+
'''[https://docs.brainycp.io/index.php/API:_FTP-сервер <font><font>API: FTP server</font></font>]'''
  
 
|-
 
|-
−
|  
+
| style="width: 325px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_менеджер_IP-адресов API: менеджер IP-адресов]'''
+
'''[https://docs.brainycp.io/index.php/API:_менеджер_IP-адресов <font><font>API: IP address manager</font></font>]'''
  
−
|  
+
| style="width: 414px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_средняя_нагрузка API: средняя нагрузка]'''
+
'''[https://docs.brainycp.io/index.php/API:_средняя_нагрузка <font><font>API: average load</font></font>]'''
  
−
|  
+
| style="width: 383px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_MySQL_processlist API: MySQL processlist]'''
+
'''[https://docs.brainycp.io/index.php/API:_MySQL_processlist <font><font>API: MySQL processlist</font></font>]'''
  
 
|}
 
|}

Revision as of 12:24, 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=1888"