outlook package

Подкласс Элемента, занимающегося встречами.

Важно! Это внутренний объект Outlook, который не предоставляется напрямую через существующие интерфейсы. Этот режим следует рассматривать как режим Office.context.mailbox.item. Дополнительные сведения см. на странице Объектная модель .

Дочерние интерфейсы:

• AppointmentCompose

• AppointmentRead

Режим организатора встреч Office.context.mailbox.item.

Важно! Это внутренний объект Outlook, который не предоставляется напрямую через существующие интерфейсы. Этот режим следует рассматривать как режим Office.context.mailbox.item. Дополнительные сведения см. на странице Объектная модель .

Родительские интерфейсы:

• ItemCompose

• Встреча

Объект AppointmentForm используется для доступа к выбранной встрече.

Режим участника встречи Office.context.mailbox.item.

Важно! Это внутренний объект Outlook, который не предоставляется напрямую через существующие интерфейсы. Этот режим следует рассматривать как режим Office.context.mailbox.item. Дополнительные сведения см. на странице Объектная модель .

Родительские интерфейсы:

• ItemRead

• Встреча

Предоставляет текущие даты и время встречи, которая вызвала Office.EventType.AppointmentTimeChanged событие.

Представляет содержимое вложения в сообщении или элементе встречи.

Представляет вложение элемента с сервера. Только в режиме чтения.

Массив AttachmentDetails объектов возвращается в качестве attachments свойства элемента встречи или сообщения.

Представляет вложение в элементе. Только в режиме создания.

AttachmentDetailsCompose Массив объектов возвращается методом getAttachmentsAsync .

Предоставляет сведения о вложении в элементе почты, вызвавном Office.EventType.AttachmentsChanged событие.

Основной объект предоставляет методы для добавления и обновления содержимого сообщения или встречи. Он возвращается в свойстве body выбранного элемента.

Представляет категории элемента.

В Outlook пользователь может помечать сообщения и встречи тегами, используя категорию для их цветового кода. Пользователь определяет категории в списке master в почтовом ящике. Затем он может применить одну или несколько категорий к элементу.

Важно! В Outlook в Интернете и новом Outlook в Windows нельзя использовать API для управления категориями, примененными к сообщению, в режиме Compose.

Представляет сведения о категории, такие как имя и связанный цвет.

Предоставляет параметр для формата данных.

Представляет сведения о контакте (аналогично физическому контакту или бизнес-карта), извлеченные из тела элемента. Только в режиме чтения.

Список контактов, извлеченных из текста сообщения электронной почты или встречи, возвращается в contacts свойстве объекта Entities, возвращаемого методом getEntities или getEntitiesByType текущего элемента.

Предупреждение. Контекстные надстройки Outlook на основе сущностей теперь прекращены. Однако правила регулярных выражений по-прежнему поддерживаются. Мы рекомендуем обновить контекстную надстройку, чтобы использовать правила регулярных выражений в качестве альтернативного решения. Инструкции по реализации этих правил см. в разделе Контекстные надстройки Outlook.

Объект CustomProperties представляет пользовательские свойства, относящиеся к конкретному почтовому элементу и относящиеся к надстройке Outlook. Например, может потребоваться, чтобы надстройка сохранила некоторые данные, относящиеся к текущему сообщению, которое активировало надстройку. Если пользователь повторно откроет то же сообщение в будущем и снова активирует надстройку, надстройка сможет получить данные, сохраненные в качестве пользовательских свойств.

Дополнительные сведения см CustomProperties. в статье Получение и настройка метаданных надстройки для надстройки Outlook.

Объект DelayDeliveryTime позволяет управлять датой и временем отложенной доставки сообщения.

Предоставляет надстройке Outlook диагностические сведения.

Предоставляет свойства для временного задания содержимого, отображаемого в тексте или теме сообщения в режиме чтения.

Предоставляет метод для временного задания содержимого, отображаемого в тексте сообщения, в режиме чтения.

Предоставляет метод для временного задания содержимого, отображаемого в теме сообщения, в режиме чтения.

Предоставляет свойства электронной почты отправителя или указанных получателей сообщения электронной почты или встречи.

Представляет учетную запись электронной почты на сервере Exchange Server.

Представляет набор расположений для встречи.

Предоставляет текущие расширенные расположения при возникновении Office.EventType.EnhancedLocationsChanged события.

Представляет коллекцию объектов, обнаруженных в электронном сообщении или сведениях о встрече. Только в режиме чтения.

