CommuniGate Pro: Интерфейс Командной Строки / API

Сервер CommuniGate Pro поддерживает несколько способов обращения к CLI:

через TCP соединения к PWD модулю (расширение PWD/poppwd протокола)
через CG/PL команду ExecuteCLI.
через HTTP область CLI.

Когда CLI используется через PWD соединение, то команды CLI принимаются как только пользователь был аутентифицирован. Для каждой команды CLI Сервер проверяет права доступа аутентифицированного пользователя.

Если команда возвращает какие-либо данные, то данные отправляются сразу после строки протокола, на которой находится положительный ответ. Комбинация CR-LF отправляется после данных.

Ниже приводится пример PWD сессии, содержащей команды CLI:

C: telnet servername.com 106
S: 200 CommuniGate Pro at mail.servername.com PWD Server 5.3 ready
C: USER postmaster
S: 300 please send the PASS
C: PASS postmasterpassword
S: 200 login OK
C: CreateAccount "user1"
S: 200 OK
C: CreateAccount "user1"
S: 501 Account with this name already exists
C: RenameAccount "user1" into "user2"
S: 200 OK
C: CreateDomain "client1.com"
S: 200 OK
C: CreateAccount "user1@client1.com" TextMailbox
S: 200 OK
C: ListDomains
S: 200 data follow
S: (mail.servername.com, client1.com, client2.com)
C: QUIT
S: 200 CommuniGate Pro PWD connection closed

В документе Perl Интерфейс CommuniGate Pro (на английском языке) содержится описание и набор утилит на языке Perl, позволяющий Perl-скриптам получать доступ к CLI API CommuniGate Pro через протокол PWD. В документе также содержатся ссылки на несколько полезных примеров Perl-скриптов (автоматизирующих создание и удаление Пользователей и т.п.))

В документе Java Интерфейс CommuniGate Pro (на английском языке) содержится описание и набор классов на языке Java, позволяющий Java программам получать доступ к CLI API CommuniGate Pro через протокол PWD. В документе также содержатся ссылки на несколько полезных примеров Java программ.

CLI Интерфейс CommuniGate Pro использует стандартные Форматы Данных для разбора команд и вывода результатов.

Обратите внимание: Правила Синтаксиса формата Словарь позволяют вам задавать строку без знаков кавычки, если в строке содержатся только алфавитно-цифровые символы.

Синтаксис CLI

CLI Интерфейс CommuniGate Pro использует стандартные Форматы Данных для разбора команд и вывода результатов.

Обратите внимание: Правила Синтаксиса формата Словарь позволяют вам задавать строку без знаков кавычки, если в строке содержатся только алфавитно-цифровые символы. Вы должны использовать знак кавычки, если в строке содержится точка (.), запятая (,) или другие не алфавитно-цифровые символы.

Несмотря на то, что в стандартных форматах Данных могут использовать несколько текстовых строк, все задаваемые вами в качестве параметров CLI данные (включая массивы и словари) должны находиться в одной командной строке.

Если команда CLI возвращает какие-либо данные в в формате массива или словаря, то эти выходные данные могут располагаться на нескольких строках.

Администрирование Доменов

Пользователь должен иметь право доступа к области Пользователи Сервера для использования команд CLI по Администрированию Доменов.

Следующие команды доступны только для Администраторов Системы:

LISTDOMAINS: Используйте эту команду для получения списка доменов. Эта команда возвращает массив, в котором содержатся имена всех доменов сервера.
MAINDOMAINNAME: Используйте эту команду для получения имени Главного Домена. Эта команда возвращает данные - строку с именем Главного Домена.
GETDOMAINDEFAULTS: Используйте эту команду для получения Умолчаний для Домена, Общих для Сервера. Эта команда возвращает словарь, в котором содержатся Умолчания для Домена.
UPDATEDOMAINDEFAULTS newSettings: Используйте эту команду для изменения Умолчаний для Домена, Общих для Сервера.

newSettings : dictionary

Этот словарь используется для изменения словаря с Умолчаниями для Домена. Он не обязан содержать в себе все настройки; отсутствующие в словаре настройки просто не будут изменены.
SETDOMAINDEFAULTS newSettings: Используйте эту команду для изменения Умолчаний для Домена, Общих для Сервера.

newSettings : dictionary

Этот словарь используется для замещения словаря общесерверных Умолчаний для Домена.
GETCLUSTERDOMAINDEFAULTS UPDATECLUSTERDOMAINDEFAULTS newSettings SETCLUSTERDOMAINDEFAULTS newSettings: Эти команды доступны только в Динамическом Кластере.
Используйте эти команды вместо команд [GET|UPDATE|SET]DOMAINDEFAULTS для работы с общекластерными Умолчаниями для Домена.
GETSERVERACCOUNTDEFAULTS: Используйте эту команду для получения общесерверных Умолчаний для Пользователя. Эта команда возвращает словарь, в котором содержатся глобальные Умолчания для Пользователей.
UPDATESERVERACCOUNTDEFAULTS newSettings: Используйте эту команду для изменения общесерверных Умолчаний для Пользователя.

newSettings : dictionary

Этот словарь используется для изменения словаря с Умолчаниями для Пользователя. Он не обязан содержать в себе все настройки; отсутствующие в словаре настройки просто не будут изменены.
SETSERVERACCOUNTDEFAULTS newSettings: Используйте эту команду для задания общесерверных Умолчаний для Пользователя.

newSettings : dictionary

Этот словарь используется для замещения словаря общесерверных Умолчаний для Домена.
GETCLUSTERACCOUNTDEFAULTS UPDATECLUSTERACCOUNTDEFAULTS newSettings SETCLUSTERACCOUNTDEFAULTS newSettings: Эти команды доступны только в Динамическом Кластере.
Используйте эти команды вместо команд [GET|UPDATE|SET]SERVERACCOUNTDEFAULTS для работы с общими для кластера Умолчаниями для Домена.
GETSERVERACCOUNTPREFS: Используйте эту команду для получения общесерверных Настроек Пользователя по умолчанию. Эта команда возвращает словарь, в котором содержатся Настройки, применяемый по умолчанию.
SETSERVERACCOUNTPREFS newSettings: Используйте эту команду для изменения Настроек Пользователя по умолчанию, Общих для Сервера.

newSettings : dictionary

Этот словарь используется для замещения словаря Общих для Сервера Настроек Пользователя по умолчанию. Все старые Общие для Сервера Настройки Пользователя, применяемые по умолчанию удаляются.
UPDATESERVERACCOUNTPREFS newSettings: Используйте эту команду для изменения Настроек Пользователя по умолчанию, Общих для Сервера.

newSettings : dictionary

Этот словарь используется для изменения Настроек в Умолчаниях для Пользователя. Он не обязан содержать в себе все настройки; отсутствующие в словаре Настройки просто не будут изменены.
GETCLUSTERACCOUNTPREFS SETCLUSTERACCOUNTPREFS newSettings UPDATECLUSTERACCOUNTPREFS newSettings: Эти команды доступны только в Динамическом Кластере.
Используйте эти команды вместо команд [GET|SET|UPDATE]SERVERACCOUNTPREFS для работы с Общими для Кластера Настройками Пользователя по Умолчанию.
CREATEDOMAIN domainName [ settings ]: Используйте эту команду для создания нового Домена.

domainName : string

Этот параметр указывает имя Домена, которое необходимо создать.

settings : dictionary

Этот опциональный параметр задаёт Установки Домена.
RENAMEDOMAIN oldDomainName into newDomainName: Используйте эту команду для переименования Домена.

oldDomainName : string

Этот параметр указывает имя существующего Домена.

newDomainName : string

Этот параметр указывает новое имя Домена.
DELETEDOMAIN oldDomainName [ force ]: Используйте эту команду для удаления Домена.

domainName : string

В этом параметре задаётся имя Домена, который должен быть удалён.

force

Этот опциональный параметр указывает, что Домен должен быть удалён, даже если он не пустой. Все объекты Домена (Пользователи, Группы и т.д.) будут удалены.
CREATESHAREDDOMAIN domainName [ settings ]: Используйте эту команду для создания нового общего Домена в Динамическом Кластере.

domainName : string

Этот параметр указывает имя Домена, которое необходимо создать.

settings : dictionary

Этот опциональный параметр задаёт Установки Домена.
CREATEDIRECTORYDOMAIN domainName [ settings ]: Используйте эту команду для создания нового directory-based Домена.

domainName : string

Этот параметр указывает имя Домена, которое необходимо создать.

settings : dictionary

Этот опциональный параметр задаёт Установки Домена.

Эта операция может быть выполнена, только если использование Directory-Based Доменов разрешено.
RELOADDIRECTORYDOMAINS: Используйте эту команду для указания серверу просканировать поддеревья Доменов в Справочнике и найди все дополнительные Directory-Based Домены, созданные непосредственно в Справочнике, минуя Сервер CommuniGate Pro.
Эта операция может быть выполнена, только если использование Directory-Based Доменов разрешено.
LISTSERVERTELNUMS [ FILTER filter] limit: Используйте эту команду для чтения номеров Telnum, созданных во всех Доменах (не кластерных). Эта команда возвращает словарь, в котором каждый элемент является номером Telnum, а значение элемента - это имя Пользователя, которому этот номер назначен. Для пустого ключа "" добавляется числовой элемент, содержащий общее число созданных номеров Telnum.

filter : string

Если этот опциональный параметр указан, то возвращаются только те номера Telnum, в которых содержится указанная строка.

limit : number

Максимальное количество возвращаемых номеров Telnum.
LISTCLUSTERTELNUMS [ FILTER filter] limit: Аналогично команде LISTSERVERTELNUMS, но для общих кластерных Доменов.
GETSERVERTRUSTEDCERTS: Используйте эту команду для получения общесерверного набора Доверенных Сертификатов. Эта команда возвращает массив из блоков данных. В каждом блоке данных содержатся данные одного X.509 Сертификата.
SETSERVERTRUSTEDCERTS newCertificates: Используйте эту команду для установки общесерверного набора Доверенных Сертификатов.

newCertificates : array

Этот массив должен содержать блоки данных с данными сертификатов в соответствии с X.509. Этот массив используется для замещения общесерверного списка Доверенных Сертификатов.
GETCLUSTERTRUSTEDCERTS SETCLUSTERTRUSTEDCERTS newCertificates: Эти команды доступны только в Динамическом Кластере.
Используйте эти команды вместо команд [Get|Set]ServerTrustedCerts для работы с общекластерным набором Доверенных Сертификатов.
GETDIRECTORYINTEGRATION: Используйте эту команду для получения общесерверных настроек Центрального Справочника. Эта команда возвращает словарь, в котором содержатся настройки Центрального Справочника.
SETDIRECTORYINTEGRATION newSettings: Используйте эту команду для задания общесерверных настроек Центрального Справочника.

newSettings : dictionary

Этот словарь используется для замещения словаря общесерверных настроек Центрального Справочника.
GETCLUSTERDIRECTORYINTEGRATION SETCLUSTERDIRECTORYINTEGRATION newSettings: Эти команды доступны только в Динамическом Кластере.
Используйте эти команды вместо команд [Get|Set]DirectoryIntegration для работы с общекластерными настройками Центрального Справочника.

Администрирование Домена

Для использования команд CLI по Администрированию Домена необходимо иметь право доступа к области Пользователи Сервера или обладать правами доступа по Администрированию Домена.

GETDOMAINSETTINGS [ domainName ]: Используйте эту команду для получения установок Домена. Эта команда возвращает словарь, в котором содержатся установки Домена. В словарь включаются только те установки, которые заданы явно (не являются установками по умолчанию).

domainName : string

Этот опциональный параметр указывает имя существующего Домена.
GETDOMAINEFFECTIVESETTINGS [ domainName ]: Используйте эту команду для получения установок Домена. Эта команда возвращает словарь, в котором содержатся установки Домена. В этот словарь включается как набор явно заданных настроек, так и набор настроек, применяемых по умолчанию.

domainName : string

Этот опциональный параметр указывает имя существующего Домена.
UPDATEDOMAINSETTINGS [ domainName ] newSettings: Используйте эту команду для изменения установок Домена.

domainName : string

Этот опциональный параметр указывает имя существующего Домена.

newSettings : dictionary

Этот словарь используется для изменения словаря с установками Домена. Он не обязан содержать в себе все установки; отсутствующие в словаре установки просто не будут изменены. Если новое значение установки указано как строка default, то значения установок Домена удаляются и вместо них используются установки Домена, применяемые по умолчанию.

Если эта команда используется Администратором Домена, то она будет изменять только те установки Домена, которые этому Администратору разрешается изменять.
GETACCOUNTDEFAULTS [ domainName ]: Используйте эту команду для получения Умолчаний для Пользователя в указанном Домене. Эта команда возвращает словарь, в котором содержатся установки по умолчанию.

domainName : string

Этот опциональный параметр указывает имя Домена. Если имя Домена не указано, то команда применяется к Домену Администратора.
UPDATEACCOUNTDEFAULTS [ domainName ] newSettings: Используйте эту команду для изменения Умолчаний для Пользователя в указанном Домене.

domainName : string

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

newSettings : dictionary

Этот словарь используется для изменения Умолчаний для Пользователя в указанном Домене. Словарь не обязан содержать в себе все установки; отсутствующие в словаре установки просто не будут изменены. Если новое значение установки указано как строка default, то значения установок удаляются и вместо них используются глобальные общесерверные Умолчания для Пользователя.

Если эта команда используется Администратором Домена, то она будет изменять только те Умолчания для Пользователя, которые этому Администратору разрешается изменять.
GETACCOUNTDEFAULTPREFS [ domainName ]: Используйте эту команду для получения Настроек Пользователя по умолчанию, действующих в указанном Домене. Эта команда возвращает словарь, в котором содержатся Настройки, применяемый по умолчанию.

