API: Mail

From BrainyCP
Revision as of 13:08, 26 July 2021 by Alenka (talk | contribs) (Protected "API: Mail" ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite)))

Jump to: navigation, search

 

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: подключение

API: мониторинг

API: статус веб-сервера

API: автоустановщик CMS

API: настройка бекапов

API: трансфер между серверами

API: антивирус

API: настройки сервера

API: управление веб-сервером

API: базы данных

API: пользовательские сертификаты

API: управление почтовыми ящиками

API: информация о сервере

API: почта

API: управление DNS-зонами

API: использование трафика

API: почтовые ящики клиента

API: установка веб-сервера

API: логирование

API: сервер имен

API: хост-аккаунты

API: менеджер приложений

API: сертификаты сервисов

API: CRON

API: менеджер процессов

API: сетевые инструменты

API: FTP-сервер

API: менеджер IP-адресов

API: средняя нагрузка

API: MySQL processlist