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

CLI доступ к Сервер CommuniGate Pro доступно как расширение для PWD протокола.

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

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

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

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

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

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

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

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

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

domainName : string

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

filter : string

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

limit : numeric string

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

ACCOUNTS, ALIASES, FORWARDERS

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

filter : string

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

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

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

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

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

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

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

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

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

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

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

LISTACCOUNTS [ domainName ]

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

domainName : string

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

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

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

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

Для использования команд 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 по администрированию Доменов необходимо иметь право доступа Может менять установки Всех Доменов и Пользователей или обладать правами на Администрирование Домена.

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

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

INSERTDIRECTORYRECORDS domainName

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

domainName : string

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

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

DELETEDIRECTORYRECORDS domainName

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

domainName : string

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

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

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

LISTDOMAINS

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

MAINDOMAINNAME

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

GETDOMAINDEFAULTS

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

UPDATEDOMAINDEFAULTS newSettings

Используйте эту команду для изменения Умолчаний для Домена, Общих для Сервера.

newSettings : dictionary

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

SETDOMAINDEFAULTS newSettings

Используйте эту команду для изменения Умолчаний для Домена, Общих для Сервера.

newSettings : dictionary

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

GETCLUSTERDOMAINDEFAULTS
UPDATECLUSTERDOMAINDEFAULTS newSettings
SETCLUSTERDOMAINDEFAULTS newSettings

Эти команды доступны только в Динамическом Кластере.
Используйте эти команды вместо команд [Get|Update|Set]DomainDefaults для работы с общекластерными Умолчаниями для Домена.

GETALLACCOUNTSDEFAULTS

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

UPDATEALLACCOUNTSDEFAULTS newSettings

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

newSettings : dictionary

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

SETALLACCOUNTSDEFAULTS newSettings

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

newSettings : dictionary

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

GETCLUSTERACCOUNTDEFAULTS
UPDATECLUSTERACCOUNTDEFAULTS newSettings
SETCLUSTERACCOUNTDEFAULTS newSettings

Эти команды доступны только в Динамическом Кластере.
Используйте эти команды вместо команд [Get|Update|Set]AllAccountsDefaults для работы с общекластерными Умолчаниями для Домена.

GETSERVERACCOUNTPREFS

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

SETSERVERACCOUNTPREFS newSettings

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

newSettings : dictionary

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

GETCLUSTERACCOUNTPREFS
SETCLUSTERACCOUNTPREFS newSettings

Эти команды доступны только в Динамическом Кластере.
Используйте эти команды вместо команд [GET|SET]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 Доменов разрешено.

SETDOMAINALIASES domainName newAliases

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

domainName : string

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

newAliases : array

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

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 для работы с общекластерными настройками Центрального Справочника.

SETDOMAINSETTINGS domainName newSettings

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

domainName : string

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

newSettings : dictionary

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

SETACCOUNTSETTINGS accountName newSettings

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

accountName : string

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

newSettings : dictionary

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

SETACCOUNTDEFAULTS [ domainName ] newSettings

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

domainName : string

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

newSettings : dictionary

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

SETACCOUNTTEMPLATE [ domainName ] newSettings

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

domainName : string

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

newSettings : dictionary

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

GETDOMAINLOCATION [ domainName ]

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

domainName : string

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

GETACCOUNTLOCATION accountName

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

accountName : string

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

Для использования команд 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 добавляются к кон