domainName : string

Этот опциональный параметр указывает имя Домена. Если имя Домена не указано, то команда применяется к Домену администратора.
SETACCOUNTDEFAULTPREFS [ domainName ] newSettings: Используйте эту команду для изменения Настроек Пользователя, применяемых в указанном Домене по умолчанию.

domainName : string

Этот опциональный параметр указывает имя Домена. Если имя Домена не указано, то команда применяется к Домену аутентифицированного пользователя.

newSettings : dictionary

Этот словарь используется для замещения Настроек Пользователя, применяемых в указанном Домене по умолчанию. Все старые Настройки Пользователя по умолчанию при этом удаляются.

Эта команда может использоваться Администраторами Домена, только если они имеют право доступа Настройки.
UPDATEACCOUNTDEFAULTPREFS [ domainName ] newSettings: Используйте эту команду для изменения Настроек Пользователя, применяемых в указанном Домене по умолчанию.

domainName : string

Этот опциональный параметр указывает имя Домена. Если имя Домена не указано, то команда применяется к Домену аутентифицированного пользователя.

newSettings : dictionary

Этот словарь используется для изменения Настроек Пользователя, применяемых в указанном Домене по умолчанию. Он не обязан содержать в себе все Настройки; отсутствующие в словаре настройки просто не будут изменены.
Если новое значение элемента указано как строка default, то значения Настроек по умолчанию удаляются и вместо них используются Общие для Сервера (или Общие для Кластера) Настройки Пользователя, применяемые по умолчанию.

Эта команда может использоваться Администраторами Домена, только если они имеют право доступа Настройки.
GETACCOUNTTEMPLATE [ domainName ]: Используйте эту команду для получения настроек Шаблона Пользователя. Эта команда возвращает словарь, в котором содержатся настройки Шаблона.

domainName : string

Этот опциональный параметр указывает имя Домена. Если имя Домена не указано, то команда применяется к Домену администратора.
UPDATEACCOUNTTEMPLATE [ domainName ] newSettings: Используйте эту команду для изменения настроек Шаблона Пользователя.

domainName : string

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

newSettings : dictionary

Этот словарь используется для изменения Шаблона Пользователя Домена. Все новые Пользователи в указанном Домене будут создаваться с настройками из Шаблона. Словарь не обязан содержать в себе все настройки; отсутствующие настройки просто не будут изменены. Если новое значение настройки указано как строка default, то значения настроек Шаблона удаляются.

Если эта команда используется Администратором Домена, то она будет изменять только с те настройки Шаблона, которые этому Администратору разрешается изменять.
GETDOMAINALIASES domainName: Используйте эту команду для получения списка Псевдонимов Домена. Эта команда возвращает массив с именами псевдонимов Домена.

domainName : string

В этом параметре задаётся имя существующего Домена.
GETDOMAINMAILRULES domainName: Используйте эту команду для получения списка Правил Домена по обработке Очереди. Эта команда возвращает массив Правил обработки Очереди, заданных для Домена.

domainName : string

В этом параметре задаётся имя существующего Домена.
SETDOMAINMAILRULES domainName newRules: Используйте эту команду для задания Правил обработки Очереди Домена.

domainName : string

В этом параметре задаётся имя существующего Домена.

newRules : array

Этот массив должен содержать Правила обработки Очереди Домена. Все старые Правила обработки Очереди Домена при этом удаляются.

Эта команда может использоваться Администраторами Домена, только если они имеют право доступа Разрешённые Правила для Почты.
GETDOMAINSIGNALRULES domainName: Используйте эту команду для получения списка Правил обработки Сигналов Домена. Эта команда возвращает массив Правил обработки Сигналов, заданных для Домена.

domainName : string

В этом параметре задаётся имя существующего Домена.
SETDOMAINSIGNALRULES domainName newRules: Используйте эту команду для задания Правил обработки Сигналов для Домена.

domainName : string

В этом параметре задаётся имя существующего Домена.

newRules : array

Этот массив должен содержать Правила обработки Сигналов Домена. Все старые Правила обработки Сигналов Домена при этом удаляются.

Эта команда может использоваться Администраторами Домена, только если они имеют право доступа Разрешённые Правила для Звонков.
LISTADMINDOMAINS [ domainName ]: Используйте эту команду для получения списка всех Доменов, которые могут администрироваться Пользователями Администраторами Домена из указанного Домена domainName. Эта команда возвращает массив имён Домена.

domainName : string

