outlook package

Интерфейсы

Office.Appointment

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

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

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

Office.AppointmentCompose

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

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

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

Office.AppointmentForm

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

Office.AppointmentRead

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

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

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

Office.AppointmentTimeChangedEventArgs

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

Office.AttachmentContent

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

Office.AttachmentDetails

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

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

Office.AttachmentDetailsCompose

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

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

Office.AttachmentsChangedEventArgs

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

Office.Body

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

Office.Categories

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

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

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

Office.CategoryDetails

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

Office.CoercionTypeOptions

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

Office.Contact

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

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

Office.CustomProperties

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

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

Office.DelayDeliveryTime

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

Office.Diagnostics

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

Office.Display

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

Office.DisplayedBody

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

Office.DisplayedSubject

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

Office.EmailAddressDetails

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

Office.EmailUser

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

EmailUser объекты в основном получаются в сущностях MeetingSuggestion и TaskSuggestion , извлеченных из элемента Outlook. Дополнительные сведения об этом сценарии см. в статье Извлечение строк сущностей из элемента Outlook.

Office.EnhancedLocation

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

Office.EnhancedLocationsChangedEventArgs

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

Office.Entities

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

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

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

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

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

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

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

Office.From

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

Office.InfobarClickedEventArgs

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

Office.InfobarDetails

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

Office.InternetHeaders

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

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

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

Office.IsAllDayEvent

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

Office.Item

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

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

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

Office.ItemCompose

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

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

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

Office.ItemRead

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

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

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

Office.LocalClientTime

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

Office.Location

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

Office.LocationDetails

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

Office.LocationIdentifier

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

Office.Mailbox

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

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

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

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

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

Office.MailboxEvent

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

Office.MasterCategories

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

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

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

Office.MeetingSuggestion

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

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

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

Office.Message

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

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

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

Office.MessageCompose

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

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

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

Office.MessageRead

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

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

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

Office.NotificationMessageAction

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

Office.NotificationMessageDetails

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

Office.NotificationMessages

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

Office.OfficeThemeChangedEventArgs

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

Office.Organizer

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

Office.PhoneNumber

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

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

Office.Recipients

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

Office.RecipientsChangedEventArgs

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

Office.RecipientsChangedFields

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

Office.Recurrence

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

Office.RecurrenceChangedEventArgs

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

Office.RecurrenceProperties

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

Office.RecurrenceTimeZone

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

Office.ReplyFormAttachment

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

Office.ReplyFormData

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

Office.RoamingSettings

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

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

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

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

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

Office.SelectedItemDetails

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

Office.Sensitivity

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

Office.SensitivityLabel

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

Office.SensitivityLabelChangedEventArgs

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

Office.SensitivityLabelDetails

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

Office.SensitivityLabelsCatalog

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

Office.SeriesTime

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

Office.SessionData

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

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

Office.SharedProperties

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

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

Office.SmartAlertsEventCompletedOptions

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

Office.SpamReportingEventArgs

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

Office.SpamReportingEventCompletedOptions

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

Office.Subject

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

Office.TaskSuggestion

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

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

Office.Time

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

Office.UserProfile

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

Перечисления

Office.MailboxEnums.ActionType

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

Office.MailboxEnums.AppointmentSensitivityType

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

Office.MailboxEnums.AttachmentContentFormat

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

Office.MailboxEnums.AttachmentStatus

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

Office.MailboxEnums.AttachmentType

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

Office.MailboxEnums.CategoryColor

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

Office.MailboxEnums.ComposeType

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

Office.MailboxEnums.Days

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

Office.MailboxEnums.DelegatePermissions

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

Office.MailboxEnums.EntityType

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

Office.MailboxEnums.InfobarActionType

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

Office.MailboxEnums.InfobarType

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

Office.MailboxEnums.ItemNotificationMessageType

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

Office.MailboxEnums.ItemType

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

Office.MailboxEnums.LocationType

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

Office.MailboxEnums.Month

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

Office.MailboxEnums.MoveSpamItemTo

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

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

Office.MailboxEnums.OWAView

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

Office.MailboxEnums.RecipientType

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

Office.MailboxEnums.RecurrenceTimeZone

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

Office.MailboxEnums.RecurrenceType

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

Office.MailboxEnums.ResponseType

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

Office.MailboxEnums.RestVersion

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

Office.MailboxEnums.SendModeOverride

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

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

Office.MailboxEnums.SourceProperty

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

Office.MailboxEnums.WeekNumber

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