IVA ДОКУМЕНТАЦИЯ
ОБНОВЛЕНИЯ

Справочник команд CLI

Общие сведения

Справочник содержит команды интерфейса командной строки CLI для администрирования сервера IVA Mail.

CLI предоставляет доступ к:

  • настройке сервера;

  • управлению доменами и аккаунтами;

  • настройке модулей;

  • работе со справочником;

  • диагностике;

  • работе с очередями;

  • управлению правилами;

  • работе с календарями и контактами;

  • управлению административными правами;

  • автоматизации административных операций.

В разделе Интерфейс командной строки приведено подробное описание CLI, включая:

  • общие принципы работы CLI;

  • синтаксис команд;

  • правила передачи параметров;

  • особенности наследования и прав доступа.

Общие команды

Quit

Назначение

Завершает CLI-сессию и закрывает соединение.

Синтаксис
Quit

Shutdown

Назначение

Инициирует остановку сервера.

Синтаксис
Shutdown

Inline

Назначение

Переключает режим вывода объектов в результатах команд между компактным и многострочным.

Синтаксис
Inline

Ext

Назначение

Переключает режим вывода объектов в результатах команд между стандартным и расширенным.

Синтаксис
Ext

NoTimeout

Назначение

Устанавливает тайм-аут чтения в соединении в 365 дней.

Синтаксис
NoTimeout

NoEscape

Назначение

Переключает флаг экранирования служебных символов в выводе последующих команд.

Синтаксис
NoEscape

Help

Назначение

Выводит список команд с возможностью фильтрации.

Синтаксис
Help ("search")
Параметр Описание

search

Параметр фильтрации при поиске команд (при необходимости).

Ping

Назначение

Отвечает фиксированным сообщением.

Синтаксис
Ping

RaiseMem

Назначение

Вызывает аварийное завершение процесса с генерацией системного сигнала SIGSEGV.

Используется для проверки создания отладочных образов памяти выполняемой программы core dump.

Синтаксис
RaiseMem

SchemaDump

Назначение

Выдаёт описание схемы настроек.

Синтаксис
SchemaDump "type" (false)
Параметр Описание

type

Имя схемы настроек. Если указана пустая строка, возвращается список известных схем.

false

При задании этого параметра описания объектов в схеме не содержат прав доступа

ModulesList

Назначение

Выдаёт список инициализированных модулей.

Синтаксис
ModulesList

MailModulesList

Назначение

Выдаёт список инициализированных почтовых модулей.

Синтаксис
MailModulesList

MailQueueList

Назначение

Выдаёт информацию о почтовой очереди модуля по его имени или общую почтовую очередь при отсутствии имени или пустом имени.

Синтаксис
MailQueueList ("module_name")
Параметр Описание

module_name

Имя почтового модуля.
Пример
MailQueueList "SMTP"

MailBatchList

Назначение

Выдаёт информацию об активных или ожидающих блоках доставки очереди почтового модуля по его имени.

Синтаксис
MailBatchList "module_name"
Параметр Описание

module_name

Имя почтового модуля.

ModuleReadConfig

Назначение

Выдаёт настройки модуля.

Синтаксис
ModuleReadConfig "module_name" (true|false)
Параметр Описание

module_name

Имя почтового модуля.

true|false

Не обязательный параметр. Если задано true, то словарь с настройками содержит описание полей. Если задано false, то словарь не содержит настройки по умолчанию.

ModuleUpdateConfig

Назначение

Обновляет настройки модуля.

Синтаксис
ModuleUpdateConfig "module_name" deleteKeys updateKeyVals
Параметр Описание

module_name

Имя модуля.

deleteKeys

Массив ключей для удаления из настроек (вместо них будут использоваться значения по умолчанию).

updateKeyVals

Массив пар ключ-значение, по которому значения указанных ключей заменяются на новые.

ModuleSetLogLevel

Назначение

Изменяет уровень журналирования модуля.

Синтаксис
ModuleSetLogLevel "module_name" level
Параметр Описание

module_name

Имя модуля.

level

Уровень журналирования.
Уровни журналирования
Значение Уровень

0

Критические ошибки

1

Ошибки

2

Информация

3

Предупреждения

4

Подробности

5

Отладочный
Пример
ModuleSetLogLevel "IMAP" 0

ModuleGetSetting

Назначение

Выдаёт объект настроек модуля.

Синтаксис
ModuleGetSetting "module_name" "key"|["key1","key2",...]
Параметр Описание

module_name

Имя модуля.

"key"|["key1","key2",…​]

Объект/объекты настроек модуля.

