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 событие.

[Набор API: почтовый ящик 1.7]

Office.AttachmentContent

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

[Набор API: почтовый ящик 1.8]

Office.AttachmentDetails

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

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

[Набор API: почтовый ящик 1.1]

Office.AttachmentDetailsCompose

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

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

[Набор API: почтовый ящик 1.8]

Office.AttachmentsChangedEventArgs

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

[Набор API: почтовый ящик 1.8]

Office.Body

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

Office.Categories

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

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

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

[Набор API: почтовый ящик 1.8]

Office.CategoryDetails

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

[Набор API: почтовый ящик 1.8]

Office.CoercionTypeOptions

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

Office.Contact

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

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

Office.CustomProperties

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

Поскольку Outlook Mac не кэшет настраиваемые свойства, если сеть пользователя выходит из него, почтовые надстройки не могут получить доступ к своим настраиваемой свойствам.

Office.Diagnostics

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

Office.EmailAddressDetails

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

Office.EmailUser

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

Office.EnhancedLocation

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

Office.EnhancedLocationsChangedEventArgs

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

[Набор API: почтовый ящик 1.8]

Office.Entities

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

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

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

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

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

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

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

Office.From

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

[Набор API: почтовый ящик 1.7]

Office.InfobarClickedEventArgs

Основные сведения об уведомлении, которое подняло Office.EventType.InfobarClicked событие.

Office. InfobarDetails

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

[Набор API: почтовый ящик 1.10]

Office.InternetHeaders

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

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

Примечание. Этот объект предназначен для настройки и получения настраиваемой загонки элемента сообщения. Дополнительные дополнительные сообщения см. в статью Get and set internet headers on a message in an Outlook add-in.

[Набор API: почтовый ящик 1.8]

Office.IsAllDayEvent

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

[Набор API: предварительный просмотр почтовых ящиков]

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.

[Набор API: почтовый ящик 1.1]

Office. LocationDetails

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

[Набор API: почтовый ящик 1.8]

Office.LocationIdentifier

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

[Набор API: почтовый ящик 1.8]

Office.Mailbox

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

Свойства ключей:

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

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

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

Office.MasterCategories

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

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

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

[Набор API: почтовый ящик 1.8]

Office.MeetingSuggestion

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

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

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

Office.Message

Подкласс Item for messages.

Важно: это внутренний объект 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

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

Важно: в Outlook веб-сайте объект доступен только в NotificationMessageAction режиме Compose.

[Набор API: почтовый ящик 1.10]

Office.NotificationMessageDetails

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

Office.NotificationMessages

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

[Набор API: почтовый ящик 1.3]

Office.OfficeThemeChangedEventArgs

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

[Набор API: предварительный просмотр почтовых ящиков]

Office.Organizer

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

[Набор API: почтовый ящик 1.7]

Office.PhoneNumber

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

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

Office.Recipients

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

[Набор API: почтовый ящик 1.1]

Office.RecipientsChangedEventArgs

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

[Набор API: почтовый ящик 1.7]

Office.RecipientsChangedFields

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

[Набор API: почтовый ящик 1.7]

Office.Recurrence

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

[Набор API: почтовый ящик 1.7]

Office.RecurrenceChangedEventArgs

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

[Набор API: почтовый ящик 1.7]

Office.RecurrenceProperties

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

[Набор API: почтовый ящик 1.7]

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 на Windows или Mac эти параметры отражаются в Outlook в Интернете только после обновления браузера.

Office.Sensitivity

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

[Набор API: предварительный просмотр почтовых ящиков]

Office.SeriesTime

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

[Набор API: почтовый ящик 1.7]

Office.SessionData

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

[Набор API: предварительный просмотр почтовых ящиков]

Office.SharedProperties

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

Дополнительные сведения об этом объекте см. в статье Общие папки и общие почтовые ящики.

[Набор API: почтовый ящик 1.8]

Office.Subject

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

[Набор API: почтовый ящик 1.1]

Office.TaskSuggestion

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

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

Office.Time

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

[Набор API: почтовый ящик 1.1]

Office.UserProfile

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

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

Office.MailboxEnums.ActionType

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

Office.MailboxEnums.AppointmentSensitivityType

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

Office.MailboxEnums.AttachmentContentFormat

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

[Набор API: почтовый ящик 1.8]

Office.MailboxEnums.AttachmentStatus

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

Office.MailboxEnums.AttachmentType

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

Office.MailboxEnums.CategoryColor

Указывает цвет категории.

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

[Набор API: почтовый ящик 1.8]

Office.MailboxEnums.ComposeType

Тип compose.

[Набор API: почтовый ящик 1.10]

Office.MailboxEnums.Days

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

Office.MailboxEnums.DelegatePermissions

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

[Набор API: почтовый ящик 1.8]

Office.MailboxEnums.EntityType

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

Office.MailboxEnums.InfobarActionType

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

[Набор API: почтовый ящик 1.10]

Office.MailboxEnums.InfobarType

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

[Набор API: почтовый ящик 1.10]

Office.MailboxEnums.ItemNotificationMessageType

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

[Набор API: почтовый ящик 1.3]

Office.MailboxEnums.ItemType

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

Office.MailboxEnums.LocationType

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

[Набор API: почтовый ящик 1.8]

Office.MailboxEnums.Month

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

[Набор API: почтовый ящик 1.7]

Office.MailboxEnums.OWAView

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

Office.MailboxEnums.RecipientType

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

[Набор API: почтовый ящик 1.1]

Office.MailboxEnums.RecurrenceTimeZone

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

[Набор API: почтовый ящик 1.7]

Office.MailboxEnums.RecurrenceType

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

[Набор API: почтовый ящик 1.7]

Office.MailboxEnums.ResponseType

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

Office.MailboxEnums.RestVersion

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

[Набор API: почтовый ящик 1.3]

Office.MailboxEnums.SourceProperty

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

[Набор API: почтовый ящик 1.2]

Office.MailboxEnums.WeekNumber

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

[Набор API: почтовый ящик 1.7]