Difference between revisions of "API: Mail"

From BrainyCP
Jump to: navigation, search
m (Protected "API: Mail" ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite)))
 
(One intermediate revision by the same user not shown)
Line 75: Line 75:
 
Другие полезные статьи:
 
Другие полезные статьи:
  
−
{| style="width: 1191px;"
+
{| style="width: 1008px;"
 
|-
 
|-
−
|  
+
| style="width: 285px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_подключение API: подключение]'''
+
'''[https://docs.brainycp.io/index.php/API:_connection <font><font>API: connection</font></font>]'''
  
−
|  
+
| style="width: 329px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_мониторинг API: мониторинг]'''
+
'''[https://docs.brainycp.io/index.php/API:_Monitoring <font><font>API: monitoring</font></font>]'''
  
−
|  
+
| style="width: 372px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_статус_веб-сервера API: статус веб-сервера]'''
+
'''[https://docs.brainycp.io/index.php/API:_Webserver_status <font><font>API: web server status</font></font>]'''
  
 
|-
 
|-
−
|  
+
| style="width: 285px;" |  
−
'''[https://docs.brainycp.io/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: 329px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_настройка_бекапов API: настройка бекапов]'''
+
'''[https://docs.brainycp.io/index.php/API:_Configuring_backups <font><font>API: configuring backups</font></font>]'''
  
−
|  
+
| style="width: 372px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_трансфер_между_серверами API: трансфер между серверами]'''
+
'''[https://docs.brainycp.io/index.php/API:_Transfer_between_servers <font><font>API: transfer between servers</font></font>]'''
  
 
|-
 
|-
−
|  
+
| style="width: 285px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_антивирус API: антивирус]'''
+
'''[https://docs.brainycp.io/index.php/API:_Antivirus <font><font>API: antivirus</font></font>]'''
  
−
|  
+
| style="width: 329px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_настройки_сервера API: настройки сервера]'''
+
'''[https://docs.brainycp.io/index.php/API:_Server_configuration <font><font>API: server settings</font></font>]'''
  
−
|  
+
| style="width: 372px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_управление_веб-сервером API: управление веб-сервером]'''
+
'''[https://docs.brainycp.io/index.php/API:_Manage_webserver <font><font>API: web server management</font></font>]'''
  
 
|-
 
|-
−
|  
+
| style="width: 285px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_базы_данных API: базы данных]'''
+
'''[https://docs.brainycp.io/index.php/API:_Databases <font><font>API: database</font></font>]'''
  
−
|  
+
| style="width: 329px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_пользовательские_сертификаты API: пользовательские сертификаты]'''
+
'''[https://docs.brainycp.io/index.php/API:_User_Certificates <font><font>API: custom certificates</font></font>]'''
  
−
|  
+
| style="width: 372px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_управление_почтовыми_ящиками API: управление почтовыми ящиками]'''
+
'''[https://docs.brainycp.io/index.php/API:_Managing_mailboxes <font><font>API: mailbox management</font></font>]'''
  
 
|-
 
|-
−
|  
+
| style="width: 285px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_информация_о_сервере API: информация о сервере]'''
+
'''[https://docs.brainycp.io/index.php/API:_Server_info <font><font>API: server information</font></font>]'''
  
−
|  
+
| style="width: 329px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_почта API: почта]'''
+
'''[https://docs.brainycp.io/index.php/API:_Mail <font><font>API: mail</font></font>]'''
  
−
|  
+
| style="width: 372px;" |  
−
'''[https://docs.brainycp.io/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: 285px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_использование_трафика API: использование трафика]'''
+
'''[https://docs.brainycp.io/index.php/API:_Traffic_usage <font><font>API: traffic usage</font></font>]'''
  
−
|  
+
| style="width: 329px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_почтовые_ящики_клиента API: почтовые ящики клиента]'''
+
'''[https://docs.brainycp.io/index.php/API:_Client_mail <font><font>API: client mailboxes</font></font>]'''
  
−
|  
+
| style="width: 372px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_установка_веб-сервера API: установка веб-сервера]'''
+
'''[https://docs.brainycp.io/index.php/API:_Webserver_Installation <font><font>API: web server installation</font></font>]'''
  
 
|-
 
|-
−
|  
+
| style="width: 285px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_логирование API: логирование]'''
+
'''[https://docs.brainycp.io/index.php/API:_Logging <font><font>API: logging</font></font>]'''
  
−
|  
+
| style="width: 329px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_сервер_имен API: сервер имен]'''
+
'''[https://docs.brainycp.io/index.php/API:_Nameserver <font><font>API: name server</font></font>]'''
  
−
|  
+
| style="width: 372px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_хост-аккаунты API: хост-аккаунты]'''
+
'''[https://docs.brainycp.io/index.php/API:_host-accounts <font><font>API: host accounts</font></font>]'''
  
 
|-
 
|-
−
|  
+
| style="width: 285px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_менеджер_приложений API: менеджер приложений]'''
+
'''[https://docs.brainycp.io/index.php/API:_App_manager <font><font>API: application manager</font></font>]'''
  
−
|  
+
| style="width: 329px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_сертификаты_сервисов API: сертификаты сервисов]'''
+
'''[https://docs.brainycp.io/index.php/API:_Certificates_of_services <font><font>API: service certificates</font></font>]'''
  
−
|  
+
| style="width: 372px;" |  
−
'''[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: 285px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_менеджер_процессов API: менеджер процессов]'''
+
'''[https://docs.brainycp.io/index.php/API:_Process_manager <font><font>API: process manager</font></font>]'''
  
−
|  
+
| style="width: 329px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_сетевые_инструменты API: сетевые инструменты]'''
+
'''[https://docs.brainycp.io/index.php/API:_Network_tools <font><font>API: network tools</font></font>]'''
  
−
|  
+
| style="width: 372px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_FTP-сервер API: FTP-сервер]'''
+
'''[https://docs.brainycp.io/index.php/API:_FTP-server <font><font>API: FTP server</font></font>]'''
  
 
|-
 
|-
−
|  
+
| style="width: 285px;" |  
−
'''[https://docs.brainycp.io/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: 329px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_средняя_нагрузка API: средняя нагрузка]'''
+
'''[https://docs.brainycp.io/index.php/API:_Load_average <font><font>API: average load</font></font>]'''
  
−
|  
+
| style="width: 372px;" |  
−
'''[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>]'''
  
 
|}
 
|}

Latest revision as of 14:26, 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.'

Другие полезные статьи:

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:_Mail&oldid=1933"