ModuleSetSetting

Назначение

Устанавливает объект настроек модуля.

Синтаксис
ModuleSetSetting "module_name" "key"|["key1","key2",...] {object}

ModuleDelSetting

Назначение

Удаляет объект настроек модуля и возвращает значение по умолчанию.

Синтаксис
ModuleDelSetting "module_name" "key"|["key1","key2",...]
Параметр Описание

module_name

Имя модуля.

"key"|["key1","key2",…​]

Объект/объекты настроек модуля.

DigestList

Назначение

Выдаёт список методов хэширования.

Синтаксис
DigestList

CipherList

Назначение

Выдаёт список методов шифрования.

Синтаксис
CipherList

KDFList

Назначение

Выдаёт список методов преобразования паролей в ключи.

Синтаксис
KDFList

ThreadsList

Назначение

Выдаёт список потоков выполнения.

Синтаксис
ThreadsList ("filter")
Параметр Описание

filter

Не обязательный строковый параметр. Если параметр задан, то выводится информация только о тех нитях, чьё описание содержит эту строку.

ConnectionsList

Назначение

Выдаёт список активных сетевых соединений.

Синтаксис
ConnectionsList ("module_name") ("filter")
Параметр Описание

module_name

Имя модуля. Если задано, то выводится информация только о соединениях этого модуля.

filter

Не обязательный строковый параметр. Если параметр задан, то выводится информация только о тех соединениях, чьё описание содержит эту строку.

LogsList

Назначение

Возвращает список журналов событий с размерами в байтах.

Синтаксис
LogsList ("log_type")
Параметр Описание

log_type

Тип журнала событий. Если указана пустая строка — возвращается список основных журналов сервера.
Возможные типы журнала событий
Тип Описание

Mailbox

Журнал событий почтового ящика.

Auth

Журнал событий аутентификации.

Settings

Журнал событий настроек.

LogsRemove

Назначение

Удаляет файлы из указанного типа журнала событий.

Синтаксис
LogsRemove "log_type" ["log_name1","log_name2"]
Параметр Описание

log_type

Тип журнала событий. Если указана пустая строка — удаляются основные журналы событий сервера.

log_name1

Имя журнала событий (должно быть указано без расширения)

Maintenance

Назначение

Запускает задачу обслуживания Maintenance для всего сервера, или для отдельного домена, или для отдельного аккаунта.

Синтаксис
Maintenance  "*"|"domain.dom"|"user@domain.dom" ("SubtaskName")
Параметр Описание

