Difference between revisions of "API: Managing mailboxes"

From BrainyCP
Jump to: navigation, search
(Новая страница: « Администраторские функции требуют root-права API, чтобы использовать любой логин, размещен…»)
 
Line 1: Line 1:
 +
 +
 
  
 
Администраторские функции требуют root-права API, чтобы использовать любой логин, размещенный на сервере. Если root-прав нет, можно использовать только свой логин.
 
Администраторские функции требуют root-права API, чтобы использовать любой логин, размещенный на сервере. Если root-прав нет, можно использовать только свой логин.
Line 275: Line 277:
  
 
error:3, mess:'Dkim уже выключен для домена: <domen>'.
 
error:3, mess:'Dkim уже выключен для домена: <domen>'.
 +
 +
|}
 +
 +
Другие полезные статьи:
 +
 +
{| 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:27, 31 January 2017

 

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

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

Модуль

Функция

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

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

mailclient

Добавление почтового ящика.

addmail

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

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

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

addmail (post)* — константа, тип операции;

email (post)* — почтовый ящик в формате userbox@domain;

password (post)* — пароль на почтовый ящик;

quota (post)* — квота;

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

panel_user (post) — имя пользователя ISP, к которому применяется операция.

error:0, mess:'Почтовый ящик успешно добавлен:<boxname>';

error:1, mess:'Такой почтовый ящик уже существует: <boxname>';

error:2, mess:'Ошибка в массиве параметров';

error:3, mess:'Возникла ошибка при добавлении почтового ящика:<boxname>';

error:4, mess:'Указанный домен в почтовом ящике не найден в системе:<boxname>';

error:1000, mess:'У вас нет прав для администрирования этого пользователя';

error:1001, mess:'Такой пользователь отсутствует в ISP-панели'.

mailclient

Удаление почтового ящика.

delmail

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

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

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

delmail (post)* — константа, тип операции;

email (post)* — почтовый ящик в формате userbox@domain;

password (post)* — пароль на почтовый ящик;

quota (post)* — квота;

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

panel_user (post) — имя пользователя ISP, к которому применяется операция.

error:0, mess:'Почтовый ящик успешно удален';

error:1, mess:'Ошибка удаления почтового ящика: <err_msg>';

error:2, mess:'Ошибка в массиве параметров';

error:1000, mess:'У вас нет прав для администрирования этого пользователя';

error:1001, mess:'Такой пользователь отсутствует в ISP-панели'.

mailclient

Добавление почтового перенаправления.

addforward

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

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

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

addforward (post)* — константа, тип операции;

source — исходный почтовый ящик в формате userbox@domain;

target — почтовый ящик назначения в формате userbox@domain (можно указать несколько через запятую);

save_local — сохранять перенаправляемую почту.

error:0, mess:'Перенаправление почтового ящика успешно определено: <source> => <target>';

error:1, mess:'Ошибка перенаправления почтового ящика: <err_msg>';

error:2, mess:'Ошибка в массиве параметров';

error:1000, mess:'У вас нет прав для администрирования этого пользователя';

error:1001, mess:'Такой пользователь отсутствует в ISP-панели'.

mailclient

Удаление почтового перенаправления.

delforward

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

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

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

delforward (post)* — константа, тип операции;

source — исходный почтовый ящик в формате userbox@domain;

target — почтовый ящик назначения в формате userbox@domain (можно указать несколько через запятую).

error:0, mess:'Перенаправление почтового ящика было удалено';

error:1, mess:'Ошибка удаления перенаправления почтового ящика: <err_msg>';

error:2, mess:'Ошибка в массиве параметров';

error:1000, mess:'У вас нет прав для администрирования этого пользователя';

error:1001, mess:'Такой пользователь отсутствует в ISP-панели'.

mailclient

Включить spf-запись для домена.

onspf

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

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

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

onspf (post)* — константа, тип операции;

domain — имя домена.

error:0, mess:'Запись для домена включена';

error:1, mess:'Ошибка в массиве параметров';

error:2, mess:'Ошибка включения записи SPF для домена <domen>';

error:3, mess:'SPF уже включен для домена: <domen>'.

mailclient

Отключить spf запись для домена.

offspf

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

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

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

offspf (post)* — константа, тип операции;

domain — имя домена.

error:0, mess:'Запись для домена выключена';

error:1, mess:'Ошибка в массиве параметров';

error:2, mess:'Ошибка отключения записи SPF для домена <domen>';

error:3, mess:'SPF уже выключен для домена: <domen>'.

mailclient

Включить dkim запись для домена.

ondkim

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

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

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

ondkim (post)* — константа, тип операции;

domain — имя домена.

error:0, mess:'Запись для домена включена';

error:1, mess:'Ошибка в массиве параметров';

error:2, mess:'Ошибка включения dkim записи для домена <domen>';

error:3, mess:'dkim уже включен для домена: <domen>'.

mailclient

Отключить dkim запись для домена.

offdkim

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

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

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

offdkim (post)* — константа, тип операции;

domain — имя домена.

error:0, mess:'Запись для домена выключена';

error:1, mess:'Ошибка в массиве параметров';

error:2, mess:'Ошибка отключения записи Dkim для домена <domen>';

error:3, mess:'Dkim уже выключен для домена: <domen>'.

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

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