Перейти к содержимому

Прочитать почту

Тип узла: browser_getEmail

Назначение

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

Настройки в настольном клиенте

Настройки узла «Прочитать почту» в настольном клиенте

Снимок сделан в английском интерфейсе MoreLogin Desktop V2.73.101.

Входные данные

Эти поля указываются в data.browserUi.inputs.

ПолеТип или значенияОбязательно по схемеПо умолчанию при выполненииОписание и ограничения
userstringНет—Почтовый аккаунт
authType"password" / "oauth2" (поддерживает ссылки на переменные)Нет"password"Способ авторизации. Начальное значение в редакторе: "password"
passwordstringНет—Пароль / код авторизации
imapHoststringНет—Сервер IMAP
portWorkflowNumberНет993Порт; после вычисления целое число 1–65535. Начальное значение в редакторе: 993
tlsboolean (поддерживает ссылки на переменные)НетtrueВключить TLS. Начальное значение в редакторе: true
clientIdstringНет—ID клиента
clientSecretstringНет—Секрет клиента
refreshTokenstringНет—Токен обновления
status"UNSEEN" / "SEEN" / "ALL" (поддерживает ссылки на переменные)Нет"UNSEEN"Статус письма. Начальное значение в редакторе: "UNSEEN"
isJunkboolean (поддерживает ссылки на переменные)НетfalseИскать также в спаме. Начальное значение в редакторе: false
seenboolean (поддерживает ссылки на переменные)НетfalseОтмечать как прочитанное после получения. Начальное значение в редакторе: false
fromstringНет—Фильтр по отправителю
mailTostringНет—Фильтр по получателю
subjectstringНет—Тема содержит
keywordstringНет—Ключевое слово в тексте письма
dateType"all" / "today" / "recent" (поддерживает ссылки на переменные)Нет"all"Дата письма. Начальное значение в редакторе: "all"
regstringНет—Регулярное выражение для извлечения

Требования к режимам и ограничения

  • Обязательные поля: user, imapHost, port
  • imapHost содержит имя хоста; port является целым числом в диапазоне 1–65535.
  • Код ошибки проверки: RPA_NODE_INPUT_INVALID

authType eq "password"

  • Обязательное поле: password
  • Значение является паролем или кодом авторизации почтового ящика.
  • Код ошибки проверки: RPA_NODE_INPUT_INVALID

authType eq "oauth2"

  • Обязательные поля: clientId, refreshToken
  • Этот режим поддерживает только IMAP Outlook/Hotmail. refresh_token Microsoft обменивается на access_token, а обновлённый refresh_token кешируется локально в зашифрованном виде. clientSecret необязателен (публичным клиентским приложениям он не нужен).
  • Код ошибки проверки: RPA_NODE_INPUT_INVALID
  • Узел устанавливает реальное подключение IMAP и читает самое новое письмо, соответствующее фильтрам. Режим password использует пароль или код авторизации и работает с любым хостом IMAP. OAuth2 и «Искать также в спаме» поддерживаются только для Outlook/Hotmail (outlook.office365.com, imap-mail.outlook.com); для других хостов возвращается MAIL_PROVIDER_UNSUPPORTED. imapHost принимает только имя хоста, без порта и пути. Период «последние три дня» включает сегодняшний день и два предыдущих дня по локальному времени компьютера, на котором выполняется запуск. Если задан reg, возвращается первая группа захвата или всё совпадение. Если самое новое письмо не подходит, возвращается null, а более старые письма не проверяются. Если reg не задан, extractedValue содержит текст письма. seen=true отмечает как прочитанное только выбранное письмо. message.receivedAt содержит время получения письма (локальное время настольного клиента, YYYY-MM-DD HH:mm:ss). Если в одной папке больше 10000 писем-кандидатов, возвращается MAIL_SEARCH_LIMIT; если одно письмо больше 10 MiB, возвращается MAIL_MESSAGE_LIMIT; при сбое подключения/аутентификации возвращается MAIL_CONNECTION_FAILED (исходный текст сервера и учётные данные не раскрываются). POP3, отправка писем и скачивание вложений не поддерживаются.
  • Код ошибки проверки: RPA_NODE_INPUT_INVALID

Ссылки во входных данных

ПолеДопустимые формы
userliteral, template
authTypeliteral, template
passwordliteral, template
imapHostliteral, template
portliteral, template
tlsliteral, template
clientIdliteral, template
clientSecretliteral, template
refreshTokenliteral, template
statusliteral, template
isJunkliteral, template
seenliteral, template
fromliteral, template
mailToliteral, template
subjectliteral, template
keywordliteral, template
dateTypeliteral, template
regliteral, template

Выходные данные

Поле выходных данныхТип или значения
foundboolean
messageobject / null
extractedValuestring / null

Ссылайтесь на опубликованные поля в виде ${nodeId.data.field}.

Пример JSON

Полный объект узла для массива nodes сценария или для blocks другого узла. mailPassword является приватным начальным параметром, объявленным в workflow.variables.

{
  "id": "read_code_email",
  "type": "browser_getEmail",
  "data": {
    "title": "Read the verification email",
    "browserAction": "getEmail",
    "browserUi": {
      "inputs": {
        "user": "user@example.com",
        "authType": "password",
        "password": "${mailPassword}",
        "imapHost": "imap.example.com",
        "port": 993,
        "tls": true,
        "status": "UNSEEN",
        "from": "no-reply@example.com",
        "dateType": "today",
        "reg": "\\b(\\d{6})\\b"
      },
      "exception": {
        "timeout": 30000,
        "policy": "interrupt"
      }
    }
  }
}

Назад к каталогу узлов