Поделиться через


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

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

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

Office.Body

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

Office.CoercionTypeOptions

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

Office.Contact

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

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

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

Office.CustomProperties

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

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

Office.Diagnostics

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

Office.EmailAddressDetails

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

Office.EmailUser

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

Office.Entities

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

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

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

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

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

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

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

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

Office.From

Предоставляет метод для получения значения из сообщения в надстройке 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.Mailbox

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

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

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

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

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

Office.MeetingSuggestion

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

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

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

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

Office.Message

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

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

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

Office.MessageCompose

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

Важно!

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

Office.MessageRead

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

Важно!

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

Office.NotificationMessageDetails

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

Office.NotificationMessages

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

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, 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.SeriesTime

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

Office.Subject

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

Office.TaskSuggestion

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

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

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

Office.Time

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

Office.UserProfile

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

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

Office.MailboxEnums.AttachmentType

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

Office.MailboxEnums.Days

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

Office.MailboxEnums.EntityType

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

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

Office.MailboxEnums.ItemNotificationMessageType

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

Office.MailboxEnums.ItemType

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

Office.MailboxEnums.Month

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

Office.MailboxEnums.OWAView

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

Office.MailboxEnums.RecipientType

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

Office.MailboxEnums.RecurrenceTimeZone

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

Office.MailboxEnums.RecurrenceType

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

Office.MailboxEnums.ResponseType

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

Office.MailboxEnums.RestVersion

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

Office.MailboxEnums.SourceProperty

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

Office.MailboxEnums.WeekNumber

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