API / Интерфейс командной строки. Часть 1

В сервере CommuniGate Pro для целей администрирования предусмотрен интерфейс командной строки (CLI). Этот интерфейс может использоваться как альтернатива веб-интерфейсу администратора.

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

Доступ к CLI

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

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

Когда 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

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

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

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

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

Управление наборами доменов

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

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

LISTDOMAINS

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

MAINDOMAINNAME

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

GETDOMAINDEFAULTS

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

UPDATEDOMAINDEFAULTS newSettings

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

newSettings : словарь

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

SETDOMAINDEFAULTS newSettings

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

newSettings : словарь

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

GETCLUSTERDOMAINDEFAULTS
UPDATECLUSTERDOMAINDEFAULTS newSettings
SETCLUSTERDOMAINDEFAULTS newSettings

Эти команды доступны только в динамическом кластере.
Используйте эти команды вместо команд [GET|UPDATE|SET]DOMAINDEFAULTS для работы с общекластерными установками по умолчанию для домена.

GETSERVERACCOUNTDEFAULTS

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

UPDATESERVERACCOUNTDEFAULTS newSettings

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

newSettings : словарь

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

SETSERVERACCOUNTDEFAULTS newSettings

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

newSettings : словарь

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

GETCLUSTERACCOUNTDEFAULTS
UPDATECLUSTERACCOUNTDEFAULTS newSettings
SETCLUSTERACCOUNTDEFAULTS newSettings

Эти команды доступны только в динамическом кластере.
Используйте эти команды вместо команд [GET|UPDATE|SET]SERVERACCOUNTDEFAULTS для работы с общекластерными установками по умолчанию для пользователя.

GETSERVERACCOUNTPREFS

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

SETSERVERACCOUNTPREFS newSettings

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

newSettings : словарь

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

UPDATESERVERACCOUNTPREFS newSettings

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

newSettings : словарь

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

GETCLUSTERACCOUNTPREFS
SETCLUSTERACCOUNTPREFS newSettings
UPDATECLUSTERACCOUNTPREFS newSettings

Эти команды доступны только в динамическом еластере.
Используйте эти команды вместо команд [GET|SET|UPDATE]SERVERACCOUNTPREFS для работы с общекластерными настройками пользователя по кмолчанию.

CREATEDOMAIN domainName [ SHARED ] [ PATH storage ] [ settings ]

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

domainName : строка

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

storage : строка

Необязательный параметр; задаёт директорию «точки монтирования хранилища» для данных домена (имя должно быть указано без суффикса .mnt).

settings : словарь

Необязательный словарь с установками домена.

Ключевое слово SHARED используется при создании общекластерного домена в динамическом кластере.

RENAMEDOMAIN oldDomainName INTO newDomainName [ PATH storage ]

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

oldDomainName : строка

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

newDomainName : строка

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

storage : строка

Необязательный параметр; задаёт новую директорию «точки монтирования хранилища» для данных домена (имя должно быть указано без суффикса .mnt).

DELETEDOMAIN domainName [ FORCE ]

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

domainName : строка

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

FORCE

Этот необязательный параметр указывает, что домен должен быть удалён, даже если он не пустой. Все объекты домена (пользователи, группы и т.д.) будут удалены.

CREATEDIRECTORYDOMAIN domainName [ settings ]

Используйте эту команду для создания нового домена в справочнике (Directory-Based).

domainName : строка

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

settings : словарь

Необязательный словарь с установками домена.

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

RELOADDIRECTORYDOMAINS

Используйте эту команду, чтобы сервер зачитал заново деревья доменов в справочнике и нашёл все новые домены, созданные непосредственно в справочнике, минуя административные интерфейсы CommuniGate Pro.
Эта операция может быть выполнена, только если разрешено использование доменов в справочнике.

LISTSERVERTELNUMS [ FILTER filter ] limit

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

filter : строка

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

limit : число

Максимальное количество возвращаемых номеров Telnum.

LISTCLUSTERTELNUMS [ FILTER filter ] limit

Аналогично команде LISTSERVERTELNUMS, но для общих кластерных доменов.

GETSERVERTRUSTEDCERTS

Используйте эту команду для получения общесерверного набора доверенных сертификатов. Эта команда возвращает массив из *блоков данных.*В каждом блоке данных содержатся данные одного сертификата X.509.

SETSERVERTRUSTEDCERTS newCertificates

Используйте эту команду для установки общесерверного набора Доверенных сертификатов.

newCertificates : массив

Этот массив должен содержать блоки данных с данными сертификатов в соответствии с X.509. Этот массив используется для замещения общесерверного списка доверенных сертификатов.

GETCLUSTERTRUSTEDCERTS
SETCLUSTERTRUSTEDCERTS newCertificates

Эти команды доступны только в динамическом кластере.
Используйте эти команды вместо команд [GET|SET]SERVERTRUSTEDCERTS для работы с общекластерным набором доверенных сертификатов.

