ISPmanager API. Почтовые ящики

Почтовые ящики
Создание. Изменение. Почтовый ящик
Автоответчик (vacation) . Просмотр. Изменение
Сортировка почты
Создание. Изменение. Почтовый фильтр
Удалить почтовые фильтры
Удалить почтовые ящики
Очистить почтовые ящики
Включить почтовые ящики
Отключить почтовые ящики
Настройка Outlook Express. Просмотр. Изменение

Почтовые ящики.

Функция: email

Результат: список элементов

name - Имя.
pop3 - Логин POP3.
disabled - Почтовый ящик временно отключен.
size - Размер. Атрибуты :
used - Использованное количество.
limit - Максимально возможное значение.

Создание. Изменение. Почтовый ящик.

Функция: email.edit

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

Просмотр параметров объекта:

Параметры:
elid - уникальный идентификатор (элемент "name" из функции "email")
Результат: список параметров объекта

Создание объекта:

Параметры:
sok - значение параметра должно быть равно "yes".
дополнительные параметры запроса ...
Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

Параметры:
sok - значение параметра должно быть равно "yes".
elid - уникальный идентификатор (элемент "name" из функции "email")
дополнительные параметры запроса ...
Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

name - Имя.
domain - Домен.
aliases - Псевдонимы. (Одно или несколько значений, разделенных пробелом)
passwd - Пароль.
confirm - Подтверждение.
quota - Макс. размер. (Числовое значение. Для указания "бесконечности" используйте "0".)
forward - Пересылать почту. (Одно или несколько значений, разделенных пробелом)
rmlocal - Не сохранять в ящик. (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
greylist - Включить greylisting. (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)

Автоответчик (vacation) . Просмотр. Изменение.

Функция: email.vacation

Данная функция одновременно используется для просмотра и изменения параметров объекта

Просмотр параметров объекта:

Параметры:
elid - уникальный идентификатор (элемент "name" из функции "email")
Результат: список параметров

Изменение объекта:

Параметры:
sok - значение параметра должно быть равно "yes".
elid - уникальный идентификатор (элемент "name" из функции "email")
дополнительные параметры запроса ...
Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

arfrom - От.
arsubj - Тема.
arbody - Сообщение.

Сортировка почты.

Функция: email.filter

Параметры:

elid - уникальный идентификатор (элемент "name" из функции "email").

Результат: список элементов

name - Название почтового фильтра.

Создание. Изменение. Почтовый фильтр.

Функция: email.filter.edit

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

Просмотр параметров объекта:

Параметры:
plid - уникальный идентификатор родительского списка (элемент "name" из функции "email").
elid - уникальный идентификатор (элемент "name" из функции "email.filter")
Результат: список параметров объекта

Создание объекта:

Параметры:
sok - значение параметра должно быть равно "yes".
plid - уникальный идентификатор родительского списка (элемент "name" из функции "email").
дополнительные параметры запроса ...
Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

Параметры:
sok - значение параметра должно быть равно "yes".
plid - уникальный идентификатор родительского списка (элемент "name" из функции "email").
elid - уникальный идентификатор (элемент "name" из функции "email.filter")
дополнительные параметры запроса ...
Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

name - Название.
pos - Расположить перед.
cond_param - Параметр.
cond - Условие.
cond_value - Значение.
cond_ereg - Регулярное выражение. (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
act - Действие.
act_email - E-Mail.
act_imap - Папка IMAP.
act_imap_new - Новая папка IMAP.
act_command - Программа.

Удалить почтовые фильтры.

Функция: email.filter.delete

Параметры:

plid - уникальный идентификатор родительского списка (элемент "name" из функции "email").
elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "name" из функции "email.filter".

Результат: успешное выполнение операции или сообщение об ошибке

Удалить почтовые ящики.

Функция: email.delete

Параметры:

elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "name" из функции "email".

Результат: успешное выполнение операции или сообщение об ошибке

Очистить почтовые ящики.

Функция: email.clear

Параметры:

elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "name" из функции "email".

Результат: успешное выполнение операции или сообщение об ошибке

Включить почтовые ящики.

Функция: email.enable

Параметры:

elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "name" из функции "email".

Результат: успешное выполнение операции или сообщение об ошибке

Отключить почтовые ящики.

Функция: email.disable

Параметры:

elid - один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор - это элемент "name" из функции "email".

Результат: успешное выполнение операции или сообщение об ошибке

Настройка Outlook Express. Просмотр. Изменение.

Функция: email.outlook

Данная функция одновременно используется для просмотра и изменения параметров объекта

Просмотр параметров объекта:

Параметры:
elid - уникальный идентификатор (элемент "name" из функции "email")
Результат: список параметров

Изменение объекта:

Параметры:
sok - значение параметра должно быть равно "yes".
elid - уникальный идентификатор (элемент "name" из функции "email")
дополнительные параметры запроса ...
Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):