Этот опциональный параметр указывает имя Домена. Если имя Домена не указано, то команда применяется к Домену аутентифицированного пользователя.
LISTDOMAINOBJECTS domainName [ FILTER filter ] limit [ ACCOUNTS ] [ ALIASES ] [ FORWARDERS ] [COOKIE cookie: Используйте эту команду для получения списка объектов Домена.

domainName : string

Этот параметр указывает имя Домена.

filter : string

Этот опциональный параметр задаёт строку-фильтр: возвращаются только те объекты, имена которых включают в себя строку-фильтр как подстроку.

limit : numeric string

В этом параметре задаётся максимальное число объектов в списке.

ACCOUNTS, ALIASES, FORWARDERS

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

cookie : string

Этот опциональный параметр указывает строку с "cookie".

Эта команда возвращает массив, в котором содержатся следующим элементы:

цифровая строка с общим числом Пользователей в Домене

словарь с Объектами Домена. Каждый ключ словаря является именем Объекта Домена. Значения словаря зависят от типа Объекта Домена:

Пользователь

объектами словаря являются строки (расширение файла Account)

Псевдоним Пользователя

объект словаря является массивом. Его единственным элементом является строка с именем оригинального Пользователя - владельца.

Переадресатор

объект словаря является массивом. Его единственным элементом является массив. Его единственным элементом является строка с адресом Переадресатора.

числовая строка с общим количеством Псевдонимов Домена.

числовая строка с общим количеством Переадресаторов Домена.

новая строка с "cookie" (опционально, существует только если в команде была часть COOKIE cookie.

Для перечисления Объектов в больших Доменах указывайте какое-нибудь разумное значение limit (менее 10,000) и задавайте пустую строку cookie. Если возвращаются не все Объекты, ты выполните эту команду повторно, используя новое значение cookie, указанное в возвращаемом массиве. Если возвращаются все Объекты, то новое значение cookie в ответе является пустой строкой.
LISTACCOUNTS [ domainName ]: Используйте эту команду для получения списка всех Пользователей в Домене. Эта команда возвращает словарь с ключами, в которых перечислены все Пользователи из указанного (или взятого по умолчанию) Домена.

domainName : string

Этот опциональный параметр указывает имя Домена. Если имя Домена не указано, то команда применяется к Домену администратора.
LISTDOMAINTELNUMS domainName [ FILTER filter] limit: Используйте эту команду для чтения номеров Telnum, созданных в указанном Домене. Эта команда возвращает словарь, в котором каждый элемент является номером Telnum, а значение элемента - это имя Пользователя, которому этот номер назначен. Для пустого ключа "" добавляется числовой элемент, содержащий общее число созданных номеров Telnum.

domainName : string

Этот параметр указывает имя Домена.

filter : string

Если этот опциональный параметр указан, то возвращаются только те номера Telnum, в которых содержится указанная строка.

limit : number

Максимальное количество возвращаемых номеров Telnum.
INSERTDIRECTORYRECORDS domainName: Используйте эту команду для того, что бы вставить записи Объектов Домена (Пользователи, Группы, Списки Рассылки, Переадресаторы) в Справочник.

domainName : string

Этот опциональный параметр указывает имя Домена. Если имя Домена не указано, то команда применяется к Домену аутентифицированного пользователя.

Эта команда может использоваться Администраторами Домена, только если они имеют право доступа Центральный Справочник.
DELETEDIRECTORYRECORDS domainName: Используйте эту команду для удаления записей объекта Домена из Справочника.

domainName : string

Этот опциональный параметр указывает имя Домена. Если имя Домена не указано, то команда применяется к Домену аутентифицированного пользователя.

Эта команда может использоваться Администраторами Домена, только если они имеют право доступа Центральный Справочник.

Следующие команды доступны только для Администраторов Системы:

SETDOMAINALIASES domainName newAliases: Используйте эту команду для задания псевдонимов Домена.

domainName : string

В этом параметре задаётся имя существующего Домена.

newAliases : array

Этот массив должен содержать строки с именами псевдонимов Домена. Все старые псевдонимы Домена при этом удаляются.
SETDOMAINSETTINGS domainName newSettings: Используйте эту команду для изменения установок Домена.

domainName : string

В этом параметре задаётся имя существующего Домена.

newSettings : dictionary

Этот словарь используется для замещения словаря установок Домена. Все старые установки Домена при этом удаляются.
SETACCOUNTDEFAULTS [ domainName ] newSettings: Используйте эту команду для изменения Умолчаний для Пользователя в указанном Домене.

domainName : string

Этот параметр указывает имя Домена.

newSettings : dictionary

Этот словарь используется для замещения Умолчаний для Пользователя в указанном Домене. Все старые Умолчания для Пользователя при этом удаляются.
SETACCOUNTTEMPLATE [ domainName ] newSettings: Используйте эту команду для изменения настроек Шаблона Пользователя.

domainName : string

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

newSettings : dictionary

Этот словарь используется для изменения Шаблона Пользователя Домена. Все новые Пользователи в указанном Домене будут создаваться с настройками из Шаблона. Все старые настройки Шаблона Пользователя при этом удаляются.
GETDOMAINLOCATION [ domainName ]: Используйте эту команду для получения пути к файловой директории Домена (относительно директории данных Сервера). Эта команда возвращает строку с путём к файловой директории Домена.

domainName : string

Этот опциональный параметр указывает имя Домена. Если имя Домена не указано, то команда применяется к Домену администратора.
SUSPENDDOMAIN domainName: Используйте эту команду для приостановки Домена; все текущие активные сессии Пользователей Домена закрываются и не не могут быть открыты снова.

domainName : string

В этом параметре задаётся имя Домена, который должен быть приостановлен.
RESUMEDOMAIN domainName: Используйте эту команду для возобновления работы Домена; Пользователи смогут обслуживаться в этом Домене.

domainName : string

В этом параметре задаётся имя Домена, работа которого должна быть возобновлена.

Администрирование Пользователей

Для использования команд CLI по администрированию Пользователей необходимо иметь право доступа к области Пользователи Сервера или обладать правами доступа по Администрированию Домена.

CREATEACCOUNT accountName [accountType] [ external ] [settings]: Используйте эту команду для создания новых пользователей.

accountName : string

Этот параметр задаёт имя нового Пользователя.
Имя может содержать символ @, за которым следует имя Домена; в этом случае Пользователь создаётся в указанном Домене. Если имя Домена не указано, то команда применяется к Домену администратора.

accountType : MultiMailbox | TextMailbox | MailDirMailbox | AGrade | BGrade | CGrade

Этот опциональный параметр указывает тип создаваемого Пользователя. Если тип Пользователя не указан, то создаётся Пользователь с типом MultiMailbox (Набор Папок).

external

Этот опциональный флаг указывает системе создавать Пользователя с внешним (доступным старым почтовым программам) INBOX.

settings : dictionary

Этот опциональный параметр задаёт начальные установки Пользователя. Пользователь создаётся, используя установки, указанные в Шаблоне Пользователя для выбранного Домена. Если указан параметр settings, то он используется для изменения установок из Шаблона.

Эта команда может использоваться Администраторами Домена, только если они имеют право доступа Может создавать Пользователей.
Если эта команда используется Администратором Домена, то она будет работать только с теми установками Пользователя, которые этому Администратору разрешается изменять.
RENAMEACCOUNT oldAccountName into newAccountName: Используйте эту команду для переименования Пользователей.

oldAccountName : string

В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена (смотрите выше).

newAccountName : string

В этом параметре задаётся имя нового Пользователя. Имя может включать в себя имя Домена (смотрите выше).

Эта команда может использоваться Администраторами Домена, только если они имеют право доступа Может создавать Пользователей.
DELETEACCOUNT oldAccountName: Используйте эту команду для удаления Пользователя.

oldAccountName : string

В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена (смотрите выше).

Эта команда может использоваться Администраторами Домена, только если они имеют право доступа Может создавать Пользователей.
SETACCOUNTTYPE accountName accountType: Используйте эту команду для изменения типа Пользователя.

accountName : string

В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена (смотрите выше).

accountType : MultiMailbox | AGrade | BGrade | CGrade

В этом параметре задаётся новый тип Пользователя. Тип текущего Пользователя также должен принадлежать к этому типу.

Эта команда может использоваться Администраторами Домена, только если они имеют право доступа Может создавать Пользователей.
GETACCOUNTSETTINGS accountName: Используйте эту команду для получения установок Пользователя. Эта команда возвращает словарь, в котором содержатся установки Пользователя. В словарь включаются только те установки Пользователя, которые заданы явно (не являются установками по умолчанию).

accountName : string

В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена (смотрите выше).
Вместо имени Пользователя вы также можете указать один символ звёздочка (*). Это будет означать текущего аутентифицированного Пользователя.

Обратите внимание: Все пользователи могут отправлять команду GETACCOUNTSETTINGS для самих себя.
UPDATEACCOUNTSETTINGS accountName newSettings: Используйте эту команду для изменения установок Пользователя.

accountName : string

В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена (смотрите выше).

newSettings : dictionary

Этот словарь используется для изменения словаря установок Пользователя. Он не обязан содержать в себе все установки; отсутствующие в словаре установки просто не будут изменены. Если новое значение установки указано как строка default, то значения установок Пользователя удаляются и вместо них используются установки Пользователя, применяемые по умолчанию.

Если эта команда используется Администратором Домена, то она будет изменять только те установки Пользователя, которые этому Администратору разрешается изменять.
GETACCOUNTEFFECTIVESETTINGS accountName: Используйте эту команду для получения действующих установок Пользователя. Эта команда возвращает словарь, в котором содержатся установки Пользователя. В словарь включаются как набор явно заданных установок Пользователя, так и набор установок, применяемый по умолчанию.

accountName : string

В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена (смотрите выше).
Вместо имени Пользователя вы также можете указать один символ звёздочка (*). Это будет означать текущего аутентифицированного Пользователя.

Обратите внимание: Все пользователи могут отправлять команду GETACCOUNTEffectiveSettings для самих себя.
SETACCOUNTPASSWORD accountName PASSWORD newPassword: Используйте эту команду для изменения пароля Пользователя.

accountName : string

В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена (смотрите выше).

newPassword : string

Эта строка используется для указания нового пароля пользователя. Новый пароль будет сохранён с использованием действующей установки Шифрование Пароля для этого Пользователя.

Для использования этой команды необходимо обладать для Домена Пользователя правом Администратора Домена "Основные Установки".
VERIFYACCOUNTPASSWORD accountName PASSWORD password: Используйте эту команду для проверки пароля Пользователя.

accountName : string

В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена (смотрите выше).

password : string

Эта строка используется для указания проверяемого пароля (в открытом текстовом формате)

Для использования этой команды необходимо обладать какими-нибудь правами Администрирования Домена в Домене этого Пользователя.
GETACCOUNTALIASES accountName: Используйте эту команду для получения списка псевдонимов Пользователя. Эта команда возвращает массив с именами псевдонимов Пользователя.

accountName : string

В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена (смотрите выше).
SETACCOUNTALIASES accountName newAliases: Используйте эту команду для задания псевдонимов Пользователя.

accountName : string

В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена (смотрите выше).

newAliases : array

Этот массив должен содержать строки с именами псевдонимов Пользователя. Старые псевдонимы Пользователя при этом удаляются.

Эта команда может использоваться Администраторами Домена, только если они имеют право доступа Может создавать Псевдонимы.
GETACCOUNTTELNUMS accountName: Используйте эту команду для получения списка телефонных номеров, присвоенных Пользователю. Эта команда возвращает массив присвоенных телефонных номеров.

accountName : string

В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена (смотрите выше).
SETACCOUNTTELNUMS accountName newAliases: Используйте эту команду для присвоения Пользователю телефонных номеров.

accountName : string

В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена (смотрите выше).

newAliases : array

Этот массив должен содержать строки с телефонными номерами. Все ранее присвоенные Пользователю телефонные номера удаляются.

Эта команда может использоваться Администраторами Домена, только если они имеют право доступа Может присваивать Телефонные Номера.
GETACCOUNTMAILRULES accountName: Используйте эту команду для получения списка Правил обработки Очереди, существующих у Пользователя. Эта команда возвращает массив Правил обработки Очереди, заданных для Пользователя.

accountName : string

В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена (смотрите выше).
SETACCOUNTMAILRULES accountName newRules: Используйте эту команду для задания Правил обработки Очереди для Пользователя.

accountName : string

В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена (смотрите выше).

newRules : array

Этот массив должен содержать Правила обработки Очереди Пользователя. Все старые Правила обработки Очереди Пользователя при этом удаляются.

Эта команда может использоваться Администраторами Домена, только если они имеют право доступа Разрешённые Правила для Почты.
Эта команда может использоваться любым Пользователем для изменения собственных Правил (в соответствии с ограничениями, налагаемыми "разрешёнными действиями").
GETACCOUNTSIGNALRULES accountName: Используйте эту команду для получения списка Правил обработки Сигналов, существующих у Пользователя. Эта команда возвращает массив Правил обработки Сигналов, заданных для Пользователя.

accountName : string

В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена (смотрите выше).
SETACCOUNTSIGNALRULES accountName newRules: Используйте эту команду для задания Правил обработки Сигналов для Пользователя.

accountName : string

В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена (смотрите выше).

newRules : array

Этот массив должен содержать Правила обработки Сигналов Пользователя. Все старые Правила обработки Сигналов Пользователя при этом удаляются.

Эта команда может использоваться Администраторами Домена, только если они имеют право доступа Разрешённые Правила для Звонков.
UPDATEACCOUNTMAILRULE accountName newRule UPDATEACCOUNTMAILRULE accountName DELETE oldRule UPDATEACCOUNTSIGNALRULE accountName newRule UPDATEACCOUNTSIGNALRULE accountName DELETE oldRule: Используйте эти команды для изменения Правил обработки Очереди/Сигналов Пользователя.

accountName : string

В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена (смотрите выше).

newRule : array

Этот параметр должно быть массивом, первый элемент которого задаёт приоритет Правила, а второй задаёт имя Правила. Опциональные третий, четвертый и пятый элементы задают условия Правил, Действия Правил и комментарии к Правилам.
Если массив параметров содержит менее четырёх элементов, то первый элемент используется для изменения приоритета существующего Правила, имя которого задаётся во втором элементе массива. Если такое Правило не существует, то команда возвращает ошибку.
Если массив параметров содержит 4 или более элементов, то весь массив параметров сохраняется как новое Правило. Если есть существующее Правило с таким же именем, то оно удаляется.

oldRule : string

Эта строка-параметр (указываемая после ключевого слова DELETE) задаёт имя Правила, которое должно быть удалено. Если такое Правило не существует, то команда не совершает никаких операций и не возвращает ошибку.

Команда UpdateAccountMailRule может использоваться Администраторами Домена, только если они имеют право доступа Разрешённые Правила для Почты.
Команда UpdateAccountSignalRule может использоваться Администраторами Домена, только если они имеют право доступа Разрешённые Правила для Звонков.
Эта команда может использоваться любым Пользователем для изменения собственных Правил (в соответствии с ограничениями, налагаемыми "разрешёнными действиями").
GETACCOUNTRPOP accountName: Используйте эту команду для получения списка RPOP записей. Эта команда возвращает массив RPOP записей, заданных для Пользователя.

accountName : string

В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена (смотрите выше).
SETACCOUNTRPOP accountName newRecords: Используйте эту команду для изменения RPOP записей пользователя.

accountName : string

В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена (смотрите выше).

newRecords : array

Этот массив должен содержать RPOP записи Пользователя. Старые RPOP записи Пользователя при этом удаляются.

Эта команда может использоваться Администраторами Домена, только если они имеют право доступа Модификации RPOP.
GETACCOUNTRIGHTS accountName: Используйте эту команду для получения массива прав доступа к Серверу или Домену, предоставленных указанному пользователю. Эта команда возвращает данные - массив, в котором перечисляются все Права доступа Пользователя к Серверу.

accountName : string

В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена.
GETACCOUNTINFO accountName [Key keyName | ( keyList) ]: Используйте эту команду для получения словаря с "информацией" о Пользователе. Эта команда возвращает данные (смотрите ниже).

accountName : string

В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена (смотрите выше). Вместо имени Пользователя вы также можете указать один символ звёздочка (*). Это будет означать текущего аутентифицированного Пользователя.

keyList : array

Этот опциональный параметр задаёт имена ключей с информацией, которые необходимо получить.
Обратите внимание, что "информационные" данные Пользователя хранятся в хранятся словарях в файлах .info, а имена словарей "инфо" элементов начинаются с символа решётка (#). Вы НЕ должны включать символ решётка в параметр keyName команды GETACCOUNTINFO.
Пример:
GETACCOUNTINFO "user1@domain1.com" (LastLogin LastLoginAddress)
Обратите внимание: имена "инфо"-элементов зависимы от регистра клавиатуры.
Команда возвращает словарь всех существующих и указанных в массиве keyList "инфо"-элементов.

keyName : string

Этот опциональный параметр указывает имя требуемого "инфо"-элемента. Оно может быть указано только в том случае, если параметр keyList не задан.
Обратите внимание, что "информационные" данные Пользователя хранятся в хранятся словарях в файлах .info, а имена словарей "инфо" элементов начинаются с символа решётка. Вы НЕ должны включать символ решётка в параметр keyName команды GETACCOUNTINFO.
Пример:
GETACCOUNTINFO "user1@domain1.com" Key LastLogin
Обратите внимание: имена "инфо"-элементов зависимы от регистра клавиатуры.
Команда возвращает указанный "инфо"-элемент. Если элемент не найден, то команда возвращает пустую строку - два знака кавычек подряд ("").

Обратите внимание: Все пользователи могут использовать команду GETACCOUNTINFO для получения элементов из своих собственных "инфо"-данных.
GETACCOUNTPREFS accountName: Используйте эту команду для получения Настроек Пользователя. Эта команда возвращает словарь, в котором содержатся Настройки Пользователя.

accountName : string

В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена (смотрите выше).

Обратите внимание: Все пользователи могут использовать команду GETACCOUNTPREFS для получения своих Настроек.
UPDATEACCOUNTPREFS accountName newSettings: Используйте эту команду для изменения Настроек Пользователя.

accountName : string

В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена (смотрите выше).

newSettings : dictionary

Этот словарь используется для изменения словаря Настроек Пользователя. Он не обязан содержать в себе все Настройки; отсутствующие в словаре настройки просто не будут изменены. Если новое значение Настроек указано как строка default, то значения Настроек удаляются и вместо них используются Настройки, применяемые по умолчанию.

Эта команда может использоваться Администраторами Домена, только если они имеют право доступа Настройки.
SETACCOUNTPREFS accountName newSettings: Используйте эту команду для задания Настроек Пользователя.

accountName : string

В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена (смотрите выше).

newSettings : dictionary

В этом словаре должны находиться новые Настройки Пользователя. Все старые Настройки Пользователя при этом удаляются.

Эта команда может использоваться Администраторами Домена, только если они имеют право доступа Настройки.
GETACCOUNTEFFECTIVEPREFS accountName: Используйте эту команду для получения действующих Настроек Пользователя. Эта команда возвращает словарь, в котором содержатся Настройки Пользователя. В этот словарь включается как набор явно заданных настроек, так и набор настроек, применяемых по умолчанию.

accountName : string

В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена (смотрите выше).

Обратите внимание: Все пользователи могут использовать эту команду для получения всех своих действующих Настроек.
KILLACCOUNTSESSIONS accountName: Используйте эту команду для прекращения всех сессий Пользователя (POP, IMAP, FTP, WebUser и т.д.).

accountName : string

В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена (смотрите выше).

Обратите внимание: Для выполнения этой команды необходимо обладать правами Может менять установки Всех Доменов и Пользователей.

Следующая команда управляет Правами Доступа Пользователя. Эта команда может использоваться Пользователем и Администраторами Домена, только если они имеют право доступа Может выступать от имени других.

GETACCOUNTACL accountName [ AUTH authAccountName]: Используйте эту команду для получения списка прав доступа ACL к Папке Пользователя (Списки Прав Доступа). Эта команда возвращает словарь, в котором содержатся элементы ACL.

accountName : string

В этом параметре задаётся имя существующего Пользователя (требуемого Пользователя). Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.

authAccountName : string

Этот опциональный параметр указывает имя Пользователя, от имени которого должна быть произведена операция. Если этот имя задано, то информация ACL возвращается только если указанный Пользователь имеет право доступа Управлять для требуемого Пользователя.
SETACCOUNTACL accountName [ AUTH authAccountName] newACL: Используйте эту команду для изменения списка прав доступа в Правах Доступа Пользователя.

accountName : string

В этом параметре задаётся имя существующего Пользователя (требуемого Пользователя). Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.

authAccountName : string

Этот опциональный параметр указывает имя Пользователя, от имени которого должна быть произведена операция. Если этот имя задано, то информация ACL изменяется только если указанный Пользователь имеет право доступа Управлять для требуемого Пользователя.

newACL : dictionary

В этом параметре задаются элементы прав доступа, которые должны быть изменены. Каждый ключ словаря задаёт идентификатор, а значения ключей должны быть строками с символами прав доступа.
Если значение ключа начинается с символа минус ("-"), то права доступа, указанные в этой строке, убираются из элемента прав доступа.
Если значение ключа начинается с символа плюс ("+"), то права доступа, указанные в этой строке, добавляются к элементу прав доступа.
В других случаях, права доступа, указанные в строке, замещают набор прав в элементе прав доступа.
Если элемент права доступа для указанного ключа не существует, то он будет создан.
Если новый элемент права доступа имеет пустой набор прав доступа, то элемент удаляется.
GETACCOUNTACLRIGHTS accountName AUTH authAccountName: Эта команда возвращает строку с фактически действующими правами доступа для данного authAccountName.

accountName : string

В этом параметре задаётся имя существующего Пользователя (требуемого Пользователя). Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.

authAccountName : string

Этот опциональный параметр указывает имя Пользователя, чьи фактические права доступа к требуемому Прользователю должны быть получены.

Следующие команды доступны только для Администраторов Системы:

SETACCOUNTSETTINGS accountName newSettings: Используйте эту команду для изменения установок Пользователя.

accountName : string

В этом параметре задаётся имя существующего Пользователя.

newSettings : dictionary

Этот словарь используется для замещения словаря установок Пользователя. Все старые установки Пользователя при этом удаляются.
GETACCOUNTLOCATION accountName: Используйте эту команду для получения пути к файловой директории Пользователя (для Пользователей с типом Набор Папок) или получения пути к файлу папки INBOX Пользователя (для пользователей, имеющих только одну папку). Эта команда возвращает строку с путём к файловой директории Пользователя. Путь указывается относительно к файловой директории Домена Пользователя.

accountName : string

В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена (смотрите выше).
GETACCOUNTPRESENCE accountName: Используйте эту команду для получения статуса присутствия Пользователя. Эта команда возвращает строку со статусом присутствия Пользователя или нулевой объект.

accountName : string

В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена (смотрите выше).

Администрирование Групп

Для использования команд CLI по администрированию Групп необходимо иметь право доступа к области Пользователи Сервера или обладать правами доступа по Администрированию Домена.

LISTGROUPS [ domainName ]: Используйте эту команду для получения списка всех Групп в Домене. Эта команда возвращает массив, в котором содержатся имена всех Групп в указанном (или взятом по умолчанию) Домене.

domainName : string

Этот опциональный параметр указывает имя Домена. Если имя Домена не указано, то команда применяется к Домену администратора.
CREATEGROUP groupName [settings]: Используйте эту команду для создания новых Групп.

groupName : string

Этот параметр задаёт имя новой Группы.
Имя может содержать символ @, за которым следует имя Домена; в этом случае Группа создаётся в указанном Домене. Если имя Домена не указано, то команда применяется к Домену администратора.

settings : dictionary

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

Эта команда может использоваться Администраторами Домена, только если они имеют право доступа Может создавать Группы.
RENAMEGROUP oldGroupName into newGroupName: Используйте эту команду для переименования Групп.

oldGroupName : string

Этот параметр указывает имя существующей Группы. Имя может включать в себя имя Домена (смотрите выше).

newGroupName : string

В этом параметре задаётся имя новой Группы. Имя может включать в себя имя Домена (смотрите выше).

Эта команда может использоваться Администраторами Домена, только если они имеют право доступа Может создавать Группы.
DELETEGROUP groupName: Используйте эту команду для удаления Группы.

groupName : string

Этот параметр указывает имя существующей Группы. Имя может включать в себя имя Домена (смотрите выше).

Эта команда может использоваться Администраторами Домена, только если они имеют право доступа Может создавать Группы.
GETGROUP groupName: Используйте эту команду для получения настроек групп. Эта команда возвращает словарь, в котором содержатся установки Группы и её участники.

groupName : string

Этот параметр указывает имя существующей Группы. Имя может включать в себя имя Домена (смотрите выше).
SETGROUP groupName newSettings: Используйте эту команду для задания установок Группы.

groupName : string

Этот параметр указывает имя существующей Группы. Имя может включать в себя имя Домена (смотрите выше).

newSettings : dictionary

Этот словарь используется для замещения словаря установок Группы.

Администрирование Переадресаторов

Для использования команд CLI по администрированию Переадресаторов необходимо иметь право доступа к области Пользователи Сервера или обладать правами доступа по Администрированию Домена.

LISTFORWARDERS [ domainName ]: Используйте эту команду для получения списка всех Переадресаторов в Домене. Эта команда возвращает массив, в котором содержатся имена всех Переадресаторов в указанном (или взятом по умолчанию) Домене.

domainName : string

Этот опциональный параметр указывает имя Домена. Если имя Домена не указано, то команда применяется к Домену администратора.
CREATEFORWARDER forwarderName TO address: Используйте эту команду для создания нового Переадресатора.

forwarderName : string

Этот параметр задаёт имя нового переадресатора.
Имя может содержать символ @, за которым следует имя Домена; в этом случае Переадресатор создаётся в указанном Домене. Если имя Домена не указано, то команда применяется к Домену администратора.

address : string

В этом параметре задаётся адрес электронной почты, на который Переадресатор должен перенаправлять сообщения и Сигналы.

Эта команда может использоваться Администраторами Домена, только если они имеют право доступа Может создавать Переадресаторы.
RENAMEFORWARDER oldForwarderName INTO newForwarderName: Используйте эту команду для переименования Переадресаторов.

oldForwarderName : string

В этом параметре задаётся имя существующего Переадресатора. Имя может включать в себя имя Домена (смотрите выше).

newForwarderName : string

В этом параметре задаётся имя нового Переадресатора. Имя может включать в себя имя Домена (смотрите выше).

Эта команда может использоваться Администраторами Домена, только если они имеют право доступа Может создавать Переадресаторы.
DELETEFORWARDER forwarderName: Используйте эту команду для удаления Переадресатора.

forwarderName : string

В этом параметре задаётся имя существующего Переадресатора. Имя может включать в себя имя Домена (смотрите выше).

Эта команда может использоваться Администраторами Домена, только если они имеют право доступа Может создавать Переадресаторы.
GETFORWARDER forwarderName: Используйте эту команду для получения адреса Переадресатора. Команда возвращает строку с адресом электронной почты, на который этот Переадресатор перенаправляет сообщения и Сигналы.

forwarderName : string

В этом параметре задаётся имя существующего Переадресатора. Имя может включать в себя имя Домена (смотрите выше).
FINDFORWARDERS domainName TO forwarderAddress: Используйте эту команду для получения всех Переадресаторов, указывающих на указанный адрес. Эта команда возвращает массив со всеми найденнымы именами Переадресаторов.

domainName : string

Этот параметр указывает имя Домена.

forwarderAddress : string

Этот параметр задаёт искомый адрес электронной почты.

Администрирование Прав Доступа

Пользователь должен иметь право доступа к Серверу Может Всё для использования команд CLI по Администрированию Прав Доступа на Сервер.

SETACCOUNTRIGHTS accountName newRights

Используйте эту команду для задания Прав Доступа к Серверу.

accountName : string: В этом параметре задаётся имя существующего Пользователя. Имя может включать в себя имя Домена.
newRights : array: Этот массив должен содержать коды прав Доступа. Все старые права доступа Пользователя при этом удаляются.

Для установки прав доступа для Пользователя не из Главного Домена (то есть, для установки Прав на Администрирование Домена) пользователю достаточно иметь только права доступа к области Пользователи Сервера.

Администрирование Папок

Для использования команд CLI по администрированию Папок, Пользователь должен быть или владельцем папки, или иметь доступ к области Пользователи Сервера, или обладать правом доступа Полный доступ ко всем Папкам по Администрированию Домена.

LISTMAILBOXES accountName [ FILTER filter] [ AUTH authAccountName]: Используйте эту команду для получения списка псевдонимов Папок. Эта команда возвращает словарь.
каждый ключ словаря задаёт имя папки;
Если пользователь authAccountName не указан или указанный пользователь имеет для этой папки право доступа Входить, то значение ключа содержит словарь с информацией о папке;
если указанное authAccountName не имеет права доступа Входить, то значение ключа содержит пустой массив;
если есть "папка" с ключом словаря, но нет "обычной" папки с таким именем, то значением ключа будет пустой массив;
если есть "папка" с ключом словаря, и также существует "обычная" папка с таким именем, то значением ключа будет массив из одного элемента - информация для "обычной" папки (или словарь, или пустой массив).

accountName : string

В этом параметре задаётся имя существующего Пользователя. Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.

filter : string

Этот опциональный параметр задаёт строку фильтр, применяемую к именам Папок. В фильтре могут использоваться те же символы шаблона подстановки "*" и "%", что и в команде IMAP LIST. Если фильтр не указан, то считается, что в качестве фильтра задана строка "*" и возвращаются все Папки Пользователя.

authAccountName : string

Этот опциональный параметр указывает имя Пользователя, от имени которого должна быть произведена операция LIST. Если этот имя задано, ты выводятся только те имена папок, для которых указанный Пользователь имеет право доступа к папке Видеть.
CREATEMAILBOX accountName MAILBOX mailboxName [ AUTH authAccountName] [ CLASS mailboxClass ]: Используйте эту команду для создания Папки у указанного Пользователя.

accountName : string

В этом параметре задаётся имя существующего Пользователя. Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.

mailboxName : string

Этот параметр задаёт имя новой Папки.

authAccountName : string

Этот опциональный параметр указывает имя Пользователя, от имени которого должна быть произведена эта операция.

mailboxClass : string

Этот параметр задаёт класс новой Папки
DELETEMAILBOX accountName MAILBOX mailboxName [ AUTH authAccountName] DELETEMAILBOX accountName MAILBOXES mailboxName [ AUTH authAccountName]: Используйте эту команду для удаления Папки у указанного Пользователя. Если используется ключевое слово MAILBOXES, то все вложенные папки (подпапки) также будут удалены.

accountName : string

В этом параметре задаётся имя существующего Пользователя. Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.

mailboxName : string

В этом параметре задаётся имя папки, которая должна быть удалена.

authaccountname : string

Этот опциональный параметр указывает имя Пользователя, от имени которого должна быть произведена операция. Если это имя указано, то папка удаляется, только если указанный Пользователь имеет право доступа Создать для "внешней" папки (это означает, что для того, что бы удалить папку Archive/March Пользователь должен иметь право доступа Создать для папки Archive), а также указанный Пользователь имеет право Удалить для указанной папки.
RENAMEMAILBOX accountName MAILBOX mailboxName INTO newMailboxName [ AUTH authAccountName] RENAMEMAILBOX accountName MAILBOXES mailboxName INTO newMailboxName [ AUTH authAccountName]: Используйте эту команду для переименования папки у указанного Пользователя. Если используется ключевое слово MAILBOXES, то все вложенные папки (подпапки) также будут переименованы.

accountName : string

В этом параметре задаётся имя существующего Пользователя. Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.

mailboxName : string

В этом параметре задаётся имя папки, которая должна быть переименована.

newMailboxName : string

Этот параметр задаёт новое имя папки.

authaccountname : string

Этот опциональный параметр указывает имя Пользователя, от имени которого должна быть произведена операция. Если это имя указано, то папка создаётся, только если указанный Пользователь имеет право выполнять операцию DELETEMAILBOX с оригинальной папкой и операцию CREATEMAILBOX с новой папкой (смотрите выше).
GETMAILBOXINFO accountName MAILBOX mailboxName [ AUTH authAccountName]: Используйте эту команду для получения внутренней информации о Папке Пользователя. Эта команда возвращает словарь, в котором содержится внутренняя информация о папке.

accountName : string

В этом параметре задаётся имя существующего Пользователя. Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.

mailboxName : string

В этом параметре задаётся имя существующей у указанного Пользователя папки.

authaccountname : string

Этот опциональный параметр указывает имя Пользователя, от имени которого должна быть произведена операция. Если этот имя задано, то информация о папке возвращается, только если указанный Пользователь имеет право доступа к папке Входить.
GETMAILBOXACL accountName MAILBOX mailboxName [ AUTH authAccountName]: Используйте эту команду для получения списка прав доступа к Папке Пользователя. Эта команда возвращает словарь, в котором содержатся элементы доступа к папке.

accountName : string

В этом параметре задаётся имя существующего Пользователя. Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.

mailboxName : string

В этом параметре задаётся имя существующей у указанного Пользователя папки.

authaccountname : string

Этот опциональный параметр указывает имя Пользователя, от имени которого должна быть произведена операция. Если этот имя задано, то информация ACL возвращается, только если указанный Пользователь имеет право доступа к папке Управлять.
SETMAILBOXACL accountName MAILBOX mailboxName [ AUTH authAccountName] newACL: Используйте эту команду для изменения списка прав доступа к Папке Пользователя.

accountName : string

В этом параметре задаётся имя существующего Пользователя. Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.

mailboxName : string

В этом параметре задаётся имя существующей у указанного Пользователя папки.

authaccountname : string

Этот опциональный параметр указывает имя Пользователя, от имени которого должна быть произведена операция. Если этот имя задано, то информация ACL изменяется, только если указанный Пользователь имеет право доступа к папке Управлять.

newACL : dictionary

В этом параметре задаются элементы прав доступа, которые должны быть изменены. Каждый ключ словаря задаёт идентификатор, а значения ключей должны быть строками с символами прав доступа.
Если значение ключа начинается с символа минус ("-"), то права доступа, указанные в этой строке, убираются из элемента прав доступа.
Если значение ключа начинается с символа плюс ("+"), то права доступа, указанные в этой строке, добавляются к элементу прав доступа.
В других случаях, права доступа, указанные в строке, замещают набор прав в элементе прав доступа.
Если элемент права доступа для указанного ключа не существует, то он будет создан.
Если новый элемент права доступа имеет пустой набор прав доступа, то элемент удаляется.
GETMAILBOXRIGHTS accountName MAILBOX mailboxName AUTH authAccountName: Эта команда возвращает строку с фактически действующими правами доступа к папке для данного authAccountName.

accountName : string

В этом параметре задаётся имя существующего Пользователя. Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.

mailboxName : string

В этом параметре задаётся имя существующей у указанного Пользователя папки.

authaccountname : string

Этот опциональный параметр указывает имя Пользователя, чьи фактические права доступа к папке должны быть получены.
SETMAILBOXCLASS accountName MAILBOX mailboxName [ AUTH authAccountName ] CLASS newClass: Используйте эту команду для задания "класса" папки Пользователя.

accountName : string

В этом параметре задаётся имя существующего Пользователя. Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.

mailboxName : string

В этом параметре задаётся имя существующей у указанного Пользователя папки.

authaccountname : string

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

newClass : string

Класс папки.
GETACCOUNTSUBSCRIPTION accountName: Эта команда возвращает массив, в котором содержится список "подписанных папок" Пользователя.

accountName : string

В этом параметре задаётся имя существующего Пользователя. Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.
SETACCOUNTSUBSCRIPTION accountName newSubscription: Используйте эту команду для задания списка "подписанных папок" Пользователя.

accountName : string

В этом параметре задаётся имя существующего Пользователя. Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.

newSubscription : array

Список "подписанных папок". Каждый элемент массива должен быть строкой с именем папки.
GETMAILBOXALIASES accountName: Эта команда возвращает словарь. Каждый ключ словаря является именем псевдонима существующей папки, а значение ключа является строкой с именем папки, на которую указывает этот псевдоним.

accountName : string

В этом параметре задаётся имя существующего Пользователя. Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.
SETMAILBOXALIASES accountName newAliases: Используйте эту команду для задания списка "подписанных папок" Пользователя.

accountName : string

В этом параметре задаётся имя существующего Пользователя. Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.

newAliases : dictionary

Набор новых псевдонимов папок.

Администрирование Предупреждений

Пользователь должен иметь право доступа к области Пользователи Сервера или право доступа Может публиковать Предупреждения по Администрированию Домена для использования команд CLI по администрированию Предупреждений.

GETDOMAINALERTS [ domainName ]: Используйте эту команду для получения Предупреждений Домена. Эта команда возвращает словарь, в котором содержатся строки с предупреждениями и отметки о времени.

domainName : string

Этот опциональный параметр указывает имя существующего Домена.
SETDOMAINALERTS [ domainName ] newAlerts: Используйте эту команду для изменения предупреждений Домена.

domainName : string

Этот опциональный параметр указывает имя существующего Домена.

newAlerts : dictionary

Этот словарь используется для замещения словаря предупреждений Домена. Все старые предупреждения Домена при этом удаляются.
POSTDOMAINALERT domainName ALERT newAlert: Используйте эту команду для публикации общедоменного предупреждения.

domainName : string

В этом параметре задаётся имя существующего Домена.

newAlert : string

В этой строке указывается текст предупреждения.
REMOVEDOMAINALERT domainName ALERT timeStamp: Используйте эту команду для удаления общедоменного предупреждения.

domainName : string

В этом параметре задаётся имя существующего Домена.

timeStamp : string

В этой строке указывается отметка о времени Предупреждения, которое должно быть удалено.
GETACCOUNTALERTS accountName: Используйте эту команду для получения Предупреждений Пользователя. Эта команда возвращает словарь, в котором содержатся строки с предупреждениями Пользователю и отметки о времени.

accountName : string

В этом параметре задаётся имя существующего Пользователя. Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.
SETACCOUNTALERTS accountName newAlerts: Используйте эту команду для изменения предупреждений Пользователя.

accountName : string

В этом параметре задаётся имя существующего Пользователя. Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.

newAlerts : dictionary

Этот словарь используется для замещения словаря предупреждений Пользователя. Все старые предупреждения Пользователя при этом удаляются.
POSTACCOUNTALERT accountName ALERT newAlert: Используйте эту команду для публикации предупреждения Пользователю.

accountName : string

В этом параметре задаётся имя существующего Пользователя. Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.

newAlert : string

В этой строке указывается текст предупреждения.
REMOVEACCOUNTALERT accountName ALERT timeStamp: Используйте эту команду для удаления предупреждения Пользователю.

accountName : string

В этом параметре задаётся имя существующего Пользователя. Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.

timeStamp : string

В этой строке указывается отметка о времени Предупреждения, которое должно быть удалено.

Следующие команды доступны только для Администраторов Системы:

GETSERVERALERTS: Используйте эту команду для получения списка общесерверных Предупреждений. Эта команда возвращает словарь, в котором содержатся строки с предупреждениями сервера и отметки о времени.
SETSERVERALERTS newAlerts: Используйте эту команду для изменения общесерверных Предупреждений.

newAlerts : dictionary

Этот словарь используется для замещения общесерверного словаря предупреждений. Все старые общесерверные предупреждения при этом удаляются.
POSTSERVERALERT newAlert: Используйте эту команду для публикации общесерверного Предупреждения.

newAlert : string

В этой строке указывается текст предупреждения.
REMOVESERVERALERT timeStamp: Используйте эту команду для удаления общесерверного предупреждения.

timeStamp : string

В этой строке указывается отметка о времени Предупреждения, которое должно быть удалено.
GETCLUSTERALERTS SETCLUSTERALERTS newAlerts POSTCLUSTERALERT newAlert REMOVECLUSTERALERT timeStamp: Эти команды доступны только в Динамическом Кластере.
Используйте эти команды вместо команд [Get|Set|Post|Remove]ServerAlert[s] для работы с общекластерными Предупреждениями.

Администрирование Хранилища Файлов

Следующие команды позволяют аутентифицированному пользователю работать с файлами, находящимися в Хранилище Файлов Пользователя. Для получения файлов из директории private и её поддиректорий аутентифицированный пользователь должен быть либо владельцем файлов, либо аутентифицированный пользователь должен иметь право доступа к области Пользователи Сервера, либо иметь право доступа Полный доступ ко всем Файлам по Администрированию Домена.

Если имя файла заканчивается символом косая черта (/), то оно обозначает имя файловой директории.

GETWEBFILE accountName FILE fileName [ OFFSET position ] [ SIZE sliceSize ]: Используйте эту команду для получения файла из Хранилища Файлов Пользователя. Эта команда возвращает массив из трёх элементов. Первым элементом массива является блок данных с содержанием указанного файла, вторым элементом массива является отметка о времени модификации файла и третьим элементом массива является текущий размер файла.

accountName : string

В этом параметре задаётся имя существующего Пользователя. Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.

fileName : string

Этот параметр задаёт имя файла, которое необходимо получить из Хранилища Файлов.

position : number

Если задан этот параметр, то файл в Хранилище Файлов читается начиная с указанной позиции в файле.

sliceSize : number

Если задан этот параметр, то будет прочитано не более чем указанное число байт данных файла.

Для использования команд CLI по администрированию Хранилища Файлов Пользователя необходимо быть либо владельцем файлов, либо иметь право доступа к области Пользователи Сервера, либо иметь право доступа Полный доступ ко всем Файлам по Администрированию Домена.

PUTWEBFILE accountName FILE fileName [ OFFSET position ] DATA fileData: Используйте эту команду для сохранения файла в Хранилище Файлов Пользователя.
Если в Хранилище Файлов файл с указанным именем уже существует, то старый файл удаляется.
Если fileName указывает на директорию (оканчивается символом косая черта /), то команда создаёт директорию. В этом случае, часть OFFSET position должна отсутствовать, а параметр fileData должен быть пустым блоком данных.

accountName : string

В этом параметре задаётся имя существующего Пользователя. Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.

fileName : string

Этот параметр задаёт имя файла в Хранилище Файлов.

position : offset

Если этот параметр отсутствует или его значение равно нулю, то существующий файл (если он есть) сначала удаляется, а затем создаётся новый.
Если этот параметр отличен от нуля, то его значение должно быть положительным; файл в Хранилище Файлов перезаписывается/дополняется начиная с указанной позиции в файле. файл должен существовать и указанная позиция не должна быть больше, чем текущий размер файла.
Если эта опция имеет значение BEG, то файл уже должен существовать; файл перезаписывается с начала, но его старые данные, находящиеся за пределами fileData, не удаляются.
Если эта опция имеет значение END, то fileData добавляются к концу файла. Если файл не существует, то он создаётся.
Если эта опция имеет значение NEW, то файл не должен существовать; новый файл создаётся и fileData записываются в него.

fileData : datablock

В этом параметре содержатся данные файла.
RENAMEWEBFILE accountName FILE oldFileName INTO newFileName: Используйте эту команду для переименования файла или файловой директории в Хранилище Файлов Пользователя.

accountName : string

В этом параметре задаётся имя существующего Пользователя. Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.

oldFileName : string

В этом параметре задаётся имя существующего файла или файловой директории в Хранилище Файлов.

newFileName : string

Этот параметр задаёт новое имя файла или файловой директории в Хранилище Файлов.
DELETEWEBFILE accountName FILE fileName: Используйте эту команду для удаления файла или файловой директории из Хранилища Файлов Пользователя.

accountName : string

В этом параметре задаётся имя существующего Пользователя. Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.

oldFileName : string

В этом параметре задаётся имя существующего файла или файловой директории в Хранилище Файлов.
LISTWEBFILES accountName [ PATH filePath]: Используйте эту команду для получения списка всех файлов в верхней директории Хранилища Файлов или в одной из его поддиректорий. Эта команда возвращает словарь, где каждый ключ является именем файла из Хранилища Файлов, а значением ключа является словарь для обычного файла и пустой массив для поддиректорий.

accountName : string

В этом параметре задаётся имя существующего Пользователя. Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.

filePath : string

Этот опциональный параметр указывает имя поддиректории в Хранилище Файлов. Вы можете опустить этот параметр вместе с ключевым словом PATH, в этом случае команда возвращает список файлов в верхней директории Хранилища Файлов.
GETWEBFILESINFO accountName: Используйте эту команду для получения статистической информации обо всех файлах, находящихся в Хранилище Файлов Пользователя. Эта команда возвращает массив с двумя числовыми элментами. Первый элемент содержит общий размер всех файлов, находящихся в Хранилище Файлов, а второй элемент содержит число файлов, находящихся в Хранилище Файлов.

accountName : string

В этом параметре задаётся имя существующего Пользователя. Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.

Администрирование Списков Рассылки

Для использования команд CLI по администрированию Списков Рассылки необходимо иметь право доступа к области Пользователи Сервера или обладать правами доступа по Администрированию Домена.

LISTLISTS [ domainName ]: Используйте эту команду для получения списка Списков Рассылки Домена. Эта команда возвращает данные - массив строк. Каждая строка является именем списка рассылки в указанном (или в выбранном по умолчанию) Домене.

domainName : string

Этот опциональный параметр указывает имя Домена.
GETDOMAINLISTS [ domainName ]: Используйте эту команду для получения списка Списков Рассылки Домена. Эта команда возвращает данные - словарь. Каждый ключ словаря является именем списка рассылки в указанном (или в выбранном по умолчанию) Домене. Значением ключа является цифровая строка с фактическим числом подписчиков списка ("-1", если текущее число подписчиков списка неизвестно).

domainName : string

Этот опциональный параметр указывает имя Домена.
GETACCOUNTLISTS accountName: Используйте эту команду для получения списка всех списков рассылки, принадлежащих указанному Пользователю. Эта команда возвращает данные - словарь. Каждый ключ словаря является именем списка рассылки, принадлежащего указанному (или выбранному по умолчанию) Пользователю. Значением ключа является цифровая строка с фактическим числом подписчиков списка ("-1", если текущее число подписчиков списка неизвестно).

accountName : string

В этом параметре задаётся имя Пользователя - владельца списка.
CREATELIST listName for accountName: Используйте эту команду для создания списка рассылки.

listName : string

В этом параметре задаётся имя существующего списка рассылки. Он может включать в себя имя Домена. Если имя Домена не указано, то по умолчанию используется Домен пользователя.

accountName : string

В этом параметре задаётся имя владельца списка рассылки. Оно должно быть именем уже существующего пользователя из Домена списка рассылки.

Эта команда может использоваться Администраторами Домена, только если они имеют право доступа Может создавать Списки Рассылки.
RENAMELIST listName into newName: Используйте эту команду для переименования списка рассылки.

listName : string

В этом параметре задаётся имя существующего списка рассылки. Он может включать в себя имя Домена. Если имя Домена не указано, то по умолчанию используется Домен пользователя.

newName : string

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

Эта команда может использоваться Администраторами Домена, только если они имеют право доступа Может создавать Списки Рассылки.
DELETELIST listName: Используйте эту команду для удаления списка рассылки.

listName : string

В этом параметре задаётся имя существующего списка рассылки. Он может включать в себя имя Домена. Если имя Домена не указано, то по умолчанию используется Домен пользователя.

Эта команда может использоваться Администраторами Домена, только если они имеют право доступа Может создавать Списки Рассылки.

Следующие команды могут использоваться владельцем списка рассылки, Администратором Домена с правом доступа "Полный доступ ко всем Спискам" или Администратором Сервера с правами доступа к области Пользователb Сервера.

GETLIST listName

Используйте эту команду для получения настроек списка. Эта команда возвращает словарь, в котором содержатся настройки списка listName.

listName : string: В этом параметре задаётся имя существующего списка рассылки. Он может включать в себя имя Домена. Если имя Домена не указано, то по умолчанию используется Домен пользователя.

UPDATELIST listName newSettings

Используйте эту команду для изменения настроек списка.

listName : string: В этом параметре задаётся имя существующего списка рассылки. Он может включать в себя имя Домена. Если имя Домена не указано, то по умолчанию используется Домен пользователя.
newSettings : dictionary: Этот словарь используется для изменения словаря настроек списка рассылки. Он не обязан содержать в себе все настройки; отсутствующие в словаре настройки просто не будут изменены.

LIST listName operation [silently] [confirm] subscriber

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

listName : string: В этом параметре задаётся имя существующего списка рассылки. Он может включать в себя имя Домена. Если имя Домена не указано, то по умолчанию используется Домен пользователя.
operation : subscribe | feed | digest | index | null | banned | unsubscribe

Пример:

LIST MyList@mydomain.com FEED confirm "Bill Jones" <BJones@company.com>

LISTSUBSCRIBERS listName [ FILTER filter [ limit ] ]

Используйте эту команду для получения списка подписчиков. Эта команда возвращает массив с адресами электронной почты подписчиков.

listName : string: В этом параметре задаётся имя существующего списка рассылки. Он может включать в себя имя Домена. Если имя Домена не указано, то по умолчанию используется Домен пользователя.
filter : string: Если этот опциональный параметр указан, то возвращаются только те адреса, в которых содержится указанная строка.
limit : number: Этот опциональный параметр ограничивает число возвращаемых адресов подписчиков.

READSUBSCRIBERS listName [ FILTER filter [ limit ] ]

Используйте эту команду для получения списка подписчиков. Эта команда возвращает массив словарей-дескрипторов подписчика.

listName : string: В этом параметре задаётся имя существующего списка рассылки. Он может включать в себя имя Домена. Если имя Домена не указано, то по умолчанию используется Домен пользователя.
filter : string: Если этот опциональный параметр указан, то возвращаются только те подписчики, в адресе которых содержится указанная строка.
limit : number: Этот опциональный параметр ограничивает число возвращаемых словарей подписчиков.

Словарь, описывающий подписчика, состоит из следующих элементов:

Sub: Строка с адресом электронной почты
RealName: опциональная строка с Настоящим Именем
mode: срока с режимом подписки (дайджест, оглавление, фиктивная и т.д.)
subscribeTime: отметка о времени подписки пользователя.
posts: число публикаций в этом списке
lastBounceTime: опциональная отметка о времени последней ошибки при отправке сообщения этому пользователю.
bounces: опциональное число, указывающее число уведомлений об ошибке доставки сообщения этому пользователю.

GETSUBSCRIBERINFO listName NAME subscriberAddress

Используйте эту команду для получения информации о подписчике списка. Эта команда возвращает словарь с информацией о подписчике.

listName : string: В этом параметре задаётся имя существующего списка рассылки. Он может включать в себя имя Домена. Если имя Домена не указано, то по умолчанию используется Домен пользователя.
subscriberAddress : string: В этом параметре задаётся адрес электронной почты подписчика списка.

Если подписчик не существует, то возвращается пустой словарь. В противном случае словарь содержит следующие элементы:

mode: Этот элемент типа строка определяет режим подписки (digest, index и т.д.). Этот элемент равен unsubcribe, если адрес был отподписан, но не был удалён из списка. Этот элемент равен subcribe, если пользователь начал процесс подписки, но подписка не была подтверждена.
confirmationID: В этом элементе содержится строка с Идентификатором Подтверждения для Пользователя.
timeSubscribed: Этот элемент с типом строка указывает время подписки адреса (в формате даты/времени ACAP).
posts: Этот элемент с типом строка содержит в себе строки special, moderateAll, prohibited или строку с числом сообщений, опубликованных от этот адреса. Если следующая публикация от этого адреса должна модерироваться, то элемент содержит массив одностроковых элементов, содержащих число модерируемых публикаций.
bounces: Этот опциональный элемент с типом строка содержит число ошибок, полученных при отправке сообщений на этот адрес.
lastBounced: Этот опциональный элемент с типом строка указывает время последней ошибки, связанной с этим адресом. Время последней ошибки, указанное в формате ACAP.
RealName: Этот опциональный элемент с типом строка содержит настоящее имя подписчика.

SETPOSTINGMODE listName FOR subscriberAddress [ UNMODERATED | MODERATEALL | PROHIBITED | SPECIAL | numberOfModerated ]

Используйте эту команду для задания режима публикации для указанного подписчика.

listName : string: В этом параметре задаётся имя существующего списка рассылки. Он может включать в себя имя Домена. Если имя Домена не указано, то по умолчанию используется Домен пользователя.
subscriberAddress : string: В этом параметре задаётся адрес электронной почты подписчика списка.
postingMode : number: Этот опциональный параметр ограничивает число возвращаемых адресов подписчиков.

Эта команда задаёт для указанного подписчика режим публикации. Если указано numberOfModerated (число), то режим публикации задаёт необходимость модерирования первых numberOfModerated сообщений от этого подписчика.

PROCESSBOUNCE listName [FATAL] FOR subscriberAddress

Используйте эту команду для выполнения действий, выполняемых Менеджером Списка при получении ошибки от адреса подписчика.

listName : string: В этом параметре задаётся имя существующего списка рассылки. Он может включать в себя имя Домена. Если имя Домена не указано, то по умолчанию используется Домен пользователя.
subscriberAddress : string: В этом параметре задаётся адрес электронной почты подписчика списка.

Используйте ключевое слово FATAL для имитации "фатальной" ошибки. В противном случае команда будет имитировать не-фатальную ошибку.

Администрирование Вида Веб Интерфейса

Следующие команды могут использоваться для обслуживания Вида Интерфейса Веб Интерфейса Пользователя CommuniGate Pro.

Для изменения Среды Домена для Программ Реального Времени необходимо иметь право доступа к области Пользователи Сервера или обладать правом доступа Может модифицировать PBX Приложения по Администрированию Домена.

LISTDOMAINSKINS [domainName]: Используйте эту команду для получения списка пользовательских Видов Интерфейса Домена. Эта команда возвращает массив с именами Вида Интерфейса.

domainName : string

Этот опциональный параметр указывает имя Домена. Если имя Домена не указано, то команда применяется к Домену администратора.
CREATEDOMAINSKIN [domainName SKIN] skinName: Используйте эту команду для создания пользовательского Вида Интерфейса Домена.

domainName : string

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

skinName : string

В этом параметре задаётся имя нового Вида Интерфейса.

Для того, что бы создать Безымянный Вид Интерфейса Домена, в параметре skinName укажите пустую строку.
Именованный Вид Интерфейса Домена может быть создан только если Безымянный Вид Интерфейса уже существует.
RENAMEDOMAINSKIN [domainName SKIN] skinName INTO newSkinName: Используйте эту команду для переименования пользовательского именованного Вида Интерфейса Домена.

domainName : string

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

skinName : string

В этом параметре задаётся имя существующего именнованного Вида Интерфейса Домена.

newSkinName : string

Этот параметр задаёт новое имя Вида Интерфейса.
DELETEDOMAINSKIN [domainName SKIN] skinName: Используйте эту команду для удаления пользовательского Вида Интерфейса Домена.

domainName : string

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

skinName : string

В этом параметре задаётся имя Вида Интерфейса, который должен быть удалён.

Для удаления именованного Вида Интерфейса Домена в занчении параметра skinName укажите пустую строку.
Безымянный Вид Интерфейса Домена может быть удален только если в Домене не осталось именованных Видов Интерфейса.
LISTDOMAINSKINFILES [ domainName SKIN] skinName: Используйте эту команду для получения списков файлов из Пользовательского Вида Интерфейса Домена. Эта команда возвращает словарь, в ключах которого содержатся имена файлов Вида Интерфейса. Значением элементов словаря являются словари с атрибутами файлов.

domainName : string

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

skinName : string

В этом параметре задаётся имя существующего Вида Интерфейса Домена.
READDOMAINSKINFILE [ domainName SKIN] skinName FILE fileName: Используйте эту команду для чтения файла из пользовательского Внешнего Вида Интерфейса Домена. Эта команда возвращает массив. Первым элементом массива является блок данных с содержанием файла Вида Интерфейса, вторым элементом массива является отметка о времени с датой изменения файла.

domainName : string

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

skinName : string

В этом параметре задаётся имя существующего Вида Интерфейса Домена.

fileName : string

В этом параметре задаётся имя существующего файла указанного Вида Интерфейса Домена.
STOREDOMAINSKINFILE [ domainName SKIN] skinName FILE fileName DATA fileContent STOREDOMAINSKINFILE [ domainName SKIN] skinName FILE fileName DELETE: Используйте эту команду для сохранения файла в пользовательском Виде Интерфейса Домена или для удаления файла из пользовательского Вида Интерфейса Домена.

domainName : string

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

skinName : string

В этом параметре задаётся имя существующего Вида Интерфейса Домена.

fileName : string

В этом параметре задаётся имя нового файла Вида Интерфейса.

fileContent : datablock

В этом блоке данных находится содержимое файла. Этот параметр указывается, только если используется ключевое слово DATA.

Если указано ключевое слово DATA и Вид Интерфейса содержит файл с тем же именем, то старый файл удаляется. Файл с указанным именем удаляется из Кэша (в Динамическом Кластере файл удаляется из Кэша всех членов Кластера).

Следующие команды доступны только для Администраторов Системы:

LISTSERVERSKINS: Используйте эту команду для получения списка пользовательских Видов Интерфейса Сервера. Эта команда возвращает массив с именами Вида Интерфейса.
CREATESERVERSKIN skinName: Используйте эту команду для создания пользовательского Вида Интерфейса Сервера.

skinName : string

В этом параметре задаётся имя нового Вида Интерфейса.
RENAMESERVERSKIN skinName INTO newSkinName: Используйте эту команду для переименования пользовательского Вида Интерфейса Сервера.

skinName : string

Этот параметр указывает имя существующего Вида Интерфейса.

newSkinName : string

Этот параметр задаёт новое имя Вида Интерфейса.
DELETESERVERSKIN skinName: Используйте эту команду для удаления пользовательского Вида Интерфейса Сервера.

skinName : string

В этом параметре задаётся имя Вида Интерфейса, который должен быть удалён.
LISTSERVERSKINFILES skinName: Используйте эту команду для получения списков файлов из Пользовательского Вида Интерфейса Домена. Эта команда возвращает словарь, в ключах которого содержатся имена файлов Вида Интерфейса. Значением элементов словаря являются словари с атрибутами файлов.

skinName : string

В этом параметре задаётся имя существующего Вида Интерфейса Сервера.
READSERVERSKINFILE skinName FILE fileName: Используйте эту команду для чтения файла из пользовательского Внешнего Вида Интерфейса Сервера. Эта команда возвращает массив. Первым элементом массива является блок данных с содержанием файла Вида Интерфейса, вторым элементом массива является отметка о времени с датой изменения файла.

skinName : string

В этом параметре задаётся имя существующего Вида Интерфейса Сервера.

fileName : string

В этом параметре задаётся имя существующего файла указанного Вида Интерфейса Сервера.
STORESERVERSKINFILE skinName FILE fileName DATA fileContent STORESERVERSKINFILE skinName FILE fileName DELETE: Используйте эту команду для сохранения файла в пользовательском Виде Интерфейса Сервера или для удаления файла из пользовательского Вида Интерфейса Сервера.

skinName : string

В этом параметре задаётся имя существующего Вида Интерфейса Сервера.

fileName : string

В этом параметре задаётся имя нового файла Вида Интерфейса.

fileContent : datablock

В этом блоке данных находится содержимое файла. Этот параметр указывается, только если используется ключевое слово DATA.

Если указано ключевое слово DATA и Вид Интерфейса содержит файл с тем же именем, то старый файл удаляется. Файл с указанным именем удаляется из Кэша (в Динамическом Кластере файл удаляется из Кэша всех членов Кластера).
LISTCLUSTERSKINS CREATECLUSTERSKIN skinName RENAMECLUSTERSKIN skinName INTO newSkinName DELETECLUSTERSKIN skinName: Эти команды доступны только в Динамическом Кластере.
Используйте эти команды вместо команд [List|Create|Rename|Delete]ServerSkin[s] для работы с общекластерными Видами Интерфейса.
LISTCLUSTERSKINFILES skinName READCLUSTERSKINFILE skinName FILE fileName STORECLUSTERSKINFILE skinName FILE fileName DATA fileContent STORECLUSTERSKINFILE skinName FILE fileName DELETE: Эти команды доступны только в Динамическом Кластере.
Используйте эти команды вместо команд [List|Read|Store]ServerSkinFile[s] для работы с общекластерными Видами Интерфейса.

Интеграция с Веб Интерфейсом

Следующие команды могут использоваться для интеграции Веб Интерфейса Пользователя CommuniGate Pro с приложениями сторонних производителей.

CREATEWEBUSERSESSION accountName ADDRESS ip-address [ FOR orig-address ] [ WML | IMode ] [ SKIN skinName ]

Используйте эту команду для создания сессии WebUser для указанного Пользователя. Эта команда возвращает строку, содержащую идентификатор сессии WebUser. Эта строка может быть использована для создания URL, который позволит браузеру клиента "войти" в Сесиию WebUser. Этот URL может иметь следующий формат:

http://cgateproserver:port/Session/rrrrrrrrrrrr/Mailboxes.wssp

где rrrrrrrrrrrr является возвращённой строкой с идентификатором сессии.

accountName : string: В этом параметре задаётся имя Пользователя.
ip-address : string: В этом параметре задаётся IP адрес браузера клиента.
Если Пользователь имеет Настройку "Фиксированный IP", то соединения с сессиями будут разрешены только с этого IP адреса.
orig-address : string: В этом параметре задаётся оригинальный IP адрес браузера клиента в случае, если клиент соединяется через прокси. Параметр ip-address указывает IP адрес прокси.
Если у Пользователя Настройка "Фиксированный IP" включена, то соединения с сессией будут разрешены только с IP адреса прокси и только с оригинального IP адреса (прошедшего прокси поле заголовка HTTP X-FORWARDED-FOR).
skinName : string: Этот опциональный параметр указывает Вид Интерфейса, используемый для вновь создаваемых сессий.

Для эмуляции входа через WML или I-Mode браузер могут использоваться опциональные ключевые слова WML или IMode.
Для создания сессий WebUser аутентифицированный пользователь должен иметь право доступа к области Пользователи Сервера или обладать правом доступа Может создавать WebUser сессии по Администрированию Домена.

CREATEXIMSSSESSION accountName ADDRESS ip-address [ FOR orig-address ]

Используйте эту команду для создания сессии XIMSS для указанного Пользователя. Эта команда возвращает строку, содержащую идентификатор Сессии XIMSS. Эта строка может быть использована для создания URL, который позволит браузеру клиента работать с XIMSS Сессией используя HTTP Привязку.

accountName : string: В этом параметре задаётся имя Пользователя.
ip-address : string
orig-address : string: Эти параметры имеют тот же смысл, что и для команды CREATEWEBUSERSESSION.

Для создания Сессий XIMSS аутентифицированный пользователь должен иметь право доступа к области Пользователи Сервера или обладать правом доступа Может создавать WebUser сессии по Администрированию Домена.

FINDACCOUNTSESSION accountName [ ADDRESS ip-address [ FOR proxied-address ] ] [ PROTOCOL protocol ] [ TRANSPORT transport ] [ CLIENT client ]

Используйте эту команду для того, что бы найти для указанного Пользователя существующую сессию. Эта команда возвращает строку, содержащую идентификатор Сессии.

accountName : string: В этом параметре задаётся имя Пользователя.
ip-address : string: В этом опциональном параметре задаётся IP адрес браузера клиента. Если он указан, то команда найдёт только те сессии, у которых Настройка "Фиксированный IP" выключена или у которых IP адрес входа совпадает с указанным в этом параметре.
proxied-address : string: В этом опциональном параметре задаётся IP адрес браузера клиента, если браузер находится за HTTP прокси. IP адрес такого прокси указывается в ip-address.
protocol : string: Этот опциональный параметр указывает протокол Сессии (WebUser, XIMSS, XMPP и т.п.). Если он указан, то поиск осуществляется только в сессиях, созданных с указанным протоколом.
transport : string: Этот опциональный параметр задаёт транспорт Сессии (HTTP, XIMSS, XMPP и т.п.). Если он указан, то поиск осуществляется только в сессиях, созданных с указанным транспортом.
client : string: Этот опциональный параметр указывает клиента Сессии. Если он указан, то поиск осуществляется только в сессиях, созданных с указанным клиентом (если клиент проинформировал сессию о своём имени).

Для использования этой команды аутентифицированный пользователь должен иметь право доступа к области Пользователи Сервера или обладать правом доступа Может создавать WebUser сессии по Администрированию Домена.

GETSESSION sessionID [ DOMAIN domainName ]

Используйте эту команду для получения данных Сессии. Эта команда возвращает словарь, в котором содержится набор данных сессии (описанный в разделе WSSP настоящего руководства).

sessionID : string: В этом параметре задаётся Идентификатор Сессии.
domainName : string: Этот опциональный параметр указывает имя Домена, которому принадлежит Пользователь этой сессии.

Если параметр domainName не указан, то для получения данных Сессии аутентифицированный пользователь должен иметь право доступа к области Пользователи Сервера. Если указано domainName, то аутентифицированный пользователь должен иметь для указанного Домена право доступа Может создавать WebUser сессии Администратора Домена.
Эта операция сбрасывает таймер неактивности сессии.

KILLSESSION sessionID [ DOMAIN domainName ]

Используйте эту команду для прекращения сессии.

sessionID : string: В этом параметре задаётся Идентификатор Сессии.
domainName : string: Этот опциональный параметр указывает имя Домена, которому принадлежит Пользователь этой сессии.

Если параметр domainName не указан, то для прекращения Сессии аутентифицированный пользователь должен иметь право доступа к области Пользователи Сервера. Если указано domainName, то аутентифицированный пользователь должен иметь для указанного Домена право доступа Может создавать WebUser сессии Администратора Домена.

Администрирование Приложений Реального Времени

Следующие команды могут использоваться для обслуживания Среды Программ Реального Времени CommuniGate Pro.

CREATEDOMAINPBX domainName [ FILE language ]: Используйте эту команду для создания Среды Домена для Программ Реального Времени или для создания национального набора.

domainName : string

Этот параметр указывает имя Домена.

language : language

Этот опциональный параметр указывает название локализации.
DELETEDOMAINPBX domainName FILE language: Используйте эту команду для удаления локализации из Среды Домена для Программ Реального Времени.

domainName : string

Этот параметр указывает имя Домена.

language : language

Этот параметр указывает название локализации.
LISTDOMAINPBXFILES domainName [ FILE language ]: Используйте эту команду для получения списка файлов с Приложениями Реального Времени из Среды Домена. Эта команда возвращает словарь, в ключи которого являются именами файлов. Значением элементов словаря являются словари с атрибутами файлов.

domainName : string

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

language : language

Этот опциональный параметр указывает название локализации.
READDOMAINPBXFILE domainName FILE fileName: Используйте эту команду для чтения файла с Приложением Реального Времени из Среды Домена. Эта команда возвращает блок данных, в котором находится содержимое файла.

domainName : string

Этот параметр указывает имя Домена.

fileName : string

В этом параметре задаётся имя файла. Для получения файла из национального набора укажите его имя как language/fileName.
STOREDOMAINPBXFILE domainName FILE fileName DATA fileContent STOREDOMAINPBXFILE domainName FILE fileName DELETE: Используйте эту команду для сохранения файла с Приложением Реального Времени в Среду Домена или для удаления файла с Приложением Реального Времени из Среды Домена.

domainName : string

Этот параметр указывает имя Домена.

fileName : string

В этом параметре задаётся имя файла. Для сохранения файла в национальном наборе укажите его имя как language/fileName.

fileContent : datablock

Этот параметр указывается, только если используется ключевое слово DATA. В нём должно содержаться содержимое файла.

Если указано ключевое слово DATA и среда содержит файл с указанным именем, то старый файл удаляется. Файл с указанным именем удаляется из Кэша Среды (в Динамическом Кластере файл удаляется из Кэша всех членов Кластера).

Следующие команды доступны только для Администраторов Системы:

CREATESERVERPBX language: Используйте эту команду для создания общесерверной Среды для Приложений Реального Времени или для создания национального набора.

language : language

Этот параметр указывает название локализации.
DELETESERVERPBX language: Используйте эту команду для удаления локализации из Общей для Сервера Среды для Программ Реального Времени.

language : language

Этот параметр указывает название локализации.
LISTSERVERPBXFILES [ language ]: Используйте эту команду для получения списка файлов Приложений Реального Времени из общесерверной Среды. Эта команда возвращает словарь, ключи которого являются именами файлов. Значением элементов словаря являются словари с атрибутами файлов.

language : string

Этот опциональный параметр указывает название локализации.
READSERVERPBXFILE fileName: Используйте эту команду для чтения файла с Приложением Реального Времени из общесерверной Среды. Эта команда возвращает блок данных, в котором находится содержимое файла.

fileName : string

В этом параметре задаётся имя файла. Для получения файла из национального набора укажите его имя как language/fileName.
STORESERVERPBXFILE fileName DATA fileContent STORESERVERPBXFILE fileName DELETE: Используйте эту команду для сохранения файла с Приложением Реального Времени в общесерверную Среду или для удаления файла с Приложением Реального Времени из общесерверной среды.

fileName : string

В этом параметре задаётся имя файла. Для сохранения файла в национальном наборе укажите его имя как language/fileName.

fileContent : datablock

Этот параметр указывается, только если используется ключевое слово DATA. В нём должно содержаться содержимое файла.

Если указано ключевое слово DATA и среда содержит файл с указанным именем, то старый файл удаляется. Файл с указанным именем удаляется из Кэша Среды (в Динамическом Кластере файл удаляется из Кэша всех членов Кластера).
CREATECLUSTERPBX language DELETECLUSTERPBX language LISTCLUSTERPBXFILES [ language ] READCLUSTERPBXFILE fileName STORECLUSTERPBXFILE fileName DATA fileContent STORECLUSTERPBXFILE fileName DELETE: Эти команды доступны только в Динамическом Кластере.
Используйте эти команды вместо команд [List|Read|Store]ServerPBXFile[s] для работы с файлами общекластерной Среды Приложений Реального Времени.

Управление Приложениями Реального Времени

Следующие команды могут использоваться для обслуживания Задач Приложений Реального Времени CommuniGate Pro.

STARTPBXTASK accountName PROGRAM programName [ ENTRY entryName ] [ PARAM parameter ]

Используйте эту команду для создания новой Задачи PBX. Эта команда возвращает строку с идентификатором Задачи.

accountName : string: В этом параметре задаётся имя Пользователя. Задача запускается от имени этого Пользователя.
Имя может включать в себя имя Домена. Если имя Домена не указано, то по умолчанию используется текущий Домен пользователя.
programName : string: Имя запускаемой программы (файл .sppr).
entryName : string: Этот опциональный параметр указывает точку входа программы. Если этот параметр не указан, то используется точка входа main.
parameter : object: Этот опциональный параметр указывает имя параметров программы. Код программы может быть получен при помощи следующего кода:
Vars().startParameter

SENDTASKEVENT taskID EVENT eventName [ PARAM parameter ]

Используйте эту команду для отправки События существующей Задаче PBX.

taskID : string: В этом параметре задаётся ID Задачи.
eventName : string: Имя отправляемого События.
parameter : object: Этот опциональный параметр указывает параметры События.

KILLNODE taskID

Используйте эту команду для завершения существующей PBX Задачи.

taskID : string: В этом параметре задаётся ID Задачи.

READNODESTATUS taskID

Используйте эту команду для чтения текущего статуса приложения существующей PBX Задачи. Эта команда возвращает объект со статусом приложения.

taskID : string: В этом параметре задаётся ID Задачи.

Услуги для Пользователя

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

REMOVEACCOUNTSUBSET accountName SUBSET subsetName

Используйте эту команду для удаления "набора данных" Пользователя (например, такого, как набор данных авто-отвеченные).

Использование этой команды доступно либо самому Пользователю, либо Пользователю, имеющем право доступа Основные Установки по Администрированию Домена.

accountName : string: В этом параметре задаётся имя существующего Пользователя. Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.
subsetName : string: В этом параметре задаётся имя существующего у указанного Пользователя набора данных.

ROSTER accountName parameters

Используйте эту команду для управления Ростером Пользователя. Эта команда возвращает словарь, в котором содержатся результаты операции.

accountName : string: В этом параметре задаётся имя существующего Пользователя. Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.
parameters : dictionary: Этот словарь должен содержать элемент строки what, задающий применяемую операцию: List, Update, remove, Presence, probe. Другие элементы словаря зависят от типа операции.

BALANCE accountName parameters

Используйте эту команду для управления Остатками Пользователя. Эта команда возвращает словарь, в котором содержатся результаты операции (согласно описанию, приведённому в разделе Тарификация).

Использование этой команды доступно либо самому Пользователю, либо Пользователю, имеющем право доступа Может Кредитовать Пользователей по Администрированию Домена.

accountName : string: В этом параметре задаётся имя существующего Пользователя. Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.
parameters : dictionary: Этот словарь должен содержать строковый элемент op, задающий применяемую операцию: list, reserve, release, charge, credit, read, readAll, history, remove. Другие элементы словаря зависят от типа операции; их описание приведено в разделе Тарификация.

Настройки Сервера

Пользователь должен иметь право доступа к области Установки Сервера для использования команд CLI, затрагивающих Установки Сервера.

GETMODULE moduleName: Используйте эту команду для получения установок модуля. Эта команда возвращает словарь, в котором содержатся настройки модуля.

moduleName : string

В этом параметре задаётся имя модуля Сервера CommuniGate Pro.
SETMODULE moduleName newSettings: Используйте эту команду для изменения настроек модуля.

moduleName : string

В этом параметре задаётся имя модуля Сервера CommuniGate Pro.

newSettings : dictionary

Этот словарь используется для установки словаря настроек модуля.
UPDATEMODULE moduleName newSettings: Используйте эту команду для изменения настроек модуля.

moduleName : string

В этом параметре задаётся имя модуля Сервера CommuniGate Pro.

newSettings : dictionary

Этот словарь используется для изменения словаря настроек модуля. Он не обязан содержать в себе все настройки; отсутствующие в словаре настройки просто не будут изменены.
GETQUEUESETTINGS: Используйте эту команду для получения настроек Очереди. Эта команда возвращает словарь, в котором содержатся Установки Очереди.
SETQUEUESETTINGS newSettings: Используйте эту команду для задания Установок Очереди.

newSettings : dictionary

Этот словарь используется для установки словаря установок Очереди.
GETSIGNALSETTINGS: Используйте эту команду для получения установок Сигналов. Эта команда возвращает словарь, в котором содержатся установки Сигналов.
SETSIGNALSETTINGS newSettings: Используйте эту команду для задания установок Сигналов.

newSettings : dictionary

Этот словарь используется для задания словаря установок Сигналов.
GETSESSIONSETTINGS: Используйте эту команду для получения настроек Сессий пользователя. Эта команда возвращает словарь, в котором содержатся настройки Сессий.
SETSESSIONSETTINGS newSettings: Используйте эту команду для задания настроек Сессий.

newSettings : dictionary

Этот словарь используется для задания словаря с настройками Сессий.
GETCLUSTERSETTINGS: Используйте эту команду для получения установок Кластера. Эта команда возвращает словарь, в котором содержатся установки Кластера.
SETCLUSTERSETTINGS newSettings: Используйте эту команду для задания установок Кластера.

newSettings : dictionary

Этот словарь используется для задания словаря установок Кластера.
GETPROTECTION: Используйте эту команду для получения установок Защиты. Эта команда возвращает словарь, в котором содержатся установки Защиты сервера.
SETPROTECTION newSettings: Используйте эту команду для задания набора Установок Защиты сервера.

newSettings : dictionary

Новые установки Защиты сервера.
GETBANNED: Используйте эту команду для получения настроек Запрещённых Строк. Эта команда возвращает словарь, в котором содержатся настройка Запрещённые Строки сервера.
SETBANNED newSettings: Используйте эту команду для задания настройки Запрещённые Строки сервера.

newSettings : dictionary

Новая настройка Запрещённые Строки сервера.
GETCLUSTERPROTECTION GETCLUSTERBANNED SETCLUSTERPROTECTION newSettings SETCLUSTERBANNED newSettings: Используйте эти команды для получения и изменения установок Защиты, Общих для Кластера.
GETSERVERMAILRULES: Используйте эту команду для чтения Автоматически Правил Обработки Почты, Общих для Сервера. Эта команда возвращает массив Правил обработки Очереди Сервера.
SETSERVERMAILRULES newRules: Используйте эту команду для задания Автоматически Правил Обработки Почты, Общих для Сервера.

newRules : array

Массив с новыми Правилами обработки Очереди Сервера.
GETSERVERSIGNALRULES: Используйте эту команду для чтения Автоматических Правил Обработки Сигналов, Общих для Сервера. Эта команда возвращает массив Правил Сигналов Сервера.
GETSERVERSIGNALRULES: Используйте эту команду для задания Автоматических Правил Обработки Сигналов, Общих для Сервера.

newRules : array

Массив с новыми Правилами Сигналов Сервера.
GETCLUSTERMAILRULES SETCLUSTERMAILRULES newRules GETCLUSTERSIGNALRULES SETCLUSTERSIGNALRULES newRules: Используйте эти команды для получения и изменения Правил, Общих для Кластера.
GETROUTERTABLE: Используйте эту команду для чтения Таблицы Маршрутизации. Эта команда возвращает строку (из нескольких строк) с текстом Таблицы Маршрутизации.
SETROUTERTABLE newTable: Используйте эту команду для задания Таблицы Маршрутизации.

newTable : string

Строка (из несколько строк), в которой содержится текст новой Таблицы Маршрутизации.
Обратите внимание: строки должны разделяться символами \e.
GETROUTERSETTINGS: Используйте эту команду для чтения настроек Маршрутизации. Эта команда возвращает словарь, в котором содержатся настройки Маршрутизатора.
SETROUTERSETTINGS newSettings: Используйте эту команду для задания настроек Маршрутизатора.

newSettings : dictionary

Словарь, содержащий настройки Маршрутизатора.
GETCLUSTERROUTERTABLE SETCLUSTERROUTERTABLE newTable GETCLUSTERROUTERSETTINGS SETCLUSTERROUTERSETTINGS newSettings: Используйте эти команды для работы с общекластерной Таблицей Маршрутизации и настройками Маршрутизатора.
REFRESHOSDATA: Используйте эту команду для того, что бы заставить сервер прочитать заново данные об IP адресах из ОС Сервера: набор локальных IP адресов и набор DNS адресов.
GETLANIPS: Используйте эту команду для получения списка Адресов LAN. Эта команда возвращает строку (несколько строк) с Адресами LAN и диапазонами адресов.
SETLANIPS newAddresses: Используйте эту команду для изменения списка Адресов LAN.

newAddresses : string

Этот параметр с типом строка (несколько строк) содержит набор адресов и диапазон адресов, задающие новый набор Адресов LAN.
GETCLUSTERLANIPS: Используйте эту команду для получения набора Адресов LAN, Общих для Кластера. Эта команда возвращает строку (несколько строк) с Общими для Кластера Адресами LAN и диапазонами адресов.
SETCLUSTERLANIPS newAddresses: Используйте эту команду для изменения списка Адресов LAN, Общих для Кластера.

newAddresses : string

Этот параметр с типом строка (несколько строк) содержит набор адресов и диапазон адресов, задающие новый набор Общих для Кластера Адресов LAN.

Следующие команды имеют одинаковые параметры и возвращают такие же данные, как команды GETLANIPS | SETLANIPS | GETCLUSTERLANIPS | SETCLUSTERLANIPS:

GETCLIENTIPS SETCLIENTIPS newAddresses GETCLUSTERCLIENTIPS SETCLUSTERCLIENTIPS newAddresses: Используйте эти команды для получения и установки Общих для Кластера и Общих для Сервера Сетевых Адресов Клиентов.
GETBLACKLISTEDIPS SETBLACKLISTEDIPS newAddresses GETCLUSTERBLACKLISTEDIPS SETCLUSTERBLACKLISTEDIPS newAddresses: Используйте эти команды для получения Общих для Кластера и Общих для Сервера списка Блокированных Сетевых Адресов.
GETWHITEHOLEIPS SETWHITEHOLEIPS newAddresses GETCLUSTERWHITEHOLEIPS SETCLUSTERWHITEHOLEIPS newAddresses: Используйте эти команды для получения списка Общих для Кластера и Общих для Сервера Неблокируемых Адресов (Белых Дыр).
GETNATEDIPS SETNATEDIPS newAddresses GETCLUSTERNATEDIPS SETCLUSTERNATEDIPS newAddresses: Используйте эти команды для получения и задания списка Общих для Кластера и Общих для Сервера Адресов за NAT.
GETDEBUGIPS SETDEBUGIPS newAddresses GETCLUSTERDEBUGIPS SETCLUSTERDEBUGIPS newAddresses: Используйте эти команды для получения списка Общих для Кластера и Общих для Сервера Адресов под Отладкой.
GETDENIEDIPS SETDENIEDIPS newAddresses GETCLUSTERDENIEDIPS SETCLUSTERDENIEDIPS newAddresses: Используйте эти команды для получения и задания списка Общих для Кластера и Общих для Сервера Запрещённых Сетевых Адресов.

Пользователь должен иметь права доступа к областям Установки или Пользователи Сервера для использования следующих команд CLI.

ROUTE address [ mail | access | signal ]

Используйте эту команду для получения маршрута для указанного адреса.

address : string: В этом параметре задаётся адрес электронной почты, обрабатываемый Маршрутизатором CommuniGate Pro.
mail или access или signal

Эта команда возвращает массив из трёх строк:

module: имя модуля CommuniGate Pro, в который направляется адрес или SYSTEM если адрес маршрутизируется на встроенный "адрес" (такой как NULL).
host: объект/очередь, обрабатываемая указанным модулем: для модуля SMTP это будет именем Домена в Интернет, для модуля Местной Доставки - локальное имя пользователя и т.д.
address: адрес внутри очереди (адрес электронной почты для SMTP, адрес Real-To: для модуля Местной Доставки и т.д.).

Пользователь должен иметь права доступа к области Главное Сервера для использования следующих команд CLI.

GETSERVERINTERCEPT: Используйте эту команду для чтения настроек СОРМ - перехвата сообщений. Эта команда возвращает словарь, в котором содержатся настройки Перехвата.
SETSERVERINTERCEPT newSettings: Используйте эту команду для задания настроек СОРМ - перехвата сообщений.

newSettings : dictionary

Словарь, содержащий настройки Перехвата.
GETCLUSTERINTERCEPT SETCLUSTERINTERCEPT newSettings: Эти команды аналогичны командам GETSERVERINTERCEPT и SETSERVERINTERCEPT, но они работают с общекластерными настройками СОРМ - перехвата сообщений.

Наблюдение

Пользователь должен иметь право доступа к области Наблюдение Сервера для использования команд CLI по Наблюдению за Сервером.

GETSNMPELEMENT ObjectID

Используйте эту команду для получения текущих значений элементов состояния сервера (SNMP).

ObjectID : string

Эта команда возвращает строку со значением элемента состояния сервера.

GETDIALOGINFO DialogID

Используйте эту команду для получения информации об Объекте Диалога Сигналов.

DialogID : number: Идентификатор Диалога.

Эта команда возвращает словарь с данными статуса Диалога.

SHUTDOWN

Используйте эту команду для остановки Сервера CommuniGate Pro.

Статистика

Статистические данные уровня Пользователя собираются при условии, что опция Статистика Пользователя включена.
Для включению этой опции, Откройте в области Установки Веб Интерфейса Администратора страницу Общее, затем на странице Прочее найдите панель Локальные Пользователи.

GETACCOUNTSTAT accountName [ KEY keyName ]: Используйте эту команду для получения статистических данных об указанном Пользователе.

accountName : string

В этом параметре задаётся имя существующего Пользователя. Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.

keyName : string

Этот опциональный параметр задаёт имена ключей со статистической информацией, которые необходимо получить.

Эта команда возвращает число или отметку о времени с затребованной статистической информацией или (если ключевое слово KEY и параметр keyName не указаны) словарь со всеми доступными статистическими данными.
Если статистические данные для указанного ключа не существуют, то возвращается пустая строка.
Для использования этой команды необходимо обладать для требуемого Домена правами на Администрирование Домена. Все пользователи могут получать о себе статистическую информацию.
RESETACCOUNTSTAT accountName [ KEY keyName ]: Используйте эту команду для очистки статистических данных об указанном Пользователе.

accountName : string

В этом параметре задаётся имя существующего Пользователя. Символ звёздочка (*) может использоваться для указания текущего аутентифицированного Пользователя.

keyName : string

Этот опциональный параметр задаёт имена ключей со статистической информацией, которые необходимо сбросить.

Если ключевое слово KEY и параметр keyName не указаны, то все статистические данные о Пользователе сбрасываются.
Для использования этой команды необходимо обладать для Домена Пользователя правом Администратора Домена "Основные Установки".

Реализованы следующие ключи со статистическими данными о Пользователе:

Имя Ключа Значение

StatReset Дата и время отправки этому Пользователю последней команды RESETACCOUNTSTAT без параметров.

MessagesReceived Общее число сообщений, доставленных Пользователю

BytesReceived Общий размер всех сообщений, доставленных Пользователю

MessagesSent Общее число сообщений, отправленных от имени Пользователя

CallsReceived Общее число вызовов, полученных Пользователем.

CallsSent Общее число вызовов, совершённых от имени Пользователя

Logins Общее число успешных аутентификаций Пользователя

GETDOMAINSTAT domainName [ KEY keyName ]: Используйте эту команду для получения статистических данных об указанном Домене.

domainName : string

В этом параметре задаётся имя существующего Домена. Символ звёздочка (*) может использоваться для указания Домена текущего аутентифицированного Пользователя.

keyName : string

Этот опциональный параметр задаёт имена ключей со статистической информацией, которые необходимо получить.

Эта команда возвращает строку с затребованной статистической информацией или (если ключевое слово KEY и параметр keyName не указаны) словарь со всеми доступными статистическими данными.
Для использования этой команды необходимо обладать для требуемого Домена правами Администратора Домена.
RESETDOMAINSTAT domainName [ KEY keyName ]: Используйте эту команду для очистки статистических данных об указанном Домене.

domainName : string

В этом параметре задаётся имя существующего Домена. Символ звёздочка (*) может использоваться для указания Домена текущего аутентифицированного Пользователя.

keyName : string

Этот опциональный параметр задаёт имена ключей со статистической информацией, которые необходимо сбросить.

Если ключевое слово KEY и параметр keyName не указаны, то все статистические данные Домена сбрасываются.
Для использования этой команды необходимо обладать для требуемого Домена правом Администратора Домена "Основные Установки ".

Реализованы следующие ключи со статистическими данными о Домене:

Имя Ключа Значение

StatReset Дата и время отправки этому Домену последней команды RESETDOMAINSTAT без параметров.

MessagesReceived Общее число сообщений, доставленных Домену

BytesReceived Общий размер всех сообщений, доставленных Домену

Разные Команды

WRITELOG logLevel logRecord: Используйте эту команду для сохранения записи в Журнале работы Сервера.

logLevel : number

В этом параметре задаётся уровень Журнала.

logRecord : string

Этот параметр указывает строку, которая будет помещена в Журнал работы Сервера.

Записи, созданные при помощи этой команды, имеют префикс SYSTEM.
Для использования этой команды необходимо обладать правами Администратора Сервера "Может наблюдать за Сервером".
RELEASESMTPQUEUE queueName: Используйте эту команду для освобождения очереди SMTP.

queueName : string

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

В среде Динамического Кластера эта команда освобождает указанную очередь SMTP на всех серверах.
Для использования этой команды необходимо обладать правами Администратора Сервера "Может наблюдать за Сервером".
REJECTQUEUEMESSAGE messageID [errorText]: Используйте эту команду для того, что бы отвергнуть сообщение, находящееся в Очереди Сервера.

messageID : number

В этом параметре задаётся Идентификатор Сообщения.

errorText : string

Этот опциональный параметр указывает текст сообщения об ошибке, которое будет включено в уведомление об ошибке, посылаемое отправителю сообщения. Если этот параметр указан как NONDN, то DSN-уведомление не создаётся.

Для использования этой команды необходимо обладать правами Администратора Сервера "Может отвергать Почтовые Очереди ".
GETMESSAGEQUEUEINFO moduleName QUEUE queueName: Используйте эту команду для чтения информации об Очереди сообщений модуля.

moduleName : string

В этом параметре задаётся имя модуля.

queueName : string

В этом параметре задаётся имя очереди модуля.

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

nTotal

число - общее число собщений в очереди

size

число - общий размер всех сообщений в очереди

delayedTill

(опционально) отметка о времени - фактическое время освобождения для этой очереди

lastError

(опционально) строка с отчётом о последней возникшей проблеме
GETCURRENTCONTROLLER: Используйте эту команду для получения IP адреса текущего Контроллера Динамического Кластера.
Эта команда возвращает строку с IP адресом Контроллера Кластера.
Для использования этой команды необходимо обладать правами Администратора Сервера "Может наблюдать за Сервером".
GETTEMPCLIENTIPS: Используйте эту команду для получения набора временных Сетевых Адресов Клиентов. Эта команда возвращает строку с разделёнными через запятую (,) Временными Сетевыми Адресами Клиентов.
Для использования этой команды необходимо обладать правами Администратора Сервера "Может наблюдать за Сервером".
GETTEMPBLACKLISTEDIPS: Используйте эту команду для получения списка Временно Блокированных Сетевых Адресов. Эта команда возвращает строку с разделёнными через запятую (,) Временно Блокированными Сетевыми Адресами.
Каждый IP адрес может иметь суффикс -nnnn, где nnnn является либо числом секунд, в течении которых этот адрес будет оставаться заблокированным, либо символом *, указывающим, что этот адрес заблокирован постоянно.
Для использования этой команды необходимо обладать правами Администратора Сервера "Может наблюдать за Сервером".
SETTEMPBLACKLISTEDIPS addresses: Используйте эту команду для добавления адреса в список Временно Блокированных Сетевых Адресов.

addresses : number

Строка со списком IP адресов в формате выдачи команды GetTempBlacklistedIPs.

Для использования этой команды необходимо обладать правами по Администрированию Сервера "Может менять установки Сервера".

Индекс

Администрирование Доменов