Difference between revisions of "API: Mail"

From BrainyCP
Jump to: navigation, search
(Новая страница: « Администраторские функции требуют root-права API, чтобы использовать любой логин, размещен…»)
 
Line 1: Line 1:
 +
 +
 
  
 
Администраторские функции требуют root-права API, чтобы использовать любой логин, размещенный на сервере. Если root-прав нет, можно использовать только свой логин.
 
Администраторские функции требуют root-права API, чтобы использовать любой логин, размещенный на сервере. Если root-прав нет, можно использовать только свой логин.
Line 216: Line 218:
  
 
error:400, mess:'К сожалению, модуль вам не доступен'.
 
error:400, mess:'К сожалению, модуль вам не доступен'.
 +
 +
|}
 +
 +
Другие полезные статьи:
 +
 +
{| style="width: 1191px;"
 +
|-
 +
|
 +
'''[https://docs.brainycp.ru/index.php/API:_подключение API: подключение]'''
 +
 +
|
 +
'''[https://docs.brainycp.ru/index.php/API:_мониторинг API: мониторинг]'''
 +
 +
|
 +
'''[https://docs.brainycp.ru/index.php/API:_статус_веб-сервера API: статус веб-сервера]'''
 +
 +
|-
 +
|
 +
'''[https://docs.brainycp.ru/index.php/API:_автоустановщик_CMS API: автоустановщик CMS]'''
 +
 +
|
 +
'''[https://docs.brainycp.ru/index.php/API:_настройка_бекапов API: настройка бекапов]'''
 +
 +
|
 +
'''[https://docs.brainycp.ru/index.php/API:_трансфер_между_серверами API: трансфер между серверами]'''
 +
 +
|-
 +
|
 +
'''[https://docs.brainycp.ru/index.php/API:_антивирус API: антивирус]'''
 +
 +
|
 +
'''[https://docs.brainycp.ru/index.php/API:_настройки_сервера API: настройки сервера]'''
 +
 +
|
 +
'''[https://docs.brainycp.ru/index.php/API:_управление_веб-сервером API: управление веб-сервером]'''
 +
 +
|-
 +
|
 +
'''[https://docs.brainycp.ru/index.php/API:_базы_данных API: базы данных]'''
 +
 +
|
 +
'''[https://docs.brainycp.ru/index.php/API:_пользовательские_сертификаты API: пользовательские сертификаты]'''
 +
 +
|
 +
'''[https://docs.brainycp.ru/index.php/API:_управление_почтовыми_ящиками API: управление почтовыми ящиками]'''
 +
 +
|-
 +
|
 +
'''[https://docs.brainycp.ru/index.php/API:_информация_о_сервере API: информация о сервере]'''
 +
 +
|
 +
'''[https://docs.brainycp.ru/index.php/API:_почта API: почта]'''
 +
 +
|
 +
'''[https://docs.brainycp.ru/index.php/API:_управление_DNS-зонами API: управление DNS-зонами]'''
 +
 +
|-
 +
|
 +
'''[https://docs.brainycp.ru/index.php/API:_использование_трафика API: использование трафика]'''
 +
 +
|
 +
'''[https://docs.brainycp.ru/index.php/API:_почтовые_ящики_клиента API: почтовые ящики клиента]'''
 +
 +
|
 +
'''[https://docs.brainycp.ru/index.php/API:_установка_веб-сервера API: установка веб-сервера]'''
 +
 +
|-
 +
|
 +
'''[https://docs.brainycp.ru/index.php/API:_логирование API: логирование]'''
 +
 +
|
 +
'''[https://docs.brainycp.ru/index.php/API:_сервер_имен API: сервер имен]'''
 +
 +
|
 +
'''[https://docs.brainycp.ru/index.php/API:_хост-аккаунты API: хост-аккаунты]'''
 +
 +
|-
 +
|
 +
'''[https://docs.brainycp.ru/index.php/API:_менеджер_приложений API: менеджер приложений]'''
 +
 +
|
 +
'''[https://docs.brainycp.ru/index.php/API:_сертификаты_сервисов API: сертификаты сервисов]'''
 +
 +
|
 +
'''[https://docs.brainycp.ru/index.php/API:_CRON API: CRON]'''
 +
 +
|-
 +
|
 +
'''[https://docs.brainycp.ru/index.php/API:_менеджер_процессов API: менеджер процессов]'''
 +
 +
|
 +
'''[https://docs.brainycp.ru/index.php/API:_сетевые_инструменты API: сетевые инструменты]'''
 +
 +
|
 +
'''[https://docs.brainycp.ru/index.php/API:_FTP-сервер API: FTP-сервер]'''
 +
 +
|-
 +
|
 +
'''[https://docs.brainycp.ru/index.php/API:_менеджер_IP-адресов API: менеджер IP-адресов]'''
 +
 +
|
 +
'''[https://docs.brainycp.ru/index.php/API:_средняя_нагрузка API: средняя нагрузка]'''
 +
 +
|
 +
'''[https://docs.brainycp.ru/index.php/API:_MySQL_processlist API: MySQL processlist]'''
  
 
|}
 
