Difference between revisions of "API: Managing mailboxes"

Модуль

Функция

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

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

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>'.