outlook package

Интерфейсы

Office.AccessControls

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

Office.Appointment

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

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

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

Office.AppointmentCompose

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

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

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

Office.AppointmentForm

Представляет сведения о форме для создания встречи.

Office.AppointmentRead

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

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

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

Office.AppointmentTimeChangedEventArgs

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

Office.AttachmentContent

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

Office.AttachmentDetails

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

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

Office.AttachmentDetailsCompose

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

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

Office.AttachmentsChangedEventArgs

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

Office.Body

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

Office.Categories

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

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

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

Office.CategoryDetails

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

Office.CoercionTypeOptions

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

Office.Contact

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

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

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

Office.CustomProperties

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

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

Office.DecryptedMessageAttachment

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

Office.DecryptedMessageBody

Представляет текст расшифрованного сообщения.

Office.DelayDeliveryTime

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

Office.Diagnostics

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

Office.Display

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

Office.DisplayedBody

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

Office.DisplayedSubject

Обеспечивает метод, позволяющий временно перевести содержимое, отображаемое в теме сообщения, в режим чтения.

Office.DragAndDropEventArgs

Предоставляет сведения о положении указателя мыши и о сообщениях или вложенных файлах, перетаскиваемых в область задач надстройки при возникновении Office.EventType.DragAndDropEvent события.

Office.DragoverEventData

Представляет DragAndDropEventArgs.dragAndDropEventData объект, когда сообщения или вложенные файлы перетаскиваются через область задач надстройки.

Office.DropEventData

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

Office.DroppedItemDetails

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

Office.DroppedItems

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

Office.EmailAddressDetails

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

Office.EmailUser

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

Office.EnhancedLocation

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

Office.EnhancedLocationsChangedEventArgs

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

Office.Entities

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

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

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

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

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

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

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

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

Office.Ews

Предоставляет методы для определения того, поддерживаются ли маркеры обратного вызова веб-служб Exchange (EWS) в организации.

Office.From

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

Office.InfobarClickedEventArgs

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

Office.InfobarDetails

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

Office.InitializationContextChangedEventArgs

Предоставляет данные из сообщения с действиями, уведомленияInsightMessage , диалогового окна интеллектуальных оповещений или встроенного диалогового окна сообщений о нежелательной почте при возникновении Office.EventType.InitializationContextChanged события.

Office.InternetHeaders

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

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

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

Office.IsAllDayEvent

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

Office.Item

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

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

Office.ItemCompose

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

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

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

Office.ItemRead

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

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

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

Office.LoadedMessageCompose

Представляет сообщение в режиме создания, которое загружено в данный момент. Объект LoadedMessageCompose возвращается при Office.context.mailbox.loadItemByIdAsync вызове сообщения в режиме создания.

Office.LoadedMessageRead

Представляет сообщение в режиме чтения, которое загружено в данный момент. Объект LoadedMessageRead возвращается при Office.context.mailbox.loadItemByIdAsync вызове сообщения в режиме чтения.

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 и конечное значения являются строковыми представлениями объекта, содержащего дату и время начала и окончания предлагаемого собрания. Значения приводятся для часового пояса по умолчанию, указанного для текущего пользователя.

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

Office.Message

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

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

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

Office.MessageCompose

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

Важно!

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

Office.MessageDecryptEventCompletedOptions

Определяет поведение надстройки шифрования после завершения обработки события OnMessageDecrypt .

Office.MessageForm

Представляет сведения о форме для создания сообщения.

Office.MessageFormAttachment

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

Office.MessageRead

Режим чтения сообщения 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 метода для выбранного элемента.

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

Office.Recipients

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

Office.RecipientsChangedEventArgs

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

Office.RecipientsChangedFields

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

Office.Recurrence

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

Office.RecurrenceChangedEventArgs

Предоставляет обновленный объект recurren, вызвавший 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

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

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

Office.SharedProperties

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

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

Office.SmartAlertsEventCompletedOptions

Определяет поведение надстройки "Интеллектуальные оповещения" после завершения обработки OnMessageSend события или OnAppointmentSend события.

Office.SpamReportingEventArgs

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

Office.SpamReportingEventCompletedOptions

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

Office.Subject

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

Office.TaskSuggestion

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

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

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

Office.Time

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

Office.UserProfile

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

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

Office.MailboxEnums.ActionType

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

Office.MailboxEnums.AppointmentSensitivityType

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

Office.MailboxEnums.AttachmentContentFormat

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

Office.MailboxEnums.AttachmentStatus

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

Office.MailboxEnums.AttachmentType

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

Office.MailboxEnums.BodyMode

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

Office.MailboxEnums.CategoryColor

Цвет категории.

Office.MailboxEnums.ComposeType

Определяет тип создания сообщения.

Office.MailboxEnums.Days

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

Office.MailboxEnums.DelegatePermissions

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

Office.MailboxEnums.EntityType

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

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

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.OpenLocation

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

Office.MailboxEnums.OWAView

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

Office.MailboxEnums.RecipientType

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

Office.MailboxEnums.RecurrenceTimeZone

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

Office.MailboxEnums.RecurrenceType

Определяет тип повторения.

Office.MailboxEnums.ResponseType

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

Office.MailboxEnums.RestVersion

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

Office.MailboxEnums.SaveLocation

Указывает, в каком месте надстройка сохраняет данные.

Office.MailboxEnums.SendModeOverride

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

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

Office.MailboxEnums.SourceProperty

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

Office.MailboxEnums.TokenStatus

Указывает состояние маркеров обратного вызова веб-служб Exchange (EWS) или маркеров REST API в организации.

Office.MailboxEnums.WeekNumber

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