Описанные в этом разделе функции решают самые частые задачи не требуя от пользователя изучения протокола MMP и выполняют все необходимые действия связанные с отправкой команд и чтением ответов сервера.
Кроме ответа SUCCESS:
при
успешном выполнении и ERROR:
в случае ошибки, данные функции могут возвращать значение
code
FAIL:
в
случае отказа в выполнении команды сервером. Вызывающий сценарий может
проанализировать строку после двоеточия для определения причин
отказа.text
mmpQueryUser(handle,stem[,username])
Функция устанавливает свойства пользователя, имя которого задано
аргументом username
, который может быть
псевдонимом. Если имя указано без доменной части - используется домен
текущего пользователя сеанса handle
. Если
аргумент username
опущен, подразумевается
текущий пользователь сеанса handle
.
При успешном выполнении функция возвращает строку
SUCCESS:
и заполняет
переменную-основу (stem) REXX. Имя переменной задаётся вторым
аргументом. После возврата переменная будет содержать:
stem
.USERПолное имя пользователя.
stem
.FLAGSФлаги пользователя разделённые пробелом.
stem
.LIMITОграничение ресурса пользователя на хранилище (в байтах).
stem
.USEDИспользованный объём ресурса пользователя на хранилище (в байтах).
stem
.COPYTOАдрес электронной почты на который будут отправляться входящие сообщения пользователя.
stem
.DEPTHMAXОграничение на глубину вложенности папок (или почтовых ящиков в терминах IMAP) которые может создавать пользователь.
stem
.LOGINTIMEДата и время последней успешной аутентификации
пользователя в формате
YYYY
-MM
-DD
HH
:MM
:SS
,
где: YYYY
- год,
MM
- месяц,
DD
- день месяца,
HH
:MM
:SS
- время (часы:минуты:секунды).
Пользователи создавшие сеанс не имеющие флагов OPER или ADMIN могут запрашивать только собственные свойства. Операторы доменов могут запрашивать свойства пользователей только своего домена, если это не администраторы или операторы домена.
mmpSetUser(handle,stem[,username])
Функция устанавливает свойства пользователя, имя которого задано
аргументом username
, который может быть
псевдонимом. Если имя указано без доменной части - используется домен
текущего пользователя сеанса handle
. Если
аргумент username
опущен, подразумевается
текущий пользователь сеанса handle
.
При успешном выполнении функция устанавливает свойства
пользователя используя значения переменной-основы (stem) REXX, имя
которой указано во втором аргументе, и возвращает строку
SUCCESS:
. Используются следующие
значения переменной stem
:
stem
.PASSWORDПароль пользователя. Пароль должен удовлетворять
требованиям к сложности заданным конфигурацией, в
противном случае изменения не будут приняты и результатом
выполнения функции будет строка FAIL:NO
(TOO-WEAK-PSWD) "The password is not strong
enough"
.
stem
.FLAGSФлаги пользователя разделённые пробелом. Операторы домена не могут указывать флаги ADMIN и OPER.
stem
.LIMITОграничение ресурса пользователя на хранилище (в байтах или с указанием размерности как в конфигурации).
stem
.COPYTOАдрес электронной почты на который будут отправляться входящие сообщения пользователя.
stem
.DEPTHMAXОграничение на глубину вложенности папок (или почтовых ящиков в терминах IMAP) которые может создавать пользователь.
Пользователи не имеющие флагов OPER или ADMIN могут устанавливать только собственное свойство PASSWORD. Операторы домена могут устанавливать свойства пользователей только своего домена, если это не администраторы или операторы домена.
mmpCreateUser(handle,[stem],username)
Функция создаёт нового пользователя с именем из
username
до "@" в домене, имя которого
взято из доменной части username
. Если имя
указано без доменной части - используется имя
username
и домен текущего пользователя
сеанса handle
.
Если указан второй аргумент, он рассматривается как имя переменной-основы (stem) REXX, следующие её значения используются для установки свойств нового пользователя:
stem
.PASSWORDПароль пользователя.
stem
.FLAGSФлаги пользователя разделённые пробелом. Операторы домена не могут указывать флаги ADMIN и OPER.
stem
.LIMITОграничение ресурса пользователя на хранилище (в байтах или с указанием размерности как в конфигурации).
stem
.COPYTOАдрес электронной почты на который будут отправляться входящие сообщения пользователя.
stem
.DEPTHMAXОграничение на глубину вложенности папок (или почтовых ящиков в терминах IMAP) которые может создавать пользователь.
Операторы домена могут создавать пользователей только в своих доменах.
mmpDeleteUser(handle,username)
Функция удаляет пользователя с именем из
username
до "@" в домене с именем взятым из
доменной части username
. Если имя указано
без доменной части - используется имя
username
и домен текущего пользователя
сеанса handle
.
Операторы домена могут удалять пользователей только в своих доменах и только тех, у которых не установлены флаги ADMIN или OPER.
mmpQueryVCStem(handle,stem[,username])
Функция запрашивает личные данные пользователя
username
из vCard и заполняет
соответствующие значения переменной-основы (stem) REXX, имя которой
указано во втором аргументе:
stem
.N_FAMILYФамилия.
stem
.N_GIVENИмя.
stem
.N_MIDДополнительное/второе имя / отчество.
stem
.N_PREFПочтительные префиксы.
stem
.N_SUFFПочтительные суффиксы.
stem
.ORGОрганизация.
stem
.ORG_DEPОтдел.
stem
.TEL_HOMEНомер телефона, домашний.
stem
.TEL_WORKНомер телефона, рабочий.
stem
.TEL_CELLНомер телефона, сотовый.
stem
.FNПолное имя / название.
stem
.NICKNAMEПсевдоним.
stem
.TITLEДолжность.
stem
.EMAILАльтернативный адрес эл. почты.
stem
.NOTEПримечание.
Если имя пользователя опущено, используется текущий пользователь
сессии handle
.
mmpSetVCStem(handle,stem[,username])
Функция устанавливает личные данные пользователя
username
формируя vCard из соответствующих
значений переменной-основы (stem) REXX, имя которой указано во втором
аргументе. Переменная stem
имеет те же
значения что и для функции mmpQueryVCStem.
Обычные пользователи могут устанавливать vCard только для своей учётной записи и только если для пользователя установлен флаг VCARD. Операторы домена могут устанавливать vCard только для пользователей своего домена если они не являются операторами домена или администраторами.