Difference between revisions of "API: Mail"

Модуль

Функция

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

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

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:'К сожалению, модуль вам не доступен'.