GETDIRECTORYINTEGRATION

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

SETDIRECTORYINTEGRATION newSettings

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

newSettings : словарь

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

GETCLUSTERDIRECTORYINTEGRATION
SETCLUSTERDIRECTORYINTEGRATION newSettings

Эти команды доступны только в динамическом кластере.
Используйте эти команды вместо команд [GET|SET]DIRECTORYINTEGRATION для работы с общекластерными установками интеграции с центральным справочником.

CREATEDOMAINSTORAGE [ SHARED ] PATH storage

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

storage : строка

Этот параметр указывает имя «точки монтирования хранилища».

Ключевое слово SHARED используется при создании «точки монтирования хранилища» для кластерных доменов в динамическом кластере.

LISTDOMAINSTORAGE [ SHARED ]

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

Управление доменом

Для использования команд CLI управления доменом необходимо иметь право доступа «все домены» или обладать правами на управление доменом.

GETDOMAINSETTINGS [ domainName ]

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

domainName : строка

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

GETDOMAINEFFECTIVESETTINGS [ domainName ]

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

domainName : строка

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

UPDATEDOMAINSETTINGS [ domainName ] newSettings

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

domainName : строка

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

newSettings : словарь

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

Если эта команда используется администратором домена, то она будет изменять только те установки домена, которые этому администратору разрешается изменять.

GETACCOUNTDEFAULTS [ domainName ]

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

domainName : строка

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

UPDATEACCOUNTDEFAULTS [ domainName ] newSettings

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

domainName : строка

newSettings : словарь

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

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

GETACCOUNTDEFAULTPREFS [ domainName ]

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

domainName : строка

SETACCOUNTDEFAULTPREFS [ domainName ] newSettings

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

domainName : строка

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

newSettings : словарь

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

Эта команда может использоваться администраторами домена, только если они имеют право доступа «настройки» (WebUserSettings).

UPDATEACCOUNTDEFAULTPREFS [ domainName ] newSettings

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

domainName : строка

newSettings : словарь

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

Эта команда может использоваться администраторами домена, только если они имеют право доступа настройки (WebUserSettings).

GETACCOUNTTEMPLATE [ domainName ]

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

domainName : строка

UPDATEACCOUNTTEMPLATE [ domainName ] newSettings

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

domainName : строка

newSettings : словарь

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

Если эта команда используется пдминистратором домена, то она будет изменять только те установки шаблона, которые этому пдминистратору разрешается изменять.

GETDOMAINALIASES domainName

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

domainName : строка

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

GETDOMAINMAILRULES domainName

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

domainName : строка

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

SETDOMAINMAILRULES domainName newRules

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

domainName : строка

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

newRules : массив

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

Эта команда может использоваться администраторами домена, только если они имеют право доступа «разрешённые почтовые правила» (RulesAllowed).

GETDOMAINSIGNALRULES domainName

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

domainName : строка

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

SETDOMAINSIGNALRULES domainName newRules

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

domainName : строка

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

newRules : массив

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

Эта команда может использоваться администраторами домена, только если они имеют право доступа разрешённые сигнальные правила (SignalRulesAllowed).

LISTADMINDOMAINS [ domainName ]

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

domainName : строка

