Набор обязательных элементов API для надстройки Outlook 1.8

Подмножество API надстройки Outlook API JavaScript для Office включает объекты, методы, свойства и события, которые можно использовать в надстройке Outlook.

Примечание.

В этой документации рассматривается не последняя версия набора обязательных элементов.

Новые возможности версии 1.8

Набор обязательных для почтового ящика 1.8 включает все функции набора требований 1.7. В нем добавлены перечисленные ниже возможности.

Добавлены методы для получения содержимого вложения или получения всех вложений элемента в режиме создания. Дополнительные сведения см. в статье Управление вложениями элемента в форме создания в Outlook.
Добавлен метод для добавления файла в виде вложения с помощью строки в кодировке Base64.
Добавлены свойства и методы для управления категориями элементов и в списке категорий master почтового ящика.
Добавлена поддержка сценариев делегированного доступа , включая метод для получения общих свойств и элемент манифеста для включения надстроек в общих папках.
Добавлен объект для управления набором расположений на встрече. Дополнительные сведения см. в разделе Получение или настройка расположения при создании встречи в Outlook.
Добавлен объект для получения и настройки пользовательских заголовков в Интернете для элемента сообщения в режиме создания.
Добавлен метод для получения всех заголовков в Интернете для элемента сообщения в режиме чтения.
Добавлен метод для получения данных инициализации, передаваемых при активации надстройки с помощью сообщения с действиями.
Добавлен метод для получения идентификатора сохраненного элемента встречи или сообщения.
Добавлен необязательный options параметр для event.completed вызова отмены выполнения события.
Добавлены события, возникающие при добавлении или удалении вложения и при изменении расположения встречи.

Список API

В следующей таблице перечислены API, представленные в наборе обязательных почтовых ящиков 1.8. Справочную документацию по API для всех API, поддерживаемых набором обязательных почтовых ящиков версии 1.8 или более ранней версии, см. в разделе API Outlook.

Класс	Поля	Описание
AppointmentCompose	addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void)	Добавляет файл в сообщение или встречу в качестве вложения.
	addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, options: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult<string>) => void)	Добавляет файл в сообщение или встречу в качестве вложения.
	Категории	Возвращает объект , предоставляющий методы для управления категориями элемента.
	enhancedLocation	Возвращает или задает расположения встречи.
	getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void)	Получает вложение из сообщения или встречи и возвращает его в `AttachmentContent` виде объекта .
	getAttachmentContentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void)	Получает вложение из сообщения или встречи и возвращает его в `AttachmentContent` виде объекта .
	getAttachmentsAsync(callback?: (asyncResult: Office.AsyncResult<AttachmentDetailsCompose[]>) => void)	Возвращает вложения элемента в виде массива.
	getAttachmentsAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<AttachmentDetailsCompose[]>) => void)	Возвращает вложения элемента в виде массива.
	getInitializationContextAsync(callback: (asyncResult: Строка Office.AsyncResult<) => void)>	Возвращает данные инициализации, передаваемые при активации надстройки с помощью сообщения с действиями.
	getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void)	Возвращает данные инициализации, передаваемые при активации надстройки с помощью сообщения с действиями.
	getItemIdAsync(callback: (asyncResult: Строка Office.AsyncResult<>) => void)	Асинхронно получает идентификатор элемента веб-служб Exchange (EWS)
	getItemIdAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void)	Асинхронно получает идентификатор элемента веб-служб Exchange (EWS)
	getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void)	Возвращает свойства встречи или сообщения в общей папке или общем почтовом ящике.
	getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void)	Возвращает свойства встречи или сообщения в общей папке или общем почтовом ящике.
AppointmentRead	Категории	Возвращает объект , предоставляющий методы для управления категориями элемента.
	enhancedLocation	Возвращает расположения встречи.
	getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void)	Получает вложение из сообщения или встречи и возвращает его в `AttachmentContent` виде объекта .
	getAttachmentContentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void)	Получает вложение из сообщения или встречи и возвращает его в `AttachmentContent` виде объекта .
	getInitializationContextAsync(callback: (asyncResult: Строка Office.AsyncResult<) => void)>	Возвращает данные инициализации, передаваемые при активации надстройки с помощью сообщения с действиями.
	getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void)	Возвращает данные инициализации, передаваемые при активации надстройки с помощью сообщения с действиями.
	getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void)	Возвращает свойства встречи или сообщения в общей папке или общем почтовом ящике.
	getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void)	Возвращает свойства встречи или сообщения в общей папке или общем почтовом ящике.
AttachmentContent	content	Содержимое вложения в виде строки.
	format	Формат строки, используемый для содержимого вложения.
AttachmentDetailsCompose	attachmentType	Возвращает значение, указывающее тип вложения.
	contentId	Возвращает идентификатор содержимого встроенного вложения.
	id	Возвращает идентификатор вложения.
	isInline	Возвращает значение, указывающее, отображается ли вложение в виде изображения в тексте элемента, а не в списке вложений.
	isServiceAccessible	В Outlook в Интернете и новом Outlook в Windows указывает, было ли отправлено встроенное вложение в сообщении на сервер и назначен идентификатор веб-служб Exchange (EWS).
	name	Получает имя вложения.
	size	Получает размер вложения в байтах.
	url	Возвращает URL-адрес вложения, если его тип — `MailboxEnums.AttachmentType.Cloud`.
AttachmentsChangedEventArgs	attachmentDetails	Возвращает объект , представляющий вложение, которое было добавлено или удалено из него.
	attachmentStatus	Указывает, было ли вложение добавлено или удалено из почтового элемента.
	type	Возвращает тип события, которое было создано.
Categories	addAsync(categories: string[], callback?: (asyncResult: Office.AsyncResult<void>) => void)	Добавляет категории в элемент.
	addAsync(categories: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void)	Добавляет категории в элемент.
	getAsync(callback: (asyncResult: Office.AsyncResult<CategoryDetails[]>) => void)	Возвращает категории элемента.
	getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<CategoryDetails[]>) => void)	Возвращает категории элемента.
	removeAsync(categories: string[], callback?: (asyncResult: Office.AsyncResult<void>) => void)	Удаляет категории из элемента.
	removeAsync(categories: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void)	Удаляет категории из элемента.
CategoryDetails	color	Цвет категории.
	displayName	Имя категории.
EnhancedLocation	addAsync(locationIdentifiers: LocationIdentifier[], callback?: (asyncResult: Office.AsyncResult<void>) => void)	Добавляет в набор расположений, связанных с встречей.
	addAsync(locationIdentifiers: LocationIdentifier[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void)	Добавляет в набор расположений, связанных с встречей.
	getAsync(обратный вызов?: (asyncResult: Office.AsyncResult<LocationDetails[]>) => void)	Возвращает набор расположений, связанных с встречей.
	getAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<LocationDetails[]>) => void)	Возвращает набор расположений, связанных с встречей.
	removeAsync(locationIdentifiers: LocationIdentifier[], callback?: (asyncResult: Office.AsyncResult<void>) => void)	Удаляет набор расположений, связанных с встречей.
	removeAsync(locationIdentifiers: LocationIdentifier[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void)	Удаляет набор расположений, связанных с встречей.
EnhancedLocationsChangedEventArgs	enhancedLocations	Возвращает набор расширенных расположений.
	type	Получает тип события.
InternetHeaders	getAsync(names: string[], обратный вызов: (asyncResult: Строка записи<Office.AsyncResult<, строка>>) => void)	Учитывая массив имен заголовков в Интернете, этот метод возвращает запись, содержащую эти заголовки интернета и их значения.
	getAsync(names: string[], options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<Record<string, string>>) => void)	Учитывая массив имен заголовков в Интернете, этот метод возвращает запись, содержащую эти заголовки интернета и их значения.
	removeAsync(names: string[], callback?: (asyncResult: Office.AsyncResult<void>) => void)	Учитывая массив имен заголовков в Интернете, этот метод удаляет указанные заголовки из коллекции заголовков Интернета.
	removeAsync(names: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void)	Учитывая массив имен заголовков в Интернете, этот метод удаляет указанные заголовки из коллекции заголовков Интернета.
	setAsync(headers: Record<string, string>, callback?: (asyncResult: Office.AsyncResult<void>) => void)	Задает указанные заголовки Интернета в указанные значения.
	setAsync(headers: Record<string, string>, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void)	Задает указанные заголовки Интернета в указанные значения.
LocationDetails	displayName	Отображаемое имя расположения.
	emailAddress	Адрес электронной почты, связанный с расположением.
	LocationIdentifier	Объект `LocationIdentifier` расположения.
LocationIdentifier	id	Уникальный идентификатор расположения.
	type	Тип расположения.
Mailbox	masterCategories	Возвращает объект , предоставляющий методы для управления категориями master списке, связанном с почтовым ящиком.
MasterCategories	addAsync(categories: CategoryDetails[], callback?: (asyncResult: Office.AsyncResult<void>) => void)	Добавляет категории в список master почтового ящика.
	addAsync(categories: CategoryDetails[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void)	Добавляет категории в список master почтового ящика.
	getAsync(callback: (asyncResult: Office.AsyncResult<CategoryDetails[]>) => void)	Возвращает master список категорий в почтовом ящике.
	getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<CategoryDetails[]>) => void)	Возвращает master список категорий в почтовом ящике.
	removeAsync(categories: string[], callback?: (asyncResult: Office.AsyncResult<void>) => void)	Удаляет категории из списка master почтового ящика.
	removeAsync(categories: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void)	Удаляет категории из списка master почтового ящика.
MessageCompose	addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void)	Добавляет файл в сообщение или встречу в качестве вложения.
	addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, options: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult<string>) => void)	Добавляет файл в сообщение или встречу в качестве вложения.
	Категории	Возвращает объект , предоставляющий методы для управления категориями элемента.
	getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void)	Получает вложение из сообщения или встречи и возвращает его в `AttachmentContent` виде объекта .
	getAttachmentContentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void)	Получает вложение из сообщения или встречи и возвращает его в `AttachmentContent` виде объекта .
	getAttachmentsAsync(callback?: (asyncResult: Office.AsyncResult<AttachmentDetailsCompose[]>) => void)	Возвращает вложения элемента в виде массива.
	getAttachmentsAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<AttachmentDetailsCompose[]>) => void)	Возвращает вложения элемента в виде массива.
	getInitializationContextAsync(callback: (asyncResult: Строка Office.AsyncResult<) => void)>	Возвращает данные инициализации, передаваемые при активации надстройки с помощью сообщения с действиями.
	getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void)	Возвращает данные инициализации, передаваемые при активации надстройки с помощью сообщения с действиями.
	getItemIdAsync(callback: (asyncResult: Строка Office.AsyncResult<>) => void)	Асинхронно получает идентификатор элемента веб-служб Exchange (EWS)
	getItemIdAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void)	Асинхронно получает идентификатор элемента веб-служб Exchange (EWS)
	getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void)	Возвращает свойства встречи или сообщения в общей папке или общем почтовом ящике.
	getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void)	Возвращает свойства встречи или сообщения в общей папке или общем почтовом ящике.
	internetHeaders	Возвращает или задает настраиваемые заголовки сообщения в Интернете.
MessageRead	Категории	Возвращает объект , предоставляющий методы для управления категориями элемента.
	getAllInternetHeadersAsync(callback?: (asyncResult: Строка Office.AsyncResult<) => void)>	Возвращает все заголовки интернета для сообщения в виде строки.
	getAllInternetHeadersAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<string>) => void)	Возвращает все заголовки интернета для сообщения в виде строки.
	getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void)	Получает вложение из сообщения или встречи и возвращает его в `AttachmentContent` виде объекта .
	getAttachmentContentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void)	Получает вложение из сообщения или встречи и возвращает его в `AttachmentContent` виде объекта .
	getInitializationContextAsync(callback: (asyncResult: Строка Office.AsyncResult<) => void)>	Возвращает данные инициализации, передаваемые при активации надстройки с помощью сообщения с действиями.
	getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void)	Возвращает данные инициализации, передаваемые при активации надстройки с помощью сообщения с действиями.
	getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void)	Возвращает свойства встречи или сообщения в общей папке или общем почтовом ящике.
	getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void)	Возвращает свойства встречи или сообщения в общей папке или общем почтовом ящике.
AttachmentContentFormat	Base64	Содержимое вложения возвращается в виде строки в кодировке Base64.
	Eml	Содержимое вложения возвращается в виде строки, представляющей .eml отформатированный файл.
	Icalendar	Содержимое вложения возвращается в виде строки, представляющей файл в формате ICALENDAR.
	Url	Содержимое вложения возвращается в виде строки, представляющей URL-адрес.
AttachmentStatus	Добавили	В элемент добавлено вложение.
	Удаленные элементы	Вложение было удалено из элемента.
CategoryColor	Нет	Цвет по умолчанию или цвет не сопоставлен.
	Preset0	Красный
	Preset1	Апельсин
	Preset10	Стальной
	Preset11	Темно-стальной
	Preset12	Серый
	Preset13	Темно-серый
	Preset14	Черный
	Preset15	Темно-красный
	Preset16	Темно-оранжевый
	Preset17	Темно-коричневый
	Preset18	Темно-желтый
	Preset19	Темно-зеленый
	Preset2	Коричневый
	Preset20	Темно-бирюзовый
	Preset21	Темно-оливковый
	Preset22	Темно-синий
	Preset23	Темно-фиолетовый
	Preset24	Темно-клюквенный
	Preset3	Желтый
	Preset4	Зеленый
	Preset5	Сине-зеленый
	Preset6	Оливковый
	Preset7	Синий
	Preset8	Сиреневый
	Preset9	Клюквенный
DelegatePermissions	DeleteAll	Делегат имеет разрешение на удаление любых элементов.
	DeleteOwn	Делегат имеет разрешение на удаление только созданных элементов.
	Изменитьвсе	Делегат имеет разрешение на изменение любых элементов.
	EditOwn	Делегат имеет разрешение на изменение только созданных ими элементов.
	Чтение	Делегат имеет разрешение на чтение элементов.
	Запись	Делегат имеет разрешение на создание и запись элементов.
LocationType	Пользовательский	Пользовательское расположение.
	Room	Конференц-зал или аналогичный ресурс с SMTP-адресом.
SharedProperties	delegatePermissions	Разрешения, имеющиеся у делегата в общей папке или у пользователя в общем почтовом ящике.
	owner	Адрес электронной почты владельца общего элемента.
	targetMailbox	Расположение почтового ящика владельца для доступа делегата.
	targetRestUrl	Базовый URL-адрес REST API (в настоящее время `https://outlook.office.com/api`).

События

В следующей таблице перечислены события , представленные в наборе требований 1.8. Список всех поддерживаемых событий, которые можно обрабатывать с помощью методов иremoveHandlerAsync, см. в addHandlerAsync разделе Office.EventType.

Событие	Описание	Object
ВложенияИзменение	Вложение было добавлено в элемент или удалено из него.	Элемент
EnhancedLocationsChanged	Расположение встречи было изменено.	Элемент

Обновления манифеста

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

Функция	Унифицированный манифест для Microsoft 365	Манифест только надстройки	Описание
Поддержка общих папок	`"authorization.permissions.resourceSpecific.name"` установите значение `"Mailbox.SharedFolder"`	SupportsSharedFolders	Определяет, доступна ли надстройка в сценариях с общими папками.

См. также

Обратная связь

Были ли сведения на этой странице полезными?

Last updated on 2026-03-25