Команды описанные в этом разделе предназначены для работы с
адресной книгой реализуемой модулем AB
и доступны если в возможности
сервера COMMAND-SET указан набор команд
AB
.
Любым аутентифицированным пользователям доступен поиск по адресной книге (команда AB). Администраторы и операторы домена могут управлять доступностью для поиска данных отдельных пользователей (команда ABSET). Администраторы могут управлять доступностью для поиска данных пользователей целых доменов.
ABLIST
{ DOMAINS | USERS:domain
} [{ START | END | CONTAIN }"text"
] [start
[number
]]
Команда ABLIST позволяет получить списки доменов и пользователей информация о которых хранится в адресной книге. Эта команда доступна только администраторам и, с некоторыми ограничениями, операторам домена.
Первый аргумент команды указывает какой список необходимо
получить: DOMAINS - список доменов,
USERS:domain
- список пользователей домена
domain
. Операторы
домена могут запрашивать только список пользователей и
только своего домена.
В отличие от многих других команд, здесь в качестве имени домена не допускается использование псевдонимов в случае, если команда посылается оператором домена.
Следующий аргумент является необязательным и указывает фильтр имён получаемых объектов. Аргумент определяет в какой части имени объекта будет производиться регистронезависимый поиск подстроки указанной в параметре: START - имя должно начинаться с указанной подстроки, END - имя должно заканчиваться на указанную подстроку, CONTAIN - имя должно содержать указанную подстроку. В результат включаются только те элементы списка, в именах которых найдена указанная подстрока.
Aргумент start
позволяет запросить
часть списка результата и задаёт индекс первого объекта с которого
должен начинаться список. Первый объект имеет индекс 0. Необязательный
аргумент number
задаёт ограничение
количества объектов результата.
Результатом успешного выполнения команды являются ноль или более
*-строк каждая из которых содержит два аргумента: имя домена или
пользователя в кавычках и флаг H
(скрыт для поиска) или V
(доступен
для поиска). Вывод завершается ответом OK.
ABSET
{ "user@domain"
| "domain"
} { HIDDEN | H | VISIBLE | V }
Команда ABSET управляет доступностью для поиска отдельных пользователей или целых доменов и доступна только администраторам и, с некоторыми ограничениями, операторам домена.
Операторы домена могут управлять доступностью для поиска только данных отдельных пользователей и только в своём домене.
Первый аргумент указывает имя объекта - пользователя или домена
. Если во втором аргументе указан один из синонимов:
HIDDEN
или H
, то объект
будет скрыт для поиска, значение VISIBLE
или
V
делает объект доступным для поиска.
В отличие от многих других команд, здесь в качестве имени домена не допускается использование псевдонимов в случае, если команда посылается оператором домена.
При успешном выполнении сервер посылает ответ OK.
AB
{{ START | END | CONTAIN }"text"
} [number
]
Команда AB предназначена для поиска данных пользователей в адресной книге и доступна любому аутентифицированному пользователю.
Ключевые слова START, END и CONTAIN указывают как в данных
пользователя будет осуществляться поиск строки
"text"
: соответственно, в начале строк, в
конце строк или в любом месте строки. Последний аргумент необязателен
и задаёт ограничение количества записей результата. По-умолчанию,
максимальное количество записей в результате - 1000.
Поиск подстроки "text"
осуществляется
в следующих данных пользователей записанных в адресной книге: адрес
электронной почты, имя пользователя, полное имя/название, фамилия,
имя.
При успешном выполнении сервер посылает ноль или более *-строк.
Каждая такая строка содержит аргументы в виде строк в кавычках: имя
пользователя с доменной частью (т.е. адрес электронной почты),
дополнительные почтовые ящики, полное имя/название, организация,
подразделение. Если информации о каких-то из перечисленных данных нет,
то на соответствующем месте указываются пустые строки
""
. Вывод завершается ответом
OK.