API: Managing mailboxes

From BrainyCP
Revision as of 00:45, 11 April 2021 by Fgsfds (talk | contribs)

Jump to: navigation, search

 

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

mailclient

Add mail.

addmail

username (post) * - username;
password (post) * - user password;
mailclient (post) * - constant, module name;
addmail (post) * - constant, type of operation;
email (post) * - mailbox in userbox @ domain format;
password (post) * - password for the mailbox;
quota (post) * - quota;
language (post) - can take the value: en / ru (ru by default);
panel_user (post) - ISP username to which the operation is applied.
error: 0, mess: 'Mailbox added successfully: <boxname>';
error: 1, mess: 'This mailbox already exists: <boxname>';
error: 2, mess: 'Error in the parameter array';
error: 3, mess: 'An error occurred while adding mailbox: <boxname>';
error: 4, mess: 'The specified domain in the mailbox was not found in the system: <boxname>';
error: 1000, mess: 'You do not have permission to administer this user';
error: 1001, mess: 'There is no such user in the ISP-panel'.

mailclient

Delete mail.

delmail

username (post) * - username;
password (post) * - user password;
mailclient (post) * - constant, module name;
delmail (post) * - constant, type of operation;
email (post) * - mailbox in userbox @ domain format;
password (post) * - password for the mailbox;
quota (post) * - quota;
language (post) - can take the value: en / ru (ru by default);
panel_user (post) - ISP username to which the operation is applied.
error: 0, mess: 'Mailbox successfully deleted';
error: 1, mess: 'Error deleting mailbox: <err_msg>';
error: 2, mess: 'Error in the parameter array';
error: 1000, mess: 'You do not have permission to administer this user';
error: 1001, mess: 'There is no such user in the ISP-panel'.

mailclient

Add mail forwarding.

addforward

username (post) * - username;
password (post) * - user password;
mailclient (post) * - constant, module name;
addforward (post) * - constant, type of operation;
source - source mailbox in userbox @ domain format;
target - the destination mailbox in the userbox @ domain format (you can specify several separated by commas);
save_local - save forwarded mail.
error: 0, mess: 'Mailbox forwarding was successfully defined: <source> => <target>';
error: 1, mess: 'Mailbox forwarding error: <err_msg>';
error: 2, mess: 'Error in the parameter array';
error: 1000, mess: 'You do not have permission to administer this user';
error: 1001, mess: 'There is no such user in the ISP-panel'.

mailclient

Delete mail forwarding.

delforward

username (post) * - username;
password (post) * - user password;
mailclient (post) * - constant, module name;
delforward (post) * - constant, type of operation;
source - source mailbox in userbox @ domain format;
target - the destination mailbox in the userbox @ domain format (you can specify several separated by commas).
error: 0, mess: 'Mailbox forwarding was deleted';
error: 1, mess: 'Error deleting mailbox forwarding: <err_msg>';
error: 2, mess: 'Error in the parameter array';
error: 1000, mess: 'You do not have permission to administer this user';
error: 1001, mess: 'There is no such user in the ISP-panel'.

mailclient

Enable spf-reecord for domain.

onspf

username (post) * - username;
password (post) * - user password;
mailclient (post) * - constant, module name;
onspf (post) * - constant, type of operation;
domain - domain name.
error: 0, mess: 'Entry for domain is enabled';
error: 1, mess: 'Error in the parameter array';
error: 2, mess: 'Error enabling SPF record for domain <domen>';
error: 3, mess: 'SPF is already enabled for domain: <domen>'.

mailclient

Disable spf record for domain.

offspf

username (post) * - username;
password (post) * - user password;
mailclient (post) * - constant, module name;
offspf (post) * - constant, type of operation;
domain - domain name.
error: 0, mess: 'The record is disabled for the domain';
error: 1, mess: 'Error in the parameter array';
error: 2, mess: 'Error disabling SPF record for domain <domen>';
error: 3, mess: 'SPF is already disabled for domain: <domen>'.

mailclient

Enable dkim record for domain.

ondkim

username (post) * - username;
password (post) * - user password;
mailclient (post) * - constant, module name;
ondkim (post) * - constant, operation type;
domain - domain name.
error: 0, mess: 'Entry for domain is enabled';
error: 1, mess: 'Error in the parameter array';
error: 2, mess: 'Error enabling dkim record for domain <domen>';
error: 3, mess: 'dkim is already enabled for domain: <domen>'.

mailclient

Disable dkim record for domain.

offdkim

username (post) * - username;
password (post) * - user password;
mailclient (post) * - constant, module name;
offdkim (post) * - constant, operation type;
domain - domain name.
error: 0, mess: 'The record is disabled for the domain';
error: 1, mess: 'Error in the parameter array';
error: 2, mess: 'Error disabling Dkim record for domain <domen>';
error: 3, mess: 'Dkim is already disabled for domain: <domen>'.

Other useful articles:

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