|}

Revision as of 14:23, 31 January 2017

 

Администраторские функции требуют root-права API, чтобы использовать любой логин, размещенный на сервере. Если root-прав нет, можно использовать только свой логин.

Входящие данные, отмеченные звездочкой, обязательны для заполнения. 

Модуль

Функция

Входящие данные

Варианты ошибок

mailserver

Просмотр почтовой очереди.

list_msg

username (post или get)* — имя пользователя;

password (post или get)* — пароль пользователя;

mailserver (post или get)* — константа, имя модуля;

list_msg (post или get)* — константа, имя операции;

language (post или get) — может принимать значение: en/ru (по умолчанию ru).

error:0, mess:'Список почтовой очереди', detail [array_list_msg];

error:100, mess:'Список почтовой очереди пуст';

error:400, mess:'К сожалению, модуль вам не доступен'.

mailserver

Очистка почтовой очереди (принудительная опционально).

delete_all_msg

username (post или get)* — имя пользователя;

password (post или get)* — пароль пользователя;

mailserver (post или get)* — константа, имя модуля;

delete_all_msg (post или get)* — константа, имя операции;

dellete_forse (post или get) — любое значение в этом параметре приводит к принудительному удалению;

language (post или get) — может принимать значение: en/ru (по умолчанию ru).

error:0, message:'Запрос выполнен',detail[console_message];

error:100, message:'Почтовый сервер не поддерживает принудительное удаление';

error:400, message:'К сожалению, модуль вам не доступен'.

mailserver

Удалить/отправить письмо повторно.

controll_msg

username (post или get)* — имя пользователя;

password (post или get)* — пароль пользователя;

mailserver (post или get)* — константа, имя модуля;

controll_msg (post или get)* — константа, имя операции;

id (post или get)* — id-письма;

command (post или get)* — принимает команды  'delete','reship':

delete — удалить выбранное письмо;

reship — переотправить выбранное письмо.

language (post или get) — может принимать значение: en/ru (по умолчанию ru).

error:0, mess:'Запрос выполнен',detail[console_message];
error:100, mess:'Не правильное значение command';
error:101, mess:'Отсутствует id письма';
error:102, mess:'Отсутствует или неправильно указан сервер отправки писем';
error:400, mess:'К сожалению, модуль вам не доступен'.

mailserver

Удалить замороженные письма из очереди.

delete_frozen_msg

username (post или get)* — имя пользователя;

password (post или get)* — пароль пользователя;

mailserver (post или get)* — константа, имя модуля;

delete_frozen_msg (post или get)* — константа, имя операции;

language (post или get) — может принимать значение: en/ru (по умолчанию ru).

error:0, message:'Запрос выполнен',detail[console_message];

error:100, message:'Почтовый сервер не поддерживает удаление замороженных писем';

error:400, message:'К сожалению, модуль вам не доступен'.

mailserver

Отобразить количество сообщений в очереди.

count_msg

username (post или get)* — имя пользователя;

password (post или get)* — пароль пользователя;

mailserver (post или get)* — константа, имя модуля;

count_msg (post или get)* — константа, имя операции;

language (post или get) — может принимать значение: en/ru (по умолчанию ru).

error:0, message:'Количество сообщений';

error:400, message:'К сожалению, модуль вам не доступен'.

mailserver

управление clamav:  получить статус, изменить статус.

clamav

username (post или get)* — имя пользователя;

password (post или get)* — пароль пользователя;

mailserver (post или get)* — константа, имя модуля;

clamav (post или get)* — константа, имя операции;

command (post или get)* — принимает такие значения status,on,off:

status — статус;

on — включить сервис;

off — выключить сервис.

language (post или get) — может принимать значение: en/ru (по умолчанию ru).

error:0, mess:'Команда выполнена', detail [Статус];

error:100, mess:'Неправильная команда';

error:400, mess:'К сожалению, модуль вам не доступен'.

 

управление spamassassin: получить статус, изменить статус.

spamassassin

username (post или get)* — имя пользователя;

password (post или get)* — пароль пользователя;

mailserver (post или get)* — константа, имя модуля;

spamassassin (post или get)* — константа, имя операции;

command (post или get)* — принимает такие значения status,on,off:

status — статус;

on — включить сервис;

off — выключить сервис.

language (post или get) — может принимать значение: en/ru (по умолчанию ru).

error:0, mess:'Команда выполнена', detail [Статус];

error:100, mess:'Неправильная команда';

error:400, mess:'К сожалению, модуль вам не доступен'.

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

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=362"