LISTDOMAINOBJECTS domainName [ FILTER filter ] limit [ ACCOUNTS ] [ ALIASES ] [ FORWARDERS ] [COOKIE cookie

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

domainName : строка

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

filter : строка

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

limit : числовая строка

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

ACCOUNTS, ALIASES, FORWARDERS

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

cookie : строка

Этот необязательный параметр указывает строку с «закладкой».

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

числовая строка с общим числом пользователей в домене
словарь с объектами домена. Каждый ключ словаря является именем объекта домена. Значения словаря зависят от типа объекта домена:
Пользователь
объектами словаря являются строки (тип пользователя)
Псевдоним пользователя
объект словаря является массивом. Его единственным элементом является строка с именем оригинального пользователя-владельца псевдонима.
Переадресатор
объект словаря является массивом. Его единственным элементом является массив. Его единственным элементом является строка с адресом переадресатора.
числовая строка с общим количеством псевдонимов в домене.
числовая строка с общим количеством переадресаторов в домене.
необязательная строка с новой «закладкой» (существует, только если в команде была часть COOKIE cookie.)

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

LISTACCOUNTS [ domainName ]

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

domainName : строка

LISTDOMAINTELNUMS domainName [ FILTER filter ] limit

Используйте эту команду для чтения номеров Telnum, созданных в указанном домене. Эта команда возвращает словарь, в котором каждый элемент является номером Telnum, а значение элемента — это имя пользователя, которому этот номер назначен. Для пустого ключа "" добавляется числовой элемент, содержащий общее число созданных номеров Telnum.

domainName : строка

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

filter : строка

limit : число

Максимальное количество возвращаемых номеров Telnum.

INSERTDIRECTORYRECORDS domainName

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

domainName : строка

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

DELETEDIRECTORYRECORDS domainName

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

domainName : строка

CREATEACCOUNTSTORAGE domainName PATH storage

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

domainName : строка

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

storage : строка

Этот параметр указывает имя «точки монтирования хранилища».

LISTACCOUNTSTORAGE domainName

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

Эта команда возвращает массив с именами «точек монтирования хранилищ».

domainName : строка

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

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

SETDOMAINALIASES domainName newAliases

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

domainName : строка

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

newAliases : массив

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

SETDOMAINSETTINGS domainName newSettings

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

domainName : строка

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

newSettings : словарь

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

SETACCOUNTDEFAULTS [ domainName ] newSettings

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

domainName : строка

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

newSettings : словарь

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

SETACCOUNTTEMPLATE [ domainName ] newSettings

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

domainName : строка

newSettings : словарь

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

GETDOMAINLOCATION [ domainName ]

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

domainName : строка

SUSPENDDOMAIN domainName

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

domainName : строка

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

RESUMEDOMAIN domainName

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

domainName : строка

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

Управление пользователями

Для использования команд CLI для управления пользователями необходимо иметь право доступа «все домены» или обладать правами на управление доменом.

CREATEACCOUNT accountName [ accountType ] [ PATH storage ] [ LEGACY ] [ settings ]

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

accountName : строка

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

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

storage : строка

Необязательный параметр; задаёт директорию «точки монтирования хранилища» для данных пользователя (имя должно быть указано без суффикса .mnt).

LEGACY

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

settings : словарь

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

Эта команда может использоваться администраторами домена, только если они имеют право доступа может создавать пользователей (CanCreateAccounts).
Если эта команда используется администратором домена, то она будет работать только с теми установками пользователя, которые этому администратору разрешается изменять.

RENAMEACCOUNT oldAccountName into newAccountName [ PATH storage ]

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

oldAccountName : строка

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

newAccountName : строка

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

storage : строка

Необязательный параметр; задаёт новую директорию «точки монтирования хранилища» для данных пользователя (имя должно быть указано без суффикса .mnt).

Эта команда может использоваться администраторами домена, только если они имеют право доступа может создавать пользователей (CanCreateAccounts).

DELETEACCOUNT oldAccountName

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

oldAccountName : строка

Эта команда может использоваться администраторами домена, только если они имеют право доступа «может создавать пользователей» (CanCreateAccounts).

SETACCOUNTTYPE accountName accountType

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

accountName : строка

accountType : MultiMailbox | AGrade | BGrade | CGrade

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

GETACCOUNTSETTINGS accountName

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

accountName : строка

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

Обратите внимание: асе пользователи могут отправлять команду GETACCOUNTSETTINGS для самих себя.

UPDATEACCOUNTSETTINGS accountName newSettings

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

accountName : строка

newSettings : словарь

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

Если эта команда используется администратором домена, то она будет изменять только те установки пользователя, которые этому администратору разрешается изменять.

GETACCOUNTEFFECTIVESETTINGS accountName

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

accountName : строка

Обратите внимание: асе пользователи могут отправлять команду GETACCOUNTEFFECTIVESETTINGS для самих себя.

GETACCOUNTONESETTING accountName keyName

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

accountName : строка

keyName : строка

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

Обратите внимание: все пользователи могут отправлять команду GETACCOUNTONESETTING для самих себя.

SETACCOUNTPASSWORD accountName PASSWORD newPassword [ METHOD method | NAME tag ] [ CHECK ]

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

accountName : строка

newPassword : строка

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

tag : строка

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

method : строка

Этот необязательный параметр указывает способ доступа пользователя. Если этот способ «SIP», то изменяется альтернативный пароль SIP, если способ — «RADIUS», то изменяется альтернативный пароль RADIUS. Во всех других случаях изменяется установка пароля CommuniGate. Новый пароль будет сохранён с использованием действующей установки шифрование пароля для этого опльзователя.

Для использования этой команды необходимо обладать для домена пользователя правом администратора домена «основные установки».
Пользователь может изменять свой пароль. В этом случае или, когда явно указано ключевое слово CHECK, операция выполняется успешно, только если новый пароль удовлетворяет требованиям сложности и размера пароля и у пользователя фактически включена установка CanModifyPassword.

VERIFYACCOUNTPASSWORD accountName PASSWORD password

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

accountName : строка

password : строка

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

Для использования этой команды необходимо обладать какими-нибудь правами администрирования домена в домене этого пользователя.

VERIFYACCOUNTIDENTITY accountName FOR identity

Используйте эту команду для проверки допустимости содержимого заголовка 'From:' в сообщениях пользователя.

accountName : строка

identity : строка

Эта строка должна содержать значение проверяемого заголовка 'From:', например, "Real Name user@domain.dom"

GETACCOUNTALIASES accountName

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

accountName : строка

SETACCOUNTALIASES accountName newAliases

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

accountName : строка

newAliases : массив

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

Эта команда может использоваться администраторами домена, только если они имеют право доступа «может создавать псевдонимы» (CanCreateAliases).

GETACCOUNTTELNUMS accountName

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

accountName : строка

SETACCOUNTTELNUMS accountName newTelnums

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

accountName : строка

newTelnums : массив

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

Эта команда может использоваться администраторами домена, только если они имеют право доступа «может присваивать телефонные номера» (CanCreateTelnums).

MODIFYACCOUNTTELNUMS accountName parameters

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

accountName : строка

parameters : словарь

Этот словарь должен содержать элемент с ключом what, задающий применяемую операцию:

add

словарь parameters должен содержать ключ telnum со значением номера telnum, который должен быть добавлен к набору номеров Telnum указанного пользователя. Если этот Telnum уже присвоен пользователю, то возвращается код ошибки.

del

словарь parameters должен содержать ключ telnum со значением номера telnum, который должен быть удалён из набора номеров Telnum указанного пользователя. Если этот Telnum не принадлежит пользователю, то возвращается код ошибки.

pop

Словарь parameters не должен содержать других ключей. Первый из присвоенных пользователю номеров Telnum удаляется из набора номеров Telnum указанного пользователя и копируется в словарь ответа. Если набор номеров Telnum указанного пользователя был пуст, то код ошибки не возвращается и в словарь результата не копируется никаких элементов.

Эта команда возвращает словарь. В случае операции pop этот словарь содержит строку с ключом telnum, значением которого является строка с номером Telnum, удалённым из набора номеров Telnum пользователя.
Эта команда может использоваться администраторами домена, только если они имеют право доступа «может присваивать телефонные номера» (CanCreateTelnums).

GETACCOUNTMAILRULES accountName

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

accountName : строка

SETACCOUNTMAILRULES accountName newRules

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

accountName : строка

newRules : массив

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

Эта команда может использоваться администраторами домена, только если они имеют право доступа разрешённые почтовые правила (RulesAllowed).
Эта команда может доступна любому пользователю для изменения собственных правил (в соответствии с ограничениями, налагаемыми «разрешёнными действиями»).

GETACCOUNTSIGNALRULES accountName

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

accountName : строка

SETACCOUNTSIGNALRULES accountName newRules

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

accountName : строка

newRules : массив

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

Эта команда может использоваться администраторами домена, только если они имеют право доступа «разрешённые сигнальные правила» (SignalRulesAllowed).

UPDATEACCOUNTMAILRULE accountName newRule
UPDATEACCOUNTMAILRULE accountName DELETE oldRule
UPDATEACCOUNTSIGNALRULE accountName newRule
UPDATEACCOUNTSIGNALRULE accountName DELETE oldRule

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

accountName : строка

newRule : массив

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

oldRule : строка

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

Команда UpdateAccountMailRule может использоваться администраторами домена, только если они имеют право доступа «разрешённые равила для почты» (RulesAllowed).

Команда UpdateAccountSignalRule может использоваться администраторами домена, только если они имеют право доступа «разрешённые правила для звонков» (SignalRulesAllowed).
Эта команда может доступна любому пользователю для изменения собственных правил (в соответствии с ограничениями, налагаемыми «разрешёнными действиями»).

GETACCOUNTRPOPS accountName

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

accountName : строка

SETACCOUNTRPOPS accountName newRecords

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

accountName : строка

newRecords : словарь

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

Эта команда может использоваться администраторами домена, только если они имеют право доступа «модификации RPOP» (CanModifyRPOP).

GETACCOUNTRSIPS accountName

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

accountName : строка

SETACCOUNTRSIPS accountName newRecords

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

accountName : строка

newRecords : словарь

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

Эта команда может использоваться администраторами домена, только если они имеют право доступа «модификации RSIP» (CanModifyRSIP).

UPDATESCHEDULEDTASK accountName taskData

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

accountName : строка

taskData : словарь

Этот словарь должен содержать данные выполняемых по расписанию задач:

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

program

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

script

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

parameter

необязательный базовый объект. Когда задача запускается по расписанию, этот объект передаётся ей в элементе startParameter.

when

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

period

необязательный параметр — строка day, week, month или year или число. Если он указан, то задача автоматически добавляется в расписание через указанный период времени (в случае указания числа - через такое количество секунд).
Если этот параметр не указан, то задача удаляется из расписания сразу после выполнения.

При запуске задачи по расписанию выполняется её точка входа main. Массив startParameter задачи содержит следующие элементы:

startParameter[0] — строка с именем выполняемой по расписанию задачи
startParameter[1] содержит отметку времени запуска задачи
startParameter[2] (необязательный параметр) содержит данные parameter запускаемой по расписанию задачи

Эта команда может использоваться администраторами домена, только если они имеют право доступа «модификации RSIP» (CanModifyRSIP) для этого пользователя.

GETACCOUNTRIGHTS accountName

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

accountName : строка

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

GETACCOUNTINFO accountName [Key keyName | ( keyList) ]

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

accountName : строка

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

keyList : массив

Этот необязательный параметр задаёт имена ключей, информацию по которым необходимо получить.
Обратите внимание, что «информационные» данные пользователя хранятся в словарях в файлах .info, а имена словарей «инфо» элементов начинаются с символа решётка (#). Вы НЕ должны включать символ решётка в параметр keyName команды GETACCOUNTINFO.
Пример:

GETACCOUNTINFO "user1@domain1.com" (LastLogin,LastAddress)

Обратите внимание: имена элементов «инфо» зависимы от регистра клавиатуры.
Команда возвращает словарь всех существующих и указанных в массиве keyList элементов «инфо».

keyName : строка

Этот необязательный параметр указывает имя запрашиваемого элемента «инфо». Оно может быть указано только в том случае, если параметр keyList не задан.
Обратите внимание, что «информационные» данные пользователя хранятся в словарях, в файлах .info, а имена словарей «инфо» элементов начинаются с символа решётка. Вы НЕ должны включать символ решётка в параметр keyName команды GETACCOUNTINFO.
Пример:

GETACCOUNTINFO "user1@domain1.com" Key LastLogin

Обратите внимание: имена элементов «инфо» зависимы от регистра клавиатуры.
Команда возвращает указанный элемент «инфо». Если элемент не найден, то команда возвращает пустую строку — два знака кавычек подряд ("").

Обратите внимание: все пользователи могут использовать команду GETACCOUNTINFO для получения элементов из своих собственных объектов «инфо».

GETACCOUNTPREFS accountName

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

accountName : строка

Обратите внимание: любой пользователь может использовать команду GETACCOUNTPREFS для получения своих настроек.

UPDATEACCOUNTPREFS accountName newSettings

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

accountName : строка

newSettings : словарь

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

SETACCOUNTPREFS accountName newSettings

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

accountName : строка

newSettings : словарь

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

GETACCOUNTEFFECTIVEPREFS accountName

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

accountName : строка

Обратите внимание: все пользователи могут использовать эту команду для получения всех своих фактических настроек.

KILLACCOUNTSESSIONS accountName

Используйте эту команду для прекращения всех сессий пользователя (POP, IMAP, FTP, WebUser и т.д.).

accountName : строка

Обратите внимание: все администратора домена могут использовать эту команду.

Следующая команда управляет правами доступа пользователя. Эта команда доступна пользователю и администраторам домена, только если они имеют право доступа «может выступать от имени других» (CanImpersonate).

GETACCOUNTACL accountName [ AUTH authAccountName ]

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

accountName : строка

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

authAccountName : строка

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

SETACCOUNTACL accountName [ AUTH authAccountName ] newACL

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

accountName : строка

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

authAccountName : строка

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

newACL : словарь

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

GETACCOUNTACLRIGHTS accountName AUTH authAccountName

Эта команда возвращает строку с фактически действующими правами доступа для данного authAccountName.

accountName : строка

authAccountName : строка

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

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

SETACCOUNTSETTINGS accountName newSettings

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

accountName : строка

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

newSettings : словарь

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

GETACCOUNTLOCATION accountName

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

accountName : строка

GETACCOUNTPRESENCE accountName

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

массив из двух строк — статус присутствия пользователя и произвольное сообщение статуса, или
строка — статус присутствия пользователя (если произвольное сообщение статуса не задано), или
нулевой объект — если статус присутствия пользователя не задан совсем.

accountName : строка

Элемент AccessMode установок пользователя и домена задаёт включённые услуги. Значение установки может быть одним из следующих:

Строка All: включены все услуги.
Строка None: все услуги выключены.
Массив строк. В первом элементе массива содержится число или числовая строка, в последующих элементах — имена включённых услуг.
Все услуги с номерами выше числа, указанного в первом элементе массива, тоже включены.
Услуги (с их номерами), поддерживаемые текущими версиями сервера:
1:Mail, 2:POP, 3:IMAP, 4:WebMail, 5:PWD, 6:Agent, 7:WebSite, 8:Relay, 9:Roaming, 10:FTP, 11:MAPI, 12:TLS, 13:S/MIME, 14:LDAP, 15:WebCAL, 16:RADIUS, 17:SIP, 18:PBX, 19:XMPP, 20:XIMSS, 21:Signal, 22:AirSync, 23:HTTP, 24:MobilePBX, 25:XMedia, 26:YMedia, 27:MobileClient, 28:ClientMail, 29:ClientIM, 30:ClientVoIP

Управление группами

Для использования команд CLI управления группами необходимо иметь право доступа к разделу «все домены сервера» или обладать правами на управление доменом.

LISTGROUPS [ domainName ]

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

domainName : строка

CREATEGROUP groupName [ settings ]

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

groupName : строка

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

settings : словарь

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

Эта команда может использоваться администраторами домена, только если они имеют право доступа «может создавать группы» (CanCreateGroups).

RENAMEGROUP oldGroupName into newGroupName

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

oldGroupName : строка

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

newGroupName : строка

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

DELETEGROUP groupName

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

groupName : строка

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

GETGROUP groupName

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

groupName : строка

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

SETGROUP groupName newSettings

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

groupName : строка

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

newSettings : словарь

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

Управление переадресаторами

Для использования команд CLI управления переадресаторами необходимо иметь право доступа «все домены» или обладать правами на управление доменом.

LISTFORWARDERS [ domainName ]

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

domainName : строка

CREATEFORWARDER forwarderName TO address

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

forwarderName : строка

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

address : строка

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

Эта команда может использоваться администраторами домена, только если они имеют право доступа «может создавать переадресаторы» (CanCreateForwarders).

RENAMEFORWARDER oldForwarderName INTO newForwarderName

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

oldForwarderName : строка

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

newForwarderName : строка

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

DELETEFORWARDER forwarderName

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

forwarderName : строка

GETFORWARDER forwarderName

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

forwarderName : строка

FINDFORWARDERS domainName TO forwarderAddress

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

domainName : строка

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

forwarderAddress : строка

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

Управление именованными задачами

Для использования команд CLI управления именованными задачами необходимо иметь право доступа к разделу «все домены» сервера или обладать правами на управление доменом.

LISTDOMAINNAMEDTASKS [ domainName ]

Используйте эту команду для получения списка всех именованных задач в домене. Результатом работы команды является словарь, в котором все ключи — имена именованных задач, а значения — словари, содержащие имена владельца задачи, настоящее имя задачи и имя приложения реального времени, обслуживающего именованную задачу.

domainName : строка

LISTACCOUNTNAMEDTASKS accountName

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

accountName : строка

В этом параметре задаётся имя пользователя-владельца именованных задач.

CREATENAMEDTASK taskName FOR accountName

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

taskName : строка

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

accountName : строка

В этом параметре задаётся имя пользователя-владельца именованной задачи. Оно не должно содержать символ @ и имя домена, поскольку пользователь может владеть именованной задачей только в том же домене.

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

RENAMENAMEDTASK oldTaskName into newTaskName

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

oldTaskName : строка

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

newTaskName : строка

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

DELETENAMEDTASK taskName

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

taskName : строка

GETNAMEDTASK taskName

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

taskName : строка

UPDATENAMEDTASK taskName newSettings

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

taskName : строка

newSettings : словарь

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

Управление правами доступа

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

SETACCOUNTRIGHTS accountName newRights

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

accountName : строка

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

newRights : массив

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

Для установки прав доступа для пользователя не из главного домена (то есть, для установки прав на администрирование домена) пользователю достаточно иметь только права доступа к разделу «все домены» сервера.

Управление папками

Для использования команд CLI по администрированию папок, пользователь должен быть или владельцем папки, или иметь право «все домены» или обладать правом доступа «полный доступ ко всем папкам» (CanAccessMailboxes) администратора домена.

LISTMAILBOXES accountName [ FILTER filter ] [ AUTH authAccountName ]

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

каждый ключ словаря задаёт имя папки;
Если пользователь authAccountName не указан или указанный пользователь имеет для этой папки право доступа «входить», то значение ключа содержит словарь с информацией о папке;
если указанное authAccountName не имеет права доступа «входить», то значение ключа содержит пустой массив;
если есть «папка» с ключом словаря, но нет «обычной» папки с таким именем, то значением ключа будет пустой массив;
если есть «папка» с ключом словаря, и также существует «обычная» папка с таким именем, то значением ключа будет массив из одного элемента - информация для «обычной» папки (или словарь, или пустой массив).

accountName : строка

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

filter : строка

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

authAccountName : строка

Этот необязательный параметр указывает имя пользователя, от имени которого должна быть произведена операция LIST. Если это имя задано, ты выводятся только те имена папок, для которых указанный пользователь имеет право доступа «видеть».

CREATEMAILBOX accountName MAILBOX mailboxName [ CLASS mailboxClass ] [ AUTH authAccountName ]

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

accountName : строка

mailboxName : строка

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

authAccountName : строка

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

mailboxClass : строка

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

DELETEMAILBOX accountName MAILBOX mailboxName [ AUTH authAccountName ]
DELETEMAILBOX accountName MAILBOXES mailboxName [ AUTH authAccountName ]

Используйте эту команду для удаления папки у указанного пользователя. Если используется ключевое слово MAILBOXES, то все вложенные папки (подпапки) также будут удалены.

accountName : строка

mailboxName : строка

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

authaccountname : строка

Этот необязательный параметр указывает имя пользователя, от имени которого должна быть произведена операция. Если это имя указано, то папка удаляется, только если указанный пользователь имеет право доступа «создать» для «внешней» папки (это означает, что для того, чтобы удалить папку Archive/March пользователь должен иметь право доступа «создать» для папки Archive), а также указанный пользователь имеет право «удалить» для указанной папки.

RENAMEMAILBOX accountName MAILBOX mailboxName INTO newMailboxName [ AUTH authAccountName ]
RENAMEMAILBOX accountName MAILBOXES mailboxName INTO newMailboxName [ AUTH authAccountName ]

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

accountName : строка

mailboxName : строка

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

newMailboxName : строка

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

authaccountname : строка

Этот необязательный параметр указывает имя пользователя, от имени которого должна быть произведена операция. Если это имя указано, то папка переименовывается, только если указанный пользователь имеет право выполнять операцию DELETEMAILBOX с оригинальной папкой и операцию CREATEMAILBOX с новой папкой (смотрите выше).

GETMAILBOXINFO accountName MAILBOX mailboxName [ AUTH authAccountName ]

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

accountName : строка

mailboxName : строка

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

authaccountname : строка

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

GETMAILBOXACL accountName MAILBOX mailboxName [ AUTH authAccountName ]

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

accountName : строка

mailboxName : строка

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

authaccountname : строка

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

SETMAILBOXACL accountName MAILBOX mailboxName [ AUTH authAccountName ] newACL

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

accountName : строка

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

mailboxName : строка

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

authaccountname : строка

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

newACL : словарь

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

GETMAILBOXRIGHTS accountName MAILBOX mailboxName AUTH authAccountName

Эта команда возвращает строку с фактически действующими правами доступа к папке для данного authAccountName.

accountName : строка

mailboxName : строка

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

authaccountname : строка

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

SETMAILBOXCLASS accountName MAILBOX mailboxName [ AUTH authAccountName ] CLASS newClass

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

accountName : строка

mailboxName : строка

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

authaccountname : строка

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

newClass : строка

Класс папки.

GETMAILBOXSUBSCRIPTION accountName

Эта команда возвращает массив, в котором содержится список «подписанных папок» Пользователя.

accountName : строка

SETMAILBOXSUBSCRIPTION accountName newSubscription

Используйте эту команду для задания списка «подписанных папок» Пользователя.

accountName : строка

newSubscription : массив

Список «подписанных папок». Каждый элемент массива должен быть строкой с именем папки.

GETMAILBOXALIASES accountName

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

accountName : строка

SETMAILBOXALIASES accountName newAliases

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

accountName : строка

newAliases : словарь

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

Управление предупреждениями

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

GETDOMAINALERTS [ domainName ]

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

domainName : строка

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

SETDOMAINALERTS [ domainName ] newAlerts

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

domainName : строка

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

newAlerts : словарь

Этот словарь используется для замещения словаря предупреждений Домена. Все старые предупреждения Домена при этом удаляются.

POSTDOMAINALERT domainName ALERT newAlert

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

domainName : строка

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

newAlert : строка

В этой строке указывается текст предупреждения.

REMOVEDOMAINALERT domainName ALERT timeStamp

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

domainName : строка

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

timeStamp : строка

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

GETACCOUNTALERTS accountName

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

accountName : строка

SETACCOUNTALERTS accountName newAlerts

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

accountName : строка

newAlerts : словарь

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

POSTACCOUNTALERT accountName ALERT newAlert

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

accountName : строка

newAlert : строка

В этой строке указывается текст предупреждения.

REMOVEACCOUNTALERT accountName ALERT timeStamp

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

accountName : строка

timeStamp : строка

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

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

GETSERVERALERTS

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

SETSERVERALERTS newAlerts

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

newAlerts : словарь

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

POSTSERVERALERT newAlert

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

newAlert : строка

В этой строке указывается текст предупреждения.

REMOVESERVERALERT timeStamp

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

timeStamp : строка

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

GETCLUSTERALERTS
SETCLUSTERALERTS newAlerts
POSTCLUSTERALERT newAlert
REMOVECLUSTERALERT timeStamp

Эти команды доступны только в Динамическом Кластере.
Используйте эти команды вместо команд [GET|SET|POST|REMOVE]SERVERALERT[S] для работы с общекластерными Предупреждениями.

Управление хранилищем файлов

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

аутентифицированный пользователь должен быть владельцем хранилища, или
у аутентифицированного пользователя должно быть право доступа к разделу Все Домены интерфейса Администратора Сервера или право Доступ к Хранилищам Файлов (CanAccessWebSites) Администратора Домена, или
аутентифицированному пользователю должны быть даны Права Доступа к Файлам для указанных файлов иди директорий (только если не указан параметр AUTH)

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

READSTORAGEFILE accountName FILE fileName [ OFFSET position ] [ SIZE sliceSize ] [ AUTH authAccountName ]

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

accountName : строка

fileName : строка

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

position : число

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

sliceSize : число

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

authAccountName : строка

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

WRITESTORAGEFILE accountName FILE fileName [ OFFSET position ] [ AUTH authAccountName ] DATA fileData

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

accountName : строка

fileName : строка

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

position : смещение

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

authAccountName : строка

fileData : блок данных

В этом параметре содержатся данные файла.

RENAMESTORAGEFILE accountName FILE oldFileName INTO newFileName [ AUTH authAccountName ]

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

accountName : строка

oldFileName : строка

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

newFileName : строка

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

authAccountName : строка

DELETESTORAGEFILE accountName FILE fileName [ AUTH authAccountName ]

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

accountName : строка

fileName : строка

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

authAccountName : строка

LISTSTORAGEFILES accountName [ PATH filePath ] [ AUTH authAccountName ]

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

accountName : строка

filePath : строка

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

authAccountName : строка

GETSTORAGEFILEINFO accountName [ PATH filePath ] [ AUTH authAccountName ]

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

accountName : строка

authAccountName : строка

READSTORAGEFILEATTR accountName FILE fileName [ attributes ] [ AUTH authAccountName ]

Эта функция читает атрибуты файла или директории fileName в Хранилище Файлов Пользователя. Эта команда возвращает массив из элементов XML с атрибутами файла или файловой директории.

accountName : строка

fileName : строка

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

attributes : массив

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

authAccountName : строка

UPDATESTORAGEFILEATTR accountName FILE fileName attributes [ AUTH authAccountName ]

Эта функция читает атрибуты файла или директории fileName в Хранилище Файлов Пользователя.

accountName : строка

fileName : строка

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

attributes : массив

Параметр задаёт массив элементов XML - новых значений атрибутов.

authAccountName : строка

GETFILESUBSCRIPTION accountName

Эта команда возвращает массив со списком «подписанных папок» Пользователя.

accountName : строка

SETFILESUBSCRIPTION accountName newSubscription

Используйте эту команду для задания списка «подписанных папок» Пользователя.

accountName : строка

newSubscription : массив

Список «подписанных папок». Каждый элемент массива должен быть строкой с именем папки.

Управление списками рассылки

Для использования команд CLI Управления Списками Рассылки необходимо иметь право доступа к разделу Все Домены Интерфейса Администратора Сервера или обладать правами для Управления Доменом.

LISTLISTS [ domainName ]

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

domainName : строка

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

GETDOMAINLISTS [ domainName ]

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

domainName : строка

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

GETACCOUNTLISTS accountName

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

accountName : строка

В этом параметре задаётся имя Пользователя - владельца списка.

CREATELIST listName for accountName

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

listName : строка

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

accountName : строка

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

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

RENAMELIST listName into newName

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

listName : строка

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

newName : строка

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

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

DELETELIST listName

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

listName : строка

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

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

GETLIST listName

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

listName : строка

UPDATELIST listName newSettings

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

listName : строка

newSettings : словарь

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

LIST listName operation [silently] [confirm] subscriber

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

listName : строка

Этот параметр задаёт операцию (дополнительную информацию смотрите в разделе модуль LIST).

silently

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

confirm

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

subscriber : адрес E-mail

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

Пример:

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

LISTSUBSCRIBERS listName [ FILTER filter [ limit ] ]

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

listName : строка

filter : строка

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

limit : число

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

READSUBSCRIBERS listName [ FILTER filter [ limit ] ]

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

listName : строка

filter : строка

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

limit : число

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

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

Sub

Строка с адресом электронной почты

RealName

необязательная строка с Настоящим Именем

mode

срока с режимом подписки (index, digest, null и т.д.)

subscribeTime

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

posts

число публикаций в этом списке

lastBounceTime

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

bounces

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

GETSUBSCRIBERINFO listName NAME subscriberAddress

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

listName : строка

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

subscriberAddress : строка

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

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

mode

Эта строка определяет режим подписки (digest, index и т.д.) Этот элемент равен unsubcribe, если подписка для адреса была отменена, но адрес ещё не был удалён из списка. Этот элемент равен subscribe, если пользователь начал процесс подписки, но подписка не была подтверждена.

confirmationID

В этом элементе содержится строка с Идентификатором Подтверждения для Пользователя.

timeSubscribed

Эта строка указывает время подписки адреса (в формате даты/времени ACAP).

posts

Этот элемент может содержать строки special, moderateAll, prohibited или строку с числом сообщений, опубликованных с этого адреса. Если следующая публикация с этого адреса должна модерироваться, то элемент содержит массив одностроковых элементов, содержащих число модерируемых публикаций.

bounces

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

lastBounced

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

RealName

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

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

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

listName : строка

subscriberAddress : строка

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

postingMode : число

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

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

PROCESSBOUNCE listName [ FATAL ] FOR subscriberAddress

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

listName : строка

subscriberAddress : строка

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

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

Форматы данных

API / Интерфейс командной строки. Часть 2