Difference between revisions of "API: Mail"
From BrainyCP
m (Protected "API: Mail" ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))) |
|||
| Line 75: | Line 75: | ||
Другие полезные статьи: | Другие полезные статьи: | ||
| − | {| style="width: | + | {| style="width: 928px;" |
|- | |- | ||
| − | | | + | | style="width: 277px;" | |
| − | '''[https://docs.brainycp.io/index.php/API:_подключение API: | + | '''[https://docs.brainycp.io/index.php/API:_подключение <font><font>API: connection</font></font>]''' |
| − | | | + | | style="width: 301px;" | |
| − | '''[https://docs.brainycp.io/index.php/API:_мониторинг API: | + | '''[https://docs.brainycp.io/index.php/API:_мониторинг <font><font>API: monitoring</font></font>]''' |
| − | | | + | | style="width: 327px;" | |
| − | '''[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: 277px;" | |
| − | '''[https://docs.brainycp.io/index.php/API:_автоустановщик_CMS API: | + | '''[https://docs.brainycp.io/index.php/API:_автоустановщик_CMS <font><font>API: auto installer CMS</font></font>]''' |
| − | | | + | | style="width: 301px;" | |
| − | '''[https://docs.brainycp.io/index.php/API:_настройка_бекапов API: | + | '''[https://docs.brainycp.io/index.php/API:_настройка_бекапов <font><font>API: configuring backups</font></font>]''' |
| − | | | + | | style="width: 327px;" | |
| − | '''[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: 277px;" | |
| − | '''[https://docs.brainycp.io/index.php/API:_антивирус API: | + | '''[https://docs.brainycp.io/index.php/API:_антивирус <font><font>API: antivirus</font></font>]''' |
| − | | | + | | style="width: 301px;" | |
| − | '''[https://docs.brainycp.io/index.php/API:_настройки_сервера API: | + | '''[https://docs.brainycp.io/index.php/API:_настройки_сервера <font><font>API: server settings</font></font>]''' |
| − | | | + | | style="width: 327px;" | |
| − | '''[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: 277px;" | |
| − | '''[https://docs.brainycp.io/index.php/API:_базы_данных API: | + | '''[https://docs.brainycp.io/index.php/API:_базы_данных <font><font>API: database</font></font>]''' |
| − | | | + | | style="width: 301px;" | |
| − | '''[https://docs.brainycp.io/index.php/API:_пользовательские_сертификаты API: | + | '''[https://docs.brainycp.io/index.php/API:_пользовательские_сертификаты <font><font>API: custom certificates</font></font>]''' |
| − | | | + | | style="width: 327px;" | |
| − | '''[https://docs.brainycp.io/index.php/API:_управление_почтовыми_ящиками API: | + | '''[https://docs.brainycp.io/index.php/API:_управление_почтовыми_ящиками <font><font>API: mailbox management</font></font>]''' |
|- | |- | ||
| − | | | + | | style="width: 277px;" | |
| − | '''[https://docs.brainycp.io/index.php/API:_информация_о_сервере API: | + | '''[https://docs.brainycp.io/index.php/API:_информация_о_сервере <font><font>API: server information</font></font>]''' |
| − | | | + | | style="width: 301px;" | |
| − | '''[https://docs.brainycp.io/index.php/API:_почта API: | + | '''[https://docs.brainycp.io/index.php/API:_почта <font><font>API: mail</font></font>]''' |
| − | | | + | | style="width: 327px;" | |
| − | '''[https://docs.brainycp.io/index.php/API:_управление_DNS-зонами API: | + | '''[https://docs.brainycp.io/index.php/API:_управление_DNS-зонами <font><font>API: DNS zone management</font></font>]''' |
|- | |- | ||
| − | | | + | | style="width: 277px;" | |
| − | '''[https://docs.brainycp.io/index.php/API:_использование_трафика API: | + | '''[https://docs.brainycp.io/index.php/API:_использование_трафика <font><font>API: traffic usage</font></font>]''' |
| − | | | + | | style="width: 301px;" | |
| − | '''[https://docs.brainycp.io/index.php/API:_почтовые_ящики_клиента API: | + | '''[https://docs.brainycp.io/index.php/API:_почтовые_ящики_клиента <font><font>API: client mailboxes</font></font>]''' |
| − | | | + | | style="width: 327px;" | |
| − | '''[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: 277px;" | |
| − | '''[https://docs.brainycp.io/index.php/API:_логирование API: | + | '''[https://docs.brainycp.io/index.php/API:_логирование <font><font>API: logging</font></font>]''' |
| − | | | + | | style="width: 301px;" | |
| − | '''[https://docs.brainycp.io/index.php/API:_сервер_имен API: | + | '''[https://docs.brainycp.io/index.php/API:_сервер_имен <font><font>API: name server</font></font>]''' |
| − | | | + | | style="width: 327px;" | |
| − | '''[https://docs.brainycp.io/index.php/API:_хост-аккаунты API: | + | '''[https://docs.brainycp.io/index.php/API:_хост-аккаунты <font><font>API: host accounts</font></font>]''' |
|- | |- | ||
| − | | | + | | style="width: 277px;" | |
| − | '''[https://docs.brainycp.io/index.php/API:_менеджер_приложений API: | + | '''[https://docs.brainycp.io/index.php/API:_менеджер_приложений <font><font>API: application manager</font></font>]''' |
| − | | | + | | style="width: 301px;" | |
| − | '''[https://docs.brainycp.io/index.php/API:_сертификаты_сервисов API: | + | '''[https://docs.brainycp.io/index.php/API:_сертификаты_сервисов <font><font>API: service certificates</font></font>]''' |
| − | | | + | | style="width: 327px;" | |
| − | '''[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: 277px;" | |
| − | '''[https://docs.brainycp.io/index.php/API:_менеджер_процессов API: | + | '''[https://docs.brainycp.io/index.php/API:_менеджер_процессов <font><font>API: process manager</font></font>]''' |
| − | | | + | | style="width: 301px;" | |
| − | '''[https://docs.brainycp.io/index.php/API:_сетевые_инструменты API: | + | '''[https://docs.brainycp.io/index.php/API:_сетевые_инструменты <font><font>API: network tools</font></font>]''' |
| − | | | + | | style="width: 327px;" | |
| − | '''[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: 277px;" | |
| − | '''[https://docs.brainycp.io/index.php/API:_менеджер_IP-адресов API: | + | '''[https://docs.brainycp.io/index.php/API:_менеджер_IP-адресов <font><font>API: IP address manager</font></font>]''' |
| − | | | + | | style="width: 301px;" | |
| − | '''[https://docs.brainycp.io/index.php/API:_средняя_нагрузка API: | + | '''[https://docs.brainycp.io/index.php/API:_средняя_нагрузка <font><font>API: average load</font></font>]''' |
| − | | | + | | style="width: 327px;" | |
| − | '''[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:08, 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 |
|
mailserver |
Mail queue view. list_msg |
username (post or get) * - username; password (post or get) * - user password; mailserver (post or get) * - constant, module name; list_msg (post or get) * - constant, operation name; language (post or get) - can take the value: en / ru (ru by default).
|
error: 0, mess: 'Mail queue list', detail [array_list_msg]; error: 100, mess: 'The mail queue list is empty'; error: 400, mess: 'Unfortunately, the module is not available to you.'
|
|
mailserver |
Clearing the mail queue (forced optional).
delete_all_msg |
username (post or get) * - username; password (post or get) * - user password; mailserver (post or get) * - constant, module name; delete_all_msg (post or get) * - constant, operation name; dellete_forse (post or get) - any value in this parameter will force deletion; language (post or get) - can take the value: en / ru (ru by default).
|
error: 0, message: 'Request completed', detail [console_message]; error: 100, message: 'The mail server does not support forced deletion'; error: 400, message: 'Unfortunately, the module is not available to you.'
|
|
mailserver |
Delete / resend the letter.
controll_msg |
username (post or get) * - username; password (post or get) * - user password; mailserver (post or get) * - constant, module name; controll_msg (post or get) * - constant, operation name; id (post or get) * - message id; command (post or get) * - accepts 'delete', 'reship' commands: delete - delete the selected message; reship - resend the selected email. language (post or get) - can take the value: en / ru (ru by default).
|
error: 0, mess: 'Request completed', detail [console_message]; error: 100, mess: 'Invalid value command'; error: 101, mess: 'Missing message id'; error: 102, mess: 'The server for sending letters is missing or incorrectly specified'; error: 400, mess: 'Unfortunately, the module is not available to you.' |
|
mailserver |
Remove frozen emails from the queue.
delete_frozen_msg |
username (post or get) * - username; password (post or get) * - user password; mailserver (post or get) * - constant, module name; delete_frozen_msg (post or get) * - constant, operation name; language (post or get) - can take the value: en / ru (ru by default).
|
error: 0, message: 'Request completed', detail [console_message]; error: 100, message: 'The mail server does not support deleting frozen messages'; error: 400, message: 'Unfortunately, the module is not available to you.'
|
|
mailserver |
Display the number of messages in the queue.
count_msg |
username (post or get) * - username; password (post or get) * - user password; mailserver (post or get) * - constant, module name; count_msg (post or get) * - constant, operation name; language (post or get) - can take the value: en / ru (ru by default).
|
error: 0, message: 'Number of messages'; error: 400, message: 'Unfortunately, the module is not available to you.'
|
|
mailserver |
clamav control: get status, change status.
clamav |
username (post or get) * - username; password (post or get) * - user password; mailserver (post or get) * - constant, module name; clamav (post or get) * - constant, operation name; command (post or get) * - takes the following values status, on, off: status - status; on - enable the service; off - turn off the service. language (post or get) - can take the value: en / ru (ru by default).
|
error: 0, mess: 'Command completed', detail [Status]; error: 100, mess: 'Invalid command'; error: 400, mess: 'Unfortunately, the module is not available to you.'
|
| spamassassin management: get status, change status.
spamassassin |
username (post or get) * - username; password (post or get) * - user password; mailserver (post or get) * - constant, module name; spamassassin (post or get) * - constant, operation name; command (post or get) * - takes the following values status, on, off: status - status; on - enable the service; off - turn off the service. language (post or get) - can take the value: en / ru (ru by default).
|
error: 0, mess: 'Command completed', detail [Status]; error: 100, mess: 'Invalid command'; error: 400, mess: 'Unfortunately, the module is not available to you.'
|
Другие полезные статьи:
