Документация Ведок Help

Опция интеграции с электронной почтой (IMAP)

Vedoc admin manual logo image

Версия 2.0.x

Настройка опции

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

Активация лицензии опции Интеграции с электронной почтой

Необходимые требования

  • наличие лицензии - опция интеграции с электронной почтой IMAP.

  • доступ в Интернет с компьютера, на котором установлен Ведок.

  • данная опция доступна в Ведок с версии 1.5.0.

Дополнительные Роли

Для управления настройками и использования данной опции в системе существуют две роли:

  • Администратор IMAP (код роли imap4appaddon-admin-role).

  • Пользователь IMAP (код роли imap4appaddon-user-role).

Роль Администратор Imap предоставляет доступ к настройкам (созданию\редактированию) почтовых ящиков (папок) почтового сервера, с которым синхронизируется приложение. Доступ через пункт меню Администрирование > Конфигурация IMAP:

24081918221 vedoc email imap imap config

Роль - Пользователь Imap, предоставляет доступ к экрану Почтовые сообщения > Просмотр email, который отображает перечень сообщений, синхронизированных с базой данных приложения:

24081918222 vedoc email imap imap message browse

Создание подключения к почтовому ящику

Авторизуйтесь в Ведок под пользователем administrator. По умолчанию этому пользователю уже назначена роль Администратор IMAP. Перейдите в пункт меню Администрирование > Конфигурация IMAP, нажмите кнопку Создать для создания нового подключения к почтовому ящику, с которым будет работать приложение.

24081918223 vedoc email imap registeg mailbox

Заполните поля:

Имя – отображаемое имя подключения к почтовому ящику.

Хост - имя хоста или IP-адрес почтового сервера (например, imap.yandex.ru).

Порт - номер порта для подключения к почтовому серверу. Значение по умолчанию — 143 (для imap.yandex.ru c SSL/TLS – 993).

Безопасное соединение - протокол безопасного соединения, если это необходимо (для imap.yandex.ru – SSL/TLS).

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

Пароль - пароль пользователя для подключения к почтовому серверу (либо токен приложения).

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

24081918224 vedoc email imap mailbox settings

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

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

Для параметра Пользовательский флаг лучше использовать формат, который обеспечит его уникальность: Prefix<датавремя> (например, MyFlag1234554321).

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

Запуск задания для периодической синхронизации

Перейдите в пункт меню Администрирование > Назначенные задания, выделите строку с Imap_ImapScheduler и нажмите кнопку Активировать для запуска задания синхронизации.

24081918225 vedoc email imap activate task

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

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

Last modified: 11 February 2025