Наборы обязательных элементов API JavaScript для Outlook

Надстройки Outlook объявляют, какие версии API им требуются в манифесте. Разметка зависит от того, используете ли вы только формат манифеста надстройки или унифицированный манифест для Microsoft 365.

"extensions": [
{
  "requirements": {
    "capabilities": [
      {
        "name": "Mailbox", "minVersion": "1.1"
      }
    ]
  },
  ...
}

<Requirements>
  <Sets>
    <Set Name="Mailbox" MinVersion="1.1" />
  </Sets>
</Requirements>

Все API Outlook относятся к наборуMailbox требований. У набора требований Mailbox есть версии, а каждый новый выпускаемый набор API-интерфейсов приведен в наборе более поздней версии. Не все клиенты Outlook поддерживают новейший набор API, но если клиент Outlook объявляет поддержку набора требований, обычно он поддерживает все API в этом наборе требований (проверка документацию по конкретному API или функции для любых исключений).

Установка минимальной версии набора обязательных элементов в манифесте определяет, в которых клиент Outlook будет отображать надстройку. Если клиент не поддерживает минимальный набор требований, он не загружает надстройку. Например, если указан набор обязательных элементов версии 1.3, это означает, что надстройка не будет отображаться ни в одном клиенте Outlook, который не поддерживает хотя бы 1.3.

Использование API из более поздних наборов требований

Установка набора требований не ограничивает доступные API, которые может использовать надстройка. Например, если надстройка указывает набор требований "Почтовый ящик 1.1", но выполняется в клиенте Outlook, который поддерживает "Почтовый ящик 1.3", надстройка может использовать API из набора требований "Почтовый ящик 1.3".

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

if (Office.context.requirements.isSetSupported('Mailbox', '1.3')) {
  // Perform actions.
}
else {
  // Provide alternate flow/logic.
}

Кроме того, разработчики могут проверить наличие более новых API с помощью стандартных методов JavaScript.

if (item.somePropertyOrMethod !== undefined) {
  // Use item.somePropertyOrMethod.
  item.somePropertyOrMethod;
}

Такие проверки не нужно выполнять для API-интерфейсов, присутствующих в версии набора обязательных элементов, указанной в манифесте.

Выбор минимального набора требований

Разработчикам следует использовать набор обязательных элементов самой ранней версии, содержащий набор критически важных API для сценария их работы, без которого надстройка не будет работать.

Наборы обязательных элементов, поддерживаемые серверами Exchange и клиентами Outlook

В этом разделе указан диапазон наборов обязательных элементов, поддерживаемых сервером Exchange и клиентами Outlook. Сведения о требованиях к серверу и клиенту для запуска надстроек Outlook см. в статье Требования надстроек Outlook.

Поддержка сервера Exchange

Указанные ниже серверы поддерживают надстройки Outlook.

Поддержка клиентов Outlook

Надстройки поддерживаются в Outlook на следующих платформах.

Поддержка версий для наборов требований в классической версии Outlook в Windows

В следующей таблице приведена поддержка версий для более поздних наборов обязательных почтовых ящиков в классической версии Outlook для Windows с подпиской Microsoft 365 или розничной бессрочной лицензией.

Дополнительные сведения о версии клиента см. на странице журнала обновлений Для Microsoft 365 или Office 2024 и на странице о том, как найти версию клиента Office и канал обновления.

Ссылка на рабочую библиотеку API JavaScript для Office

Чтобы использовать API в любом из нумерованных наборов обязательных элементов, следует ссылаться на рабочую библиотеку в сети доставки содержимого (CDN) Office.js. Сведения об использовании api предварительной версии см. в разделе Тестирование api предварительной версии.

Интерфейсы API тестовой предварительной версии

Новые API JavaScript для Outlook сначала выпускаются в "предварительной версии", а затем становятся частью определенного нумерованного набора обязательных элементов после выполнения достаточного тестирования и получения отзывов пользователей. Чтобы отправить отзыв о предварительной версии API, используйте способ обратной связи, представленный в конце веб-страницы с описанием API.

Дополнительные сведения о предварительных версиях интерфейсов API см. в статье Предварительная версия набора обязательных элементов API для Outlook.