View source for API: Managing mailboxes


&nbsp;
<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> 
{| border="1" cellpadding="5"
|-
| <p dir="ltr" style="text-align: center;">'''Module'''</p> 
| style="width: 116px;" | <p dir="ltr" style="text-align: center;">'''Function'''</p> 
| style="width: 380px;" | <p dir="ltr" style="text-align: center;">'''Incoming data'''</p> 
| <p dir="ltr" style="text-align: center;">'''Error variants'''</p> 
|-
| style="vertical-align: top;" | 
mailclient

| style="vertical-align: top; width: 116px;" | 
Add mail.

addmail

| 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> 
| 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> 
|-
| style="vertical-align: top;" | 
mailclient

| style="vertical-align: top; width: 116px;" | 
Delete mail.

delmail

| 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> 
| 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> 
|-
| style="vertical-align: top;" | 
mailclient

| style="vertical-align: top; width: 116px;" | 
Add mail&nbsp;forwarding.

addforward

| 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> 
| 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> 
|-
| style="vertical-align: top;" | 
mailclient

| style="vertical-align: top; width: 116px;" | 
Delete mail forwarding.

delforward

| 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> 
| 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> 
|-
| style="vertical-align: top;" | 
mailclient

| style="vertical-align: top; width: 116px;" | 
Enable spf-reecord&nbsp;for domain.

onspf

| 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> 
| 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> 
|-
| style="vertical-align: top;" | 
mailclient

| style="vertical-align: top; width: 116px;" | 
Disable&nbsp;spf record for domain.

offspf

| 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> 
| 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> 
|-
| style="vertical-align: top;" | 
mailclient

| style="vertical-align: top; width: 116px;" | 
Enable dkim record for domain.

ondkim

| 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> 
| 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> 
|-
| style="vertical-align: top;" | 
mailclient

| style="vertical-align: top; width: 116px;" | 
Disable dkim record for domain.

offdkim

| 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> 
| 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> 
|}

Other useful articles:

{| style="width: 1144px;"
|-
| style="width: 325px;" | 
'''[https://docs.brainycp.io/index.php/API:_подключение <font><font>API: connection</font></font>]'''

| style="width: 414px;" | 
'''[https://docs.brainycp.io/index.php/API:_мониторинг <font><font>API: monitoring</font></font>]'''

| style="width: 383px;" | 
'''[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 <font><font>API: auto installer CMS</font></font>]'''

| style="width: 414px;" | 
'''[https://docs.brainycp.io/index.php/API:_настройка_бекапов <font><font>API: configuring backups</font></font>]'''

| style="width: 383px;" | 
'''[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:_антивирус <font><font>API: antivirus</font></font>]'''

| style="width: 414px;" | 
'''[https://docs.brainycp.io/index.php/API:_настройки_сервера <font><font>API: server settings</font></font>]'''

| style="width: 383px;" | 
'''[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:_базы_данных <font><font>API: database</font></font>]'''

| style="width: 414px;" | 
'''[https://docs.brainycp.io/index.php/API:_пользовательские_сертификаты <font><font>API: custom certificates</font></font>]'''

| style="width: 383px;" | 
'''[https://docs.brainycp.io/index.php/API:_управление_почтовыми_ящиками <font><font>API: mailbox management</font></font>]'''

|-
| style="width: 325px;" | 
'''[https://docs.brainycp.io/index.php/API:_информация_о_сервере <font><font>API: server information</font></font>]'''

| style="width: 414px;" | 
'''[https://docs.brainycp.io/index.php/API:_почта <font><font>API: mail</font></font>]'''

| style="width: 383px;" | 
'''[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:_использование_трафика <font><font>API: traffic usage</font></font>]'''

| style="width: 414px;" | 
'''[https://docs.brainycp.io/index.php/API:_почтовые_ящики_клиента <font><font>API: client mailboxes</font></font>]'''

| style="width: 383px;" | 
'''[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:_логирование <font><font>API: logging</font></font>]'''

| style="width: 414px;" | 
'''[https://docs.brainycp.io/index.php/API:_сервер_имен <font><font>API: name server</font></font>]'''

| style="width: 383px;" | 
'''[https://docs.brainycp.io/index.php/API:_хост-аккаунты <font><font>API: host accounts</font></font>]'''

|-
| style="width: 325px;" | 
'''[https://docs.brainycp.io/index.php/API:_менеджер_приложений <font><font>API: application manager</font></font>]'''

| style="width: 414px;" | 
'''[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 <font><font>API: CRON</font></font>]'''

|-
| style="width: 325px;" | 
'''[https://docs.brainycp.io/index.php/API:_менеджер_процессов <font><font>API: process manager</font></font>]'''

| style="width: 414px;" | 
'''[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-сервер <font><font>API: FTP server</font></font>]'''

|-
| style="width: 325px;" | 
'''[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:_средняя_нагрузка <font><font>API: average load</font></font>]'''

| style="width: 383px;" | 
'''[https://docs.brainycp.io/index.php/API:_MySQL_processlist <font><font>API: MySQL processlist</font></font>]'''

|}