Объект Entities — это контейнер для массивов сущностей, возвращаемых методами getEntities и getEntitiesByType, если элемент (электронное сообщение или сведения о встрече) содержит одну или несколько сущностей, обнаруженных сервером. Эти сущности можно использовать в коде, чтобы предоставить дополнительные контекстные сведения (например, отобразить адрес на карте или открыть приложение для набора телефонного номера, обнаруженного в элементе).

Если в элементе нет сущностей типа, указанного в свойстве, это свойство возвращает значение null. Например, если сообщение содержит почтовый адрес и номер телефона, свойства addresses и phoneNumbers будут содержать данные, а остальные свойства вернут значение null.

Чтобы строка распознавалась как адрес, она должна содержать почтовый адрес в США с такими элементами, как номер дома, название улицы, город, штат и почтовый индекс.

Чтобы строка распознавалась как номер телефона, она должна содержать номер телефона в формате, принятом в Северной Америке.

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

Когда массивы свойств возвращаются методом getEntitiesByType , только свойство для указанной сущности содержит данные; все остальные свойства имеют значение NULL.

Предупреждение. Контекстные надстройки Outlook на основе сущностей теперь прекращены. Однако правила регулярных выражений по-прежнему поддерживаются. Мы рекомендуем обновить контекстную надстройку, чтобы использовать правила регулярных выражений в качестве альтернативного решения. Инструкции по реализации этих правил см. в разделе Контекстные надстройки Outlook.

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

Содержит основные сведения о сообщении уведомления, вызвавщее Office.EventType.InfobarClicked событие.

Предоставляет дополнительные сведения о сообщении уведомления, вызвавщее Office.EventType.InfobarClicked событие.

Объект InternetHeaders представляет пользовательские заголовки Интернета, которые сохраняются после того, как элемент сообщения покинет Exchange и преобразуется в сообщение MIME.

Заголовки Интернета хранятся в виде строковых пар "ключ—значение" для каждого элемента.

Примечание. Этот объект предназначен для установки и получения пользовательских заголовков в элементе сообщения. Дополнительные сведения см . в статье Получение и настройка заголовков в Интернете для сообщения в надстройке Outlook.

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

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

Полный список элементов см. на странице Объектная модель .

Если вы хотите видеть IntelliSense только для определенного типа или режима, приведите этот элемент к одному из следующих элементов:

• AppointmentCompose

• AppointmentRead

• MessageCompose

• MessageRead

Режим создания Office.context.mailbox.item.

Важно! Это внутренний объект Outlook, который не предоставляется напрямую через существующие интерфейсы. Этот режим следует рассматривать как режим Office.context.mailbox.item. Дополнительные сведения см. на странице Объектная модель .

Дочерние интерфейсы:

• AppointmentCompose

• MessageCompose

Режим чтения Office.context.mailbox.item.

Важно! Это внутренний объект Outlook, который не предоставляется напрямую через существующие интерфейсы. Этот режим следует рассматривать как режим Office.context.mailbox.item. Дополнительные сведения см. на странице Объектная модель .

Дочерние интерфейсы:

• AppointmentRead

• MessageRead

Представляет дату и время в локальном часовом поясе клиента. Только в режиме чтения.

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

Представляет расположение. Только для чтения.

Представляет идентификатор расположения.

Предоставляет доступ к объектной модели надстройки Microsoft Outlook.

Ключевые свойства:

• diagnostics : предоставляет диагностические сведения для надстройки Outlook.

• item : предоставляет методы и свойства для доступа к сообщению или встрече в надстройке Outlook.

• userProfile : предоставляет сведения о пользователе в надстройке Outlook.

Объект MailboxEvent передается в качестве аргумента обработчику событий надстройки, которая реализует активацию на основе событий, включая интеллектуальные оповещения или встроенную функцию создания отчетов о нежелательной почте. Это позволяет надстройке означать клиенту Outlook, что она завершила обработку события.

Представляет категории, master список в почтовом ящике.

В Outlook пользователь может помечать сообщения и встречи тегами, используя категорию для их цветового кода. Пользователь определяет категории в главном списке своего почтового ящика. Затем он может применить одну или несколько категорий к элементу.

Важно! В сценариях делегата или общего доступа делегат может получить категории в списке master, но не может добавлять или удалять категории.

Представляет найденное в элементе предложенное собрание. Только в режиме чтения.

Список собраний, предлагаемых в сообщении электронной почты, возвращается в meetingSuggestions свойстве Entities объекта, возвращаемого при вызове getEntities метода или getEntitiesByType для активного элемента.

Начальные и конечные значения — это строковые Date представления объекта, содержащего дату и время начала и окончания предложенного собрания. Значения приводятся для часового пояса по умолчанию, указанного для текущего пользователя.

Предупреждение. Контекстные надстройки Outlook на основе сущностей теперь прекращены. Однако правила регулярных выражений по-прежнему поддерживаются. Мы рекомендуем обновить контекстную надстройку, чтобы использовать правила регулярных выражений в качестве альтернативного решения. Инструкции по реализации этих правил см. в разделе Контекстные надстройки Outlook.

Подкласс Элемента для сообщений.

Важно! Это внутренний объект Outlook, который не предоставляется напрямую через существующие интерфейсы. Этот режим следует рассматривать как режим Office.context.mailbox.item. Дополнительные сведения см. на странице Объектная модель .

Дочерние интерфейсы:

• MessageCompose

• MessageRead

Режим создания сообщения Office.context.mailbox.item.

Важно!

• Это внутренний объект Outlook, который не предоставляется напрямую через существующие интерфейсы. Этот режим следует рассматривать как режим Office.context.mailbox.item. Дополнительные сведения см. на странице Объектная модель .

• При вызове Office.context.mailbox.item сообщения обратите внимание, что область чтения в клиенте Outlook должна быть включена. Инструкции по настройке области чтения см. в статье Использование и настройка области чтения для предварительного просмотра сообщений.

Родительские интерфейсы:

• ItemCompose

• Сообщение

Режим чтения сообщений Office.context.mailbox.item.

Важно!

• Это внутренний объект Outlook, который не предоставляется напрямую через существующие интерфейсы. Этот режим следует рассматривать как режим Office.context.mailbox.item. Дополнительные сведения см. на странице Объектная модель .

• При вызове Office.context.mailbox.item сообщения обратите внимание, что область чтения в клиенте Outlook должна быть включена. Инструкции по настройке области чтения см. в статье Использование и настройка области чтения для предварительного просмотра сообщений.

Родительские интерфейсы:

• ItemRead

• Сообщение

Определение действия для сообщения уведомления.

Массив объектов NotificationMessageDetails, возвращаемых методом NotificationMessages.getAllAsync.

Объект NotificationMessages возвращается в качестве свойства notificationMessages элемента.

Предоставляет обновленную тему Office, которая вызвала Office.EventType.OfficeThemeChanged событие.

Представляет организатора встречи, даже если для создания встречи использовался псевдоним или делегат. Этот объект предоставляет метод для получения значения организатора встречи в надстройке Outlook.

Представляет номер телефона, обнаруженный в элементе. Только в режиме чтения.

Массив объектов, PhoneNumber содержащий номера телефонов, найденные в сообщении электронной почты, возвращается в phoneNumbers свойстве Entities объекта, возвращаемого при вызове getEntities метода для выбранного элемента.

Предупреждение. Контекстные надстройки Outlook на основе сущностей теперь прекращены. Однако правила регулярных выражений по-прежнему поддерживаются. Мы рекомендуем обновить контекстную надстройку, чтобы использовать правила регулярных выражений в качестве альтернативного решения. Инструкции по реализации этих правил см. в разделе Контекстные надстройки Outlook.

Представляет получателей элемента. Только в режиме создания.

Предоставляет изменение состояния полей получателей при возникновении Office.EventType.RecipientsChanged события.

RecipientsChangedEventArgs.changedRecipientFields Представляет объект .

Объект Recurrence предоставляет методы для получения и задания шаблона повторения встреч, но получает только шаблон повторения запросов на собрания. Он будет иметь словарь со следующими ключами: seriesTime, recurrenceType, recurrencePropertiesи recurrenceTimeZone (необязательно).

Предоставляет обновленный объект повторения, который вызвал Office.EventType.RecurrenceChanged событие.

Представляет свойства повторения.

Представляет часовой пояс повторения.

Вложение файла или элемента. Используется при отображении формы ответа.

Объект ReplyFormData, содержащий данные текста или вложения и функцию обратного вызова. Используется при отображении формы ответа.

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

Хотя API надстройки Outlook ограничивает доступ к этим параметрам только надстройке, которая их создала, эти параметры не должны считаться безопасным хранилищем. К ним можно получить доступ с помощью веб-служб Exchange или расширенного MAPI. Они не должны использоваться для хранения конфиденциальной информации, такой как учетные данные пользователя или маркеры безопасности.

Имя параметра — это String, а значение может быть String, Number, Boolean, null, Object или Array.

К объекту RoamingSettings можно получить доступ с помощью свойства roamingSettings в пространстве имен Office.context.

Дополнительные сведения см RoamingSettings. в статье Получение и настройка метаданных надстройки для надстройки Outlook.

Представляет свойства сообщения, выбранного в настоящее время в Outlook.

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

Предоставляет методы для получения или задания метки конфиденциальности сообщения или встречи. Дополнительные сведения о метках конфиденциальности см. в статье Сведения о метках конфиденциальности.

Предоставляет состояние изменения метки конфиденциальности, примененной к сообщению или встрече в режиме создания. Эти сведения предоставляются при возникновении Office.EventType.SensitivityLabelChanged события.

Представляет свойства доступных меток конфиденциальности в Outlook.

Предоставляет методы для проверка состояния каталога меток конфиденциальности в Outlook и получения всех доступных меток конфиденциальности, если каталог включен.

Объект SeriesTime предоставляет методы для получения и задания дат и времени встреч в повторяющихся рядах, а также получения дат и времени запросов на собрания в повторяющихся рядах.

Предоставляет методы для управления данными сеанса элемента.

Важно! Весь объект SessionData ограничен 50 000 символами на надстройку.

Представляет свойства встречи или сообщения в общей папке или общем почтовом ящике.

Дополнительные сведения об использовании этого объекта см. в статье Включение общих папок и сценариев общих почтовых ящиков в надстройке Outlook.

Указывает поведение надстройки Smart Alerts по завершении обработки OnMessageSend события или OnAppointmentSend .

Предоставляет сведения о событии Office.EventType.SpamReporting , которое возникает при сообщении о нежелательном сообщении.

Указывает поведение интегрированной надстройки со сведениями о спаме после завершения обработки события SpamReporting .

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

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

Список задач, предлагаемых в сообщении электронной почты, возвращается в taskSuggestions свойстве объекта Entities , возвращаемого при вызове getEntities метода или getEntitiesByType для активного элемента.

Предупреждение. Контекстные надстройки Outlook на основе сущностей теперь прекращены. Однако правила регулярных выражений по-прежнему поддерживаются. Мы рекомендуем обновить контекстную надстройку, чтобы использовать правила регулярных выражений в качестве альтернативного решения. Инструкции по реализации этих правил см. в разделе Контекстные надстройки Outlook.

Объект Time возвращается в качестве свойства start или end встречи в режиме создания.

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

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

Указывает уровень конфиденциальности встречи.

Задает форматирование, применяемое к содержимому вложения.

Указывает, было ли вложение добавлено в элемент или удалено из него.

Указывает тип вложения.

Задает цвет категории.

Указывает тип создания сообщения.

Указывает день недели или тип дня.

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

Указывает тип сущности.

Предупреждение. Контекстные надстройки Outlook на основе сущностей теперь прекращены. Однако правила регулярных выражений по-прежнему поддерживаются. Мы рекомендуем обновить контекстную надстройку, чтобы использовать правила регулярных выражений в качестве альтернативного решения. Инструкции по реализации этих правил см. в разделе Контекстные надстройки Outlook.

Типы действий, поддерживаемые Office.EventType.InfobarClicked.

Тип уведомления, разрешенный Office.EventType.InfobarClicked.

Указывает тип сообщения уведомления для встречи или сообщения.

Указывает тип элемента.

Указывает тип расположения встречи.

Указывает месяц.

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

Дополнительные сведения о встроенной функции создания отчетов о нежелательной почте см. в статье Реализация интегрированной надстройки для создания отчетов о нежелательной почте.

Представляет текущее представление Outlook в Интернете.

Указывает тип получателя сообщения или встречи.

Указывает часовой пояс, применяемый к повтору.

Указывает тип повторения.

Указывает тип ответа на приглашение на собрание.

Указывает версию REST API, которая соответствует идентификатору элемента в формате REST.

Указывает параметр режима отправки , который переопределяет параметр, заданный в манифесте во время выполнения.

Сведения о том, как реализовать надстройку Smart Alerts, см. в разделе Обработка событий OnMessageSend и OnAppointmentSend в надстройке Outlook с помощью смарт-оповещений.

Указывает источник выбранных данных в элементе (см Office.mailbox.item.getSelectedDataAsync . дополнительные сведения).

Указывает неделю месяца.