Difference between revisions of "API: Mail"

From BrainyCP
Jump to: navigation, search
m (Fgsfds переименовал страницу API: почта в API: Mail)
Line 1: Line 1:
  
 
 
 
 
−
 
+
<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>
−
Администраторские функции требуют root-права API, чтобы использовать любой логин, размещенный на сервере. Если root-прав нет, можно использовать только свой логин.
 
−
 
 
−
Входящие данные, отмеченные звездочкой, обязательны для заполнения.&nbsp;
 
−
 
 
 
{| border="1" cellpadding="5"
 
{| border="1" cellpadding="5"
 
|-
 
|-
−
| <p dir="ltr" style="text-align: center;">'''Модуль'''</p>  
+
| <p dir="ltr" style="text-align: center;">'''Module'''</p>  
−
| <p dir="ltr" style="text-align: center;">'''Функция'''</p>  
+
| <p dir="ltr" style="text-align: center;">'''function'''</p>  
−
| <p dir="ltr" style="text-align: center;">'''Входящие данные'''</p>  
+
| <p dir="ltr" style="text-align: center;">'''Incoming data'''</p>  
−
| <p dir="ltr" style="text-align: center;">'''Варианты ошибок'''</p>  
+
| <p dir="ltr" style="text-align: center;">'''Error variants'''</p>  
 
|-
 
|-
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
Line 17: Line 13:
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
Просмотр почтовой очереди.
+
Mail queue view.
  
 
list_msg
 
list_msg
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">username (post or get) * - username;</div> <div data-placeholder="Перевод" dir="ltr">password (post or get) * - user password;</div> <div data-placeholder="Перевод" dir="ltr">mailserver (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">list_msg (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">language (post or get) - can take the value: en / ru (ru by default).</div>
−
username (post или get)* — имя пользователя;
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'Mail queue list', detail [array_list_msg];</div> <div data-placeholder="Перевод" dir="ltr">error: 100, mess: 'The mail queue list is empty';</div> <div data-placeholder="Перевод" dir="ltr">error: 400, mess: 'Unfortunately, the module is not available to you.'</div>
−
 
 
−
password (post или get)* — пароль пользователя;
 
−
 
 
−
mailserver (post или get)* — константа, имя модуля;
 
−
 
 
−
list_msg (post или get)* — константа, имя операции;
 
−
 
 
−
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
 
−
 
 
−
| style="vertical-align: top;" |  
 
−
error:0, mess:'Список почтовой очереди', detail [array_list_msg];
 
−
 
 
−
error:100, mess:'Список почтовой очереди пуст';
 
−
 
 
−
error:400, mess:'К сожалению, модуль вам не доступен'.
 
−
 
 
 
|-
 
|-
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
 
mailserver
 
mailserver
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr" id="tw-target-text">Clearing the mail queue (forced optional).</div>
−
Очистка почтовой очереди (принудительная опционально).
 
−
 
 
 
delete_all_msg
 
delete_all_msg
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">username (post or get) * - username;</div> <div data-placeholder="Перевод" dir="ltr">password (post or get) * - user password;</div> <div data-placeholder="Перевод" dir="ltr">mailserver (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">delete_all_msg (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">dellete_forse (post or get) - any value in this parameter will force deletion;</div> <div data-placeholder="Перевод" dir="ltr">language (post or get) - can take the value: en / ru (ru by default).</div>
−
username (post или get)* — имя пользователя;
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, message: 'Request completed', detail [console_message];</div> <div data-placeholder="Перевод" dir="ltr">error: 100, message: 'The mail server does not support forced deletion';</div> <div data-placeholder="Перевод" dir="ltr">error: 400, message: 'Unfortunately, the module is not available to you.'</div>
−
 
 
−
password (post или get)* — пароль пользователя;
 
−
 
 
−
mailserver (post или get)* — константа, имя модуля;
 
−
 
 
−
delete_all_msg (post или get)* — константа, имя операции;
 
−
 
 
−
dellete_forse (post или get) — любое значение в&nbsp;этом параметре приводит к принудительному удалению;
 
−
 
 
−
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
 
−
 
 
−
| style="vertical-align: top;" |  
 
−
error:0, message:'Запрос выполнен',detail[console_message];
 
−
 
 
−
error:100, message:'Почтовый сервер не поддерживает принудительное удаление';
 
−
 
 
−
error:400, message:'К сожалению, модуль вам не доступен'.
 
−
 
 
 
|-
 
|-
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
 
mailserver
 
mailserver
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr" id="tw-target-text">Delete / resend the letter.</div>
−
Удалить/отправить письмо повторно.
 
−
 
 
 
controll_msg
 
controll_msg
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">username (post or get) * - username;</div> <div data-placeholder="Перевод" dir="ltr">password (post or get) * - user password;</div> <div data-placeholder="Перевод" dir="ltr">mailserver (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">controll_msg (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">id (post or get) * - message id;</div> <div data-placeholder="Перевод" dir="ltr">command (post or get) * - accepts 'delete', 'reship' commands:</div> <div data-placeholder="Перевод" dir="ltr">delete - delete the selected message;</div> <div data-placeholder="Перевод" dir="ltr">reship - resend the selected email.</div> <div data-placeholder="Перевод" dir="ltr">language (post or get) - can take the value: en / ru (ru by default).</div>
−
username (post или get)* — имя пользователя;
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr" id="tw-target-text">error: 0, mess: 'Request completed', detail [console_message];<br/> error: 100, mess: 'Invalid value command';<br/> error: 101, mess: 'Missing message id';<br/> error: 102, mess: 'The server for sending letters is missing or incorrectly specified';<br/> error: 400, mess: 'Unfortunately, the module is not available to you.'</div> <div>&nbsp;</div>
−
 
 
−
password (post или get)* — пароль пользователя;
 
−
 
 
−
mailserver (post или get)* — константа, имя модуля;
 
−
 
 
−
controll_msg (post или get)* — константа, имя операции;
 
−
 
 
−
id (post или get)* — id-письма;
 
−
 
 
−
command (post или get)* — принимает команды &nbsp;'delete','reship':
 
−
 
 
−
delete — удалить выбранное письмо;
 
−
 
 
−
reship — переотправить выбранное письмо.
 
−
 
 
−
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
 
−
 
 
−
| style="vertical-align: top;" |  
 
−
error:0, mess:'Запрос выполнен',detail[console_message];<br/> error:100, mess:'Не правильное значение command';<br/> error:101, mess:'Отсутствует id письма';<br/> error:102, mess:'Отсутствует или неправильно указан сервер отправки писем';<br/> error:400, mess:'К сожалению, модуль вам не доступен'.
 
−
 
 
 
|-
 
|-
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
 
mailserver
 
mailserver
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr" id="tw-target-text">Remove frozen emails from the queue.</div>
−
Удалить замороженные письма из очереди.
 
−
 
 
 
delete_frozen_msg
 
delete_frozen_msg
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">username (post or get) * - username;</div> <div data-placeholder="Перевод" dir="ltr">password (post or get) * - user password;</div> <div data-placeholder="Перевод" dir="ltr">mailserver (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">delete_frozen_msg (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">language (post or get) - can take the value: en / ru (ru by default).</div>
−
username (post или get)* — имя пользователя;
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, message: 'Request completed', detail [console_message];</div> <div data-placeholder="Перевод" dir="ltr">error: 100, message: 'The mail server does not support deleting frozen messages';</div> <div data-placeholder="Перевод" dir="ltr">error: 400, message: 'Unfortunately, the module is not available to you.'</div>
−
 
 
−
password (post или get)* — пароль пользователя;
 
−
 
 
−
mailserver (post или get)* — константа, имя модуля;
 
−
 
 
−
delete_frozen_msg (post или get)* — константа, имя операции;
 
−
 
 
−
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
 
−
 
 
−
| style="vertical-align: top;" |  
 
−
error:0, message:'Запрос выполнен',detail[console_message];
 
−
 
 
−
error:100, message:'Почтовый сервер не поддерживает удаление замороженных писем';
 
−
 
 
−
error:400, message:'К сожалению, модуль вам не доступен'.
 
−
 
 
 
|-
 
|-
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
 
mailserver
 
mailserver
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr" id="tw-target-text">Display the number of messages in the queue.</div>
−
Отобразить количество сообщений в очереди.
 
−
 
 
 
count_msg
 
count_msg
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">username (post or get) * - username;</div> <div data-placeholder="Перевод" dir="ltr">password (post or get) * - user password;</div> <div data-placeholder="Перевод" dir="ltr">mailserver (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">count_msg (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">language (post or get) - can take the value: en / ru (ru by default).</div>
−
username (post или get)* — имя пользователя;
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, message: 'Number of messages';</div> <div data-placeholder="Перевод" dir="ltr">error: 400, message: 'Unfortunately, the module is not available to you.'</div>
−
 
 
−
password (post или get)* — пароль пользователя;
 
−
 
 
−
mailserver (post или get)* — константа, имя модуля;
 
−
 
 
−
count_msg (post или get)* — константа, имя операции;
 
−
 
 
−
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
 
−
 
 
−
| style="vertical-align: top;" |  
 
−
error:0, message:'Количество сообщений';
 
−
 
 
−
error:400, message:'К сожалению, модуль вам не доступен'.
 
−
 
 
 
|-
 
|-
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
 
mailserver
 
mailserver
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr" id="tw-target-text">clamav control: get status, change status.</div>
−
управление clamav: &nbsp;получить статус, изменить статус.
 
−
 
 
 
clamav
 
clamav
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">username (post or get) * - username;</div> <div data-placeholder="Перевод" dir="ltr">password (post or get) * - user password;</div> <div data-placeholder="Перевод" dir="ltr">mailserver (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">clamav (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">command (post or get) * - takes the following values ​​status, on, off:</div> <div data-placeholder="Перевод" dir="ltr">status - status;</div> <div data-placeholder="Перевод" dir="ltr">on - enable the service;</div> <div data-placeholder="Перевод" dir="ltr">off - turn off the service.</div> <div data-placeholder="Перевод" dir="ltr">language (post or get) - can take the value: en / ru (ru by default).</div>
−
username (post или get)* — имя пользователя;
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'Command completed', detail [Status];</div> <div data-placeholder="Перевод" dir="ltr">error: 100, mess: 'Invalid command';</div> <div data-placeholder="Перевод" dir="ltr">error: 400, mess: 'Unfortunately, the module is not available to you.'</div>
−
 
 
−
password (post или get)* — пароль пользователя;
 
−
 
 
−
mailserver (post или get)* — константа, имя модуля;
 
−
 
 
−
clamav (post или get)* — константа, имя операции;
 
−
 
 
−
command (post или get)* — принимает такие значения status,on,off:
 
−
 
 
−
status — статус;
 
−
 
 
−
on — включить сервис;
 
−
 
 
−
off — выключить сервис.
 
−
 
 
−
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
 
−
 
 
−
| style="vertical-align: top;" |  
 
−
error:0, mess:'Команда выполнена', detail [Статус];
 
−
 
 
−
error:100, mess:'Неправильная команда';
 
−
 
 
−
error:400, mess:'К сожалению, модуль вам не доступен'.
 
−
 
 
 
|-
 
|-
 
| style="vertical-align: top;" | &nbsp;
 
| style="vertical-align: top;" | &nbsp;
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr" id="tw-target-text">spamassassin management: get status, change status.</div>
−
управление spamassassin: получить статус, изменить статус.
 
−
 
 
 
spamassassin
 
spamassassin
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">username (post or get) * - username;</div> <div data-placeholder="Перевод" dir="ltr">password (post or get) * - user password;</div> <div data-placeholder="Перевод" dir="ltr">mailserver (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">spamassassin (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">command (post or get) * - takes the following values ​​status, on, off:</div> <div data-placeholder="Перевод" dir="ltr">status - status;</div> <div data-placeholder="Перевод" dir="ltr">on - enable the service;</div> <div data-placeholder="Перевод" dir="ltr">off - turn off the service.</div> <div data-placeholder="Перевод" dir="ltr">language (post or get) - can take the value: en / ru (ru by default).</div>
−
username (post или get)* — имя пользователя;
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'Command completed', detail [Status];</div> <div data-placeholder="Перевод" dir="ltr">error: 100, mess: 'Invalid command';</div> <div data-placeholder="Перевод" dir="ltr">error: 400, mess: 'Unfortunately, the module is not available to you.'</div>
−
 
 
−
password (post или get)* — пароль пользователя;
 
−
 
 
−
mailserver (post или get)* — константа, имя модуля;
 
−
 
 
−
spamassassin (post или get)* — константа, имя операции;
 
−
 
 
−
command (post или get)* — принимает такие значения status,on,off:
 
−
 
 
−
status — статус;
 
−
 
 
−
on — включить сервис;
 
−
 
 
−
off — выключить сервис.
 
−
 
 
−
language (post или get) — может принимать значение: en/ru (по умолчанию ru).
 
−
 
 
−
| style="vertical-align: top;" |  
 
−
error:0, mess:'Команда выполнена', detail [Статус];
 
−
 
 
−
error:100, mess:'Неправильная команда';
 
−
 
 
−
error:400, mess:'К сожалению, модуль вам не доступен'.
 
−
 
 
 
|}
 
|}
  

Revision as of 00:05, 11 April 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: подключение

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

Retrieved from "https://docs.brainycp.io/index.php?title=API:_Mail&oldid=1313"