*, domain.dom, `user@domain.dom

Запуск обслуживания всего сервера, отдельного домена, отдельного аккаунта соответственно.

SubtaskName

Имя подзадачи (не обязательный параметр). Если не указано, то выполняются подзадачи с 1 по 8. Если указана, то выполняется только указанная.
Подзадачи SubtaskName
Номер Имя Описание

1.

CleanTrash

Очистка папки Корзины от старых сообщений в аккаунте.

2.

CleanSpam

Очистка папки Спам от старых сообщений в аккаунте.

3.

CleanMail

Удаление старых сообщений из всех папок в аккаунте.

4.

RestructureMail

Перемещение старых сообщений из папок INBOX и Отправленные в подпапки Архивы с раскладкой по кварталам года.

5.

ArchiveMail

Перемещение старых сообщений из всех папок в подпапки Архивы с сохранением оригинальной структуры папок.

6.

CleanCalendars

Удаление старых старых календарных событий из всех календарей в аккаунте.

7.

RestructureCalendar

Перемещение старых календарных событий из главного календаря в подпапки Архивы с раскладкой по кварталам года

8.

CleanDomain

Удаляет из домена объекты, имеющие в настройках ключ DeleteMeAfter со значением отметки времени, которая меньше текущего времени.

SystemInfo

Назначение

Выдаёт общие сведения о сервере.

Синтаксис
SystemInfo

AdminAlertsGet

Назначение

Выдаёт список активных (не просроченных) системных предупреждений: остановка сервера, потоки, соединения, слушатели, DNS, плагины, файлы, приближение истечения срока действия лицензии и т.д.

Синтаксис
AdminAlertsGet

MyRights

Назначение

Выдаёт текущие права администратора данного CMD-подключения.

Синтаксис
MyRights

Geolocation

Назначение

Выдаёт геолокационные данные по IP-адресу.

Синтаксис
Geolocation "ip address" ("language")
Параметр Описание

ip address

IP-адрес.

language

Язык локали (не обязательный параметр).

Работа с доменами

DomainsList

Назначение

Выдаёт список зарегистрированных доменов в виде словаря с числовыми ключами. Ключ — UID домена, значение — основное имя домена.

Синтаксис
DomainsList ("filter"|false|true|null )
Параметр Описание

filter

Фильтр поиска. Если задан фильтр поиска, то будет произведена фидльтрация по наличию подстроки как в основном имени домена, так и в псевдониме.

Если вместо фильтра указать false, то будет выведен подробный список доменов с типом, всеми доступными именами, псевдонимами и флагами. Если указать true — будут также выведены проверочные хэш-суммы.

Если вместо фильтра указать null, будет выведена информация только о кластерных доменах.

DomainCreate

Назначение

Создаёт домен.

Синтаксис
DomainCreate "domName" (null)
Параметр Описание

domName

Имя домена.

null

Указывается для создания кластерного домена.
Пример 1
DomainCreate "example.org"
Пример 2
DomainCreate "cluster.dom" (null)

DomainRemove

Назначение

Удаляет домен.

Синтаксис
DomainRemove "domName"|domUID
Параметр Описание

domName

Имя домена.

domUID

Числовой идентификатор домена.

DomainRename

Назначение

Переименовывает домен.

Синтаксис
DomainRename "domName"|domUID "new_name"
Параметр Описание

domName

Имя домена.

domUID

Числовой идентификатор домена.

new_name

Новое имя домена.

DomainGetID

Назначение

Выдаёт UID домена по его имени.

Синтаксис
DomainGetID "domName"
Параметр Описание

domName

Имя домена.

DomainListNames

Назначение

Выдаёт список всех имён домена по его имени.

Синтаксис
DomainListNames "domName"|domUID
Параметр Описание

domName

Имя домена.

domUID

Числовой идентификатор домена.

DomainAddName

Назначение

Добавляет домену дополнительное имя.

Синтаксис
DomainAddName "domName"|domUID "new_name"
Параметр Описание

domName

Имя домена.

domUID

Числовой идентификатор домена.

new_name

Новое имя домена.

DomainDelName

Назначение

Удаляет имя домена.

Синтаксис
DomainDelName "domName"
Параметр Описание

domName

Имя домена.

DomainUseName

Назначение

Делает имя основным.

Синтаксис
DomainUseName "domName"
Параметр Описание

domName

Имя домена.

DomainMoveName

Назначение

Переносит новое имя домену.

Синтаксис
DomainMoveName "domName"|domUID "new_name"
Параметр Описание

domName

Имя домена.

domUID

Числовой идентификатор домена.

new_name

Новое имя домена.

DomainGetFlags

Назначение

Выдаёт флаги доменного имени.

Синтаксис
DomainGetFlags "domName"
Параметр Описание

domName

Имя домена.

DomainSetFlag

Назначение

Устанавливает флаги доменного имени.

Синтаксис
DomainSetFlag "domName" flag
Параметр Описание

domName

Имя домена.

flag

Флаг применения имени домена.

DomainReadConfig

Назначение

Выдаёт объект настроек домена.

Синтаксис
DomainReadConfig "domName"|domUID (true|false)
Параметр Описание

domName

Имя домена.

domUID

Числовой идентификатор домена.

true|false

Дополнительный параметр. Если указан true, то словарь содержит описания полей. Если задан false, то словарь не содержит настроек по умолчанию.

DomainGetSetting

Назначение

Выдаёт объект настроек домена.

Синтаксис
DomainGetSetting "domName"|domUID "key"|["key1","key2",...]
Параметр Описание

domName

Имя домена.

domUID

Числовой идентификатор домена.

"key"|["key1","key2",…​]

Объект/объекты настроек домена.

DomainSetSetting

Назначение

Устанавливает значение настройки в объект настроек домена.

Синтаксис
DomainSetSetting "domName"|domUID "key"|["key1","key2",...] {object}
Параметр Описание

domName

Имя домена.

domUID

Числовой идентификатор домена.

"key"|["key1","key2",…​]

Объект/объекты настроек домена.

object

Значение настройки.

DomainDelSetting

Назначение

Удаляет настройку домена, возвращая значение по умолчанию.

Синтаксис
DomainDelSetting "domName"|domUID "key"|["key1","key2",...]
Параметр Описание

domName

Имя домена.

domUID

Числовой идентификатор домена.

"key"|["key1","key2",…​]

Объект/объекты настроек домена для удаления.

DomainUpdateConfig

Назначение

Обновляет настройки домена.

Синтаксис
DomainUpdateConfig "string"|domUID deleteKeys updateKeyVals
Параметр Описание

domName

Имя домена.

domUID

Числовой идентификатор домена.

deleteKeys

Массив ключей для удаления из настроек (вместо них будут использоваться значения по умолчанию).

updateKeyVals

Массив вида ключ-значение, по которому значения, указанных ключей заменяются на новые.

DomainsDefaults

Назначение

Выдаёт объект настроек по умолчанию для доменов.

Синтаксис
DomainsDefaults (true|false) (null)
Параметр Описание

true|false

Дополнительный параметр. Если задан true, то словарь содержит описания полей. Если задан false, то выдаётся объект настроек без учёта жёстко заданных в программе.

null

Дополнительный параметр. Если параметр задан, то выдаются значения по умолчанию для кластерных доменов.

DomainsGetDefault

Назначение

Выдаёт настройку доменов по умолчанию.

Синтаксис
DomainsGetDefault "key"|["key1","key2",...] (null)
Параметр Описание

key"|["key1","key2",…​]

Объект/объекты настроек по умолчанию.

null

Дополнительный параметр. Если параметр задан, то выдаются значения по умолчанию для кластерных доменов.

DomainsSetDefault

Назначение

Изменяет настройки доменов по умолчанию.

Синтаксис
DomainsSetDefault "key"|["key1","key2",...] {object} (null)
Параметр Описание

key"|["key1","key2",…​]

Объект/объекты настроек по умолчанию.

object

Значение для объекта настроек.

null

Дополнительный параметр. Если параметр задан, то выдаются значения по умолчанию для кластерных доменов.

DomainsDelDefault

Назначение

Удаляет объект настроек по умолчанию для доменов.

Синтаксис
DomainsDelDefault "key"|["key1","key2",...] (null)
Параметр Описание

key"|["key1","key2",…​]

Объект/объекты настроек по умолчанию.

null

Дополнительный параметр. Если параметр задан, то выдаются значения по умолчанию для кластерных доменов.

DomainsUpdateDefaults

Назначение

Обновляет настройки доменов по умолчанию.

Синтаксис
DomainsUpdateDefaults deleteKeys updateKeyVals (null)
Параметр Описание

deleteKeys

Массив для удаления из настроек (вместо них будут использоваться значения по умолчанию).

updateKeyVals

Массив вида ключ-значение, по которому значения указанных ключей заменяются на новые.

null

Дополнительный параметр. Если параметр задан, то изменяются значения по умолчанию для кластерных доменов.

DomainGetIPs

Назначение

Выдаёт глобальную карту соответствия "IP-адрес — домен".

Синтаксис
DomainGetIPs

DomainSetIPs

Назначение

Устанавливает для домена список IP-адресов и обновляет глобальную карту.

Синтаксис
DomainSetIPs "domName"|domUID {object}
Параметр Описание

domName

Имя домена.

domUID

Числовой идентификатор домена.

object

Список IP-адресов для домена.

Работа с объектами в доменах

ObjectList

Назначение

Выдаёт список зарегистрированных объектов домена в виде словаря с числовыми ключами: ключ — UID объекта, значение — основное имя объекта.

Синтаксис
ObjectsList "domName"|domUID ("filter"|false|true ) (start limit ([fields]))
Параметр Описание

domName

Имя домена.

domUID

Числовой идентификатор домена.

"filter"|false|true

Фильтр поиска. Если указать фильтр поиска filter, то будет произведена фильтрация по наличию подстроки как в основном имени объекта, так и в псевдониме.

Если строка фильтра начинается с символа =, то подстрока ищется в типе доменного объекта: например, с фильтром "=acc" можно пролистать все аккаунты.

Если вместо фильтра поиска указать значение false, то будет выведен подробный список с типом, всеми доступными именами и псевдонимами и флагами (при true будут также выведены и проверочные хэш-суммы).

start limit

Числовые параметры. Если заданы start и limit, то выдача будет ограничена элементами с UID не менее start и общим количество не более limit.

fields

Массив ключей (не обязательный параметр). Если массив указан, их значения должны быть включены в информацию об объекте, например ["RealName", "StorageSize"].

ForwarderCreate

Назначение

Создаёт переадресатор.

Синтаксис
ForwarderCreate "domName"|domUID "fwdName" "destination"

GroupCreate

Назначение

Создаёт группу.

Синтаксис
GroupCreate "domName"|domUID "grpName" (settingsDict|settingsKeyValArray)
Параметр Описание

domName

Имя домена.

domUID

Числовой идентификатор домена.

grpName

Имя группы.

settingsDict|settingsKeyValArray

Опциональный словарь settingsDict или массив settingsKeyValArray (с чередующимися названием настроек [строка] и их значениями [объект]) с настройками группы, которые будут установлены сразу после создания группы.

MailingListCreate

Назначение

Создаёт список рассылки.

Синтаксис
MailingListCreate "domName"|domUID "mlName" "owner" ("mountName")
Параметр Описание

owner

Адрес владельца в формате строки.

mountName

Точка монтирования в формате строки (опционально).

ObjectRemove

Назначение

Удаляет объект.

Синтаксис
ObjectRemove "domName"|domUID "objName"|objUID

ObjectRename

Назначение

Переименовывает объект.

Синтаксис
ObjectRename "domName"|domUID "objName"|objUID "newName"

ObjectGetID

Назначение

Возвращает UID объекта.

Синтаксис
ObjectGetID "domName"|domUID "objName"

ObjectListNames

Назначение

Выдаёт список имен объекта.

Синтаксис
ObjectListNames "domName"|domUID "objName"|objUID

ObjectAddName

Назначение

Добавляет объекту имя.

Синтаксис
ObjectAddName "domName"|domUID "objName"|objUID "newName" [flag]

ObjectDelName

Назначение

Удаляет имя объекта.

Синтаксис
ObjectDelName "domName"|domUID "objName"

ObjectUseName

Назначение

Делает имя объекта основным.

Синтаксис
ObjectUseName "objName"

ObjectMoveName

Назначение

Переносит имя объекту.

Синтаксис
ObjectMoveName "domName"|domUID "destName"|destUID "newName"

ObjectGetFlags

Назначение

Выдаёт флаги имени объекта.

Синтаксис
ObjectGetFlags "domName"|domUID "objName"

ObjectSetFlags

Назначение

Устанавливает флаги имени объекта.

Синтаксис
ObjectSetFlags "domName"|domUID "objName" flag

ObjectReadConfig

Назначение

Выдаёт настройки объекта.

Синтаксис
ObjectReadConfig "domName"|domUID "objName"|objUID (true|false)

ObjectGetSetting

Назначение

Выдаёт настройку объекта.

Синтаксис
ObjectGetSetting "domName"|domUID "objName"|objUID "key"|["key1","key2",...] (true)

ObjectSetSetting

Назначение

Изменяет настройку объекта.

Синтаксис
ObjectSetSetting "domName"|domUID "objName"|objUID "key"|["key1","key2",...] {object}

ObjectDelSetting

Назначение

Удаляет настройку объекта.

Синтаксис
ObjectDelSetting "domName"|domUID "objName"|objUID "key"|["key1","key2",..]

ObjectHasInList

Назначение

Проверяет наличие значения в списке настройки.

Синтаксис
ObjectHasInList "domName"|domUID "objName"|objUID "key"|["key1","key2",...] {object}

ObjectAddToList

Назначение

Добавляет значение в список настройки.

Синтаксис
ObjectAddToList "domName"|domUID "objName"|objUID "key"|["key1","key2",...] {object}

ObjectDelInList

Назначение

Удаляет значение из списка настройки.

Синтаксис
ObjectDelInList "domName"|domUID "objName"|objUID "key"|["key1","key2",...] {object}

ObjectUpdateConfig

Назначение

Обновляет настройки объекта.

Синтаксис
ObjectUpdateConfig "domName"|domUID "objName"|objUID keysToDelete keyValPairs

Работа с аккаунтами

AccountCreate

Назначение

Создаёт учетную запись.

Синтаксис
AccountCreate "domName"|domUID "accName"
Параметр Описание

domName

Имя домена.

domUID

UID домена.

accName

Имя учетной записи.
Пример
AccountCreate "example.org" "user1"

AccountsDefaultProfileCreate

Назначение

Создаёт профиль настроек аккаунтов.

Синтаксис
AccountsDefaultProfileCreate "domName"|domUID|null "profile_name" (true)
Если вместо домена передан null, профиль создается на уровне кластера.

AccountsDefaultProfileRemove

Назначение

Удаляет профиль настроек аккаунтов.

Синтаксис
AccountsDefaultProfileRemove "domName"|domUID|null "profile_name" (true)

AccountsDefaultProfileList

Назначение

Выдаёт список профилей настроек аккаунтов.

Синтаксис
AccountsDefaultProfileList "domName"|domUID|null (true)

AccountSetPassword

Назначение

Устанавливает пароль аккаунта.

Синтаксис
AccountSetPassword "domName"|domUID "accName"|accUID "password" ["tag"]
Пример
AccountSetPassword "example.org" "user1" "secret123"

AccountVerifyPWD

Назначение

Проверяет пароль аккаунта.

Синтаксис
AccountVerifyPWD "domName"|domUID "accName"|accUID "password" ("tag")

AccountGetPassword

Назначение

Получает пароль аккаунта.

Синтаксис
AccountGetPassword "domName"|domUID "accName"|accUID ["tag"]

AccountsDefaults

Назначение

Выдаёт настройки аккаунтов по умолчанию.

Синтаксис
AccountsDefaults "domName"|domUID|null ("profile_name") (true|false)

AccountsGetDefault

Назначение

Выдаёт настройку аккаунтов по умолчанию.

Синтаксис
AccountsGetDefault "domName"|domUID|null "key"|["key1","key2",...] ("profileName")

AccountsSetDefault

Назначение

Изменяет настройку аккаунтов по умолчанию.

Синтаксис
AccountsSetDefault "domName"|domUID|null "key"|["key1","key2",...] object ("profileName")

AccountsDelDefault

Назначение

Удаляет настройку аккаунтов по умолчанию.

Синтаксис
AccountsDelDefault "domName"|domUID|null "key"|["key1","key2",...] ("profileName")

AccountsUpdateDefs

Назначение

Обновляет настройки аккаунтов по умолчанию.

Синтаксис
AccountsUpdateDefs "domName"|domUID|null keysToDelete keyValPairs ("profileName")

AccountListNamespaces

Назначение

Выдаёт список пространств имен папок аккаунта.

Синтаксис
AccountListNamespaces "domName"|domUID "accName"|accUID

AccountListMailboxes

Назначение

Выдаёт список почтовых папок аккаунта.

Синтаксис
AccountListMailboxes "domName"|domUID "accName"|accUID "name_space"
Пространство имен может быть пустым или иметь вид ~user@domain/.

AccountGetMailStorageSize

Назначение

Выдаёт размер почтового хранилища аккаунта.

Синтаксис
AccountGetMailStorageSize "domName"|domUID "accName"|accUID (true)

Работа с группами

GroupListMembers

Назначение

Выдаёт список участников группы.

Синтаксис
GroupListMembers "domName"|domUID "grpUID"|grpUID (true ("filter"))

GroupAddAccount

Назначение

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

Синтаксис
GroupAddAccount "domName"|domUID "grpUID"|grpUID "address" (true)

GroupDelAccount

Назначение

Удаляет участника из группы.

Синтаксис
GroupDelAccount "domName"|domUID "grpUID"|grpUID "address" (true)

GroupHasAccount

Назначение

Проверяет наличие участника в группе.

Синтаксис
GroupHasAccount "domName"|domUID "grpUID"|grpUID "address" (true)

GroupGetOwner

Назначение

Выдаёт владельца группы.

Синтаксис
GroupGetOwner "domName"|domUID "grpUID"|grpUID

GroupSetOwner

Назначение

Назначает владельца группы.

Синтаксис
GroupSetOwner "domName"|domUID "grpUID"|grpUID "address"

Работа со списками рассылки

MailingListGetMembers

Назначение

Возвращает адреса участников списка рассылки.

Синтаксис
MailingListGetMembers "domName"|domUID "mlName"|mlUID

MailingListAddMember

Назначение

Добавляет один или несколько адресов участников списка рассылки.

Синтаксис
MailingListAddMember "domName"|domUID "mlName"|mlUID "address"|[list]
Параметр Описание

address

Адрес участника в формате строки или список адресов в формате массива JSON.

MailingListDelMember

Назначение

Удаляет один или несколько адресов участников списка рассылки.

Синтаксис
MailingListDelMember "domName"|domUID "mlName"|mlUID "address"|[list]
Параметр Описание

address

Адрес участника в формате строки или список адресов в формате массива JSON.

MailingListGetMember

Назначение

Возвращает текущие параметры участника списка рассылки.

Синтаксис
MailingListGetMember "domName"|domUID "mlName"|mlUID "address"
Параметр Описание

address

Адрес участника в формате строки.

MailingListRouteMember

Назначение

Возвращает список адресов на которые оформлена подписка участника списка рассылки.

Синтаксис
MailingListRouteMember "domName"|domUID "mlName"|mlUID "address"
Параметр Описание

address

Адрес участника в формате строки.

MailingListGetOwner

Назначение

Возвращает адрес владельца списка рассылки.

Синтаксис
MailingListGetOwner "domName"|domUID "mlName"|mlUID

MailingListSetOwner

Назначение

Устанавливает адрес владельца списка рассылки.

Синтаксис
MailingListSetOwner "domName"|domUID "mlName"|mlUID "address"
Параметр Описание

address

Адрес владельца в формате строки.

MailingListGetSubscription

Назначение

Возвращает статус подписки участника списка рассылки.

Синтаксис
MailingListGetSubscription "domName"|domUID "mlName"|mlUID

MailingListSetSubscription

Назначение

Устанавливает статус подписки участника списка рассылки.

Синтаксис
MailingListSetSubscription "domName"|domUID "mlName"|mlUID "address" "subscription"
Параметр Описание

address

Адрес владельца в формате строки.

subscription

Статус подписки.
Статусы подписки subscription
Статус Описание

normal

Участник может принимать и отправлять сообщения, изменять статус подписки.

silent

Участник может только отправлять сообщения и изменять статус подписки.

special

Участник может отправлять и получать автоматически сгенерированные сообщения, и изменять статус подписки.

suspended

Подписка приостановлена, участник не может отправлять и получать сообщения, а также изменять статус подписки.

Работа с папками

MailBoxesList

Назначение

Выдаёт список папок аккаунта.

Синтаксис
MailBoxesList "domName"|domUID "accName"|accUID optMode ["class"]
Параметр Описание

optMode

Формат имен папок.

0

UTF-8.

1

Modified UTF-7.

2

Имена директорий файловой системы.

MailboxCreate

Назначение

Создаёт папку.

Синтаксис
MailboxCreate "domName"|domUID "accName"|accUID "fullName" ("class")
Поддерживаются классы mail и calendar.

MailboxRename

Назначение

Переименовывает папку.

Синтаксис
MailboxRename "domName"|domUID "accName"|accUID "oldFullName" "newFullName"

MailboxRemove

Назначение

Удаляет папку.

Синтаксис
MailboxRemove "domName"|domUID "accName"|accUID "fullName"

MailboxGetACL

Назначение

Выдает ACL папки.

Синтаксис
MailboxGetACL "domName"|domUID "accName"|accUID "fullName"

MailboxUpdateACL

Назначение

Изменяет ACL папки.

Синтаксис
MailboxUpdateACL "domName"|domUID "accName"|accUID "fullName" "identifier" ("modifier")

MboxGetInfo

Назначение

Выдаёт метаданные папки.

Синтаксис
MboxGetInfo "domName"|domUID "accname"|accUID "mailboxname" "settingskey"

MboxSetInfo

Назначение

Изменяет метаданные папки.

Синтаксис
MboxSetInfo "domName"|domUID "accname"|accUID "mailboxname" "settingskey" (object)

ObjectGetInfo

Назначение

Выдаёт метаданные объекта.

Синтаксис
ObjectGetInfo "domName"|domUID "accname"|accUID "settingskey"

ObjectSetInfo

Назначение

Изменяет метаданные объекта.

Синтаксис
ObjectSetInfo "domName"|domUID "accname"|accUID "settingskey" (object)

ObjectIncInfo

Назначение

Увеличивает значение счетчика объекта.

Синтаксис
ObjectIncInfo "domName"|domUID "accname"|accUID "settingskey" "delta" "limitkey"

ObjectIncTimedInfo

Назначение

Увеличивает значение временного счетчика объекта.

Синтаксис
ObjectIncTimedInfo "domName"|domUID "accname"|accUID "settingskey" "delta" "limitkey"

MailboxGetMyRights

Назначение

Выдаёт права аккаунта на папку.

Синтаксис
MailboxGetMyRights "domName"|domUID "accName"|accUID "fullName"

CalendarGetACL

Назначение

Выдаёт ACL календаря.

Синтаксис
CalendarGetACL "domName"|domUID "accName"|accUID "fullName"

CalendarUpdateACL

Назначение

Изменяет ACL календаря.

Синтаксис
CalendarUpdateACL "domName"|domUID "accName"|accUID "fullName" "identifier" ("modifier")

CalendarGetMyRights

Назначение

Выдаёт права аккаунта на календарь.

Синтаксис
CalendarGetMyRights "domName"|domUID "accName"|accUID "fullName"

Работа с административными правами

RolesList

Назначение

Выдаёт список административных ролей.

Синтаксис
RolesList "dom.name"|domUID|null

RoleCreate

Назначение

Создаёт административную роль.

Синтаксис
RoleCreate "dom.name"|domUID|null "role" ([rights])

RoleRemove

Назначение

Удаляет административную роль.

Синтаксис
RoleRemove "dom.name"|domUID|null "role"

RoleGet

Назначение

Выдаёт список прав роли.

Синтаксис
RoleGet "dom.name"|domUID|null "role"

RoleUpdate

Назначение

Изменяет права роли.

Синтаксис
RoleUpdate "dom.name"|domUID|null "role" [rghtsDel] [rghtsAdd]

AdminsList

Назначение

Выдаёт список администраторов.

Синтаксис
AdminsList "dom.name"|domUID|null

AdminCreate

Назначение

Назначает администратора.

Синтаксис
AdminCreate "dom.name"|domUID|null "user@domain" ([rights])

AdminRemove

Назначение

Удаляет администратора.

Синтаксис
AdminRemove "dom.name"|domUID|null "user@domain"

AdminInfo

Назначение

Выдаёт права администратора.

Синтаксис
AdminInfo "dom.name"|domUID|null "user@domain"

AdminUpdate

Назначение

Изменяет права администратора.

Синтаксис
AdminUpdate "dom.name"|domUID|null "user@domain" [rghtsDel] [rghtsAdd]

AccountGetRights

Назначение

Выдаёт административные права аккаунта.

Синтаксис
AccountGetRights "domName"|domUID "accName"|accUID

Работа со справочником

DirectoryFind

Назначение

Выполняет поиск записей справочника.

Синтаксис
DirectoryFind "base_dn" "scope" "filter" "fields" "sorting" "cookie" limit
Параметр Описание

base_dn

Базовый DN.

scope

Область поиска: base, one, sub.

filter

LDAP-фильтр.

fields

Список атрибутов.

sorting

Параметры сортировки.

cookie

Маркер постраничного вывода.

limit

Максимальное количество записей.

DirectoryAdd

Назначение

Добавляет запись справочника.

Синтаксис
DirectoryAdd "dn" "{attributes}"

DirectoryUpdate

Назначение

Изменяет запись справочника.

Синтаксис
DirectoryUpdate "dn" "{changed_attributes}" "server"

DirectoryMove

Назначение

Перемещает запись справочника.

Синтаксис
DirectoryMove "dn" "new_dn"

DirectoryRemove

Назначение

Удаляет запись справочника.

Синтаксис
DirectoryRemove "dn"

Работа со справочником PostgreSQL

PgDirectoryFind

Назначение

Выполняет поиск в PostgreSQL-справочнике.

Синтаксис
PgDirectoryFind "base_dn" "scope" "filter" ["field"] "sorting" "cookie" limit "server"

PgDirectoryAdd

Назначение

Добавляет запись в PostgreSQL-справочник.

Синтаксис
PgDirectoryAdd "dn" "attributes" "server"

PgDirectoryUpdate

Назначение

Изменяет запись PostgreSQL-справочника.

Синтаксис
PgDirectoryUpdate "dn" "changed_attributes" "server"

PgDirectoryMove

Назначение

Перемещает запись PostgreSQL-справочника.

Синтаксис
PgDirectoryMove "dn" "new_dn" "server"

PgDirectoryRemove

Назначение

Удаляет запись PostgreSQL-справочника.

Синтаксис
PgDirectoryRemove "dn" "server"

Клиент LDAP

LdapClientSearch

Назначение

Выполняет LDAP-поиск.

Синтаксис
LdapClientSearch "base_dn" "scope" "deref" "filter" ["field"] "attrsonly|all" size.limit time.limit "sorting" "cookie" "server"
Параметр Описание

base_dn

Базовый DN.

scope

Область поиска.

deref

Режим разыменования ссылок.

filter

LDAP-фильтр.

fields

Атрибуты результата.

attrsonly|all

Возвращать только атрибуты или атрибуты и значения.

size.limit

Максимальное число записей.

time.limit

Максимальное время выполнения.

sorting

Параметры сортировки.

cookie

Маркер страницы.

server

URI LDAP-сервера.

Работа с сессиями

SessionList

Назначение

Выдаёт список сессий.

Синтаксис
SessionList

SessionCreate

Назначение

Создаёт сессию.

Синтаксис
SessionCreate "domName"|domUID "accname"|accUID

SessionClose

Назначение

Закрывает сессию.

Синтаксис
SessionClose "string"

SessionGetInfo

Назначение

Выдаёт данные сессии.

Синтаксис
SessionGetInfo "string"

SessionUpdateInfo

Назначение

Изменяет данные сессии.

Синтаксис
SessionUpdateInfo "string" object

SessionSendEvent

Назначение

Отправляет событие в сессию.

Синтаксис
SessionSendEvent "string" object