outlook package

接口

Office.Appointment

处理约会 的 Item 的子类。

重要 提示:这是一个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 对象提供用于添加和更新邮件或约会内容的方法。 它在所选项目的 body 属性中返回。

Office.Categories

表示项目上的类别。

在Outlook中,用户可以使用类别标记邮件和约会,以对它们进行颜色编码。 用户在邮箱 的主列表中定义 类别。 然后,他们可以将一个或多个类别应用于项目。

重要 提示:Outlook 网页版,在撰写模式下,你无法通过 API 管理应用于邮件的类别。

Office.CategoryDetails

表示类别的详细信息,如名称和关联颜色。

Office.CoercionTypeOptions

提供数据格式的选项。

Office.Contact

表示有关联系人联系人 (类似于从项目正文提取的物理联系人) 名片上的详细信息。 仅限阅读模式。

从电子邮件或约会的正文中提取的联系人列表在当前项目的 或 方法返回 contacts 的 Entities 对象的 属性 getEntities getEntitiesByType 中返回。

Office.CustomProperties

CustomProperties 对象表示特定于某个特定项目和特定于 Outlook 的某个邮件外接程序的自定义属性。 例如,邮件外接程序可能有必要保存一些特定于激活外接程序的当前电子邮件的数据。 如果用户以后再次访问相同的邮件,并再次激活邮件外接程序,外接程序将能够检索作为自定义属性保存的数据。 重要 提示 CustomProperties :JSON 对象的最大长度为 2500 个字符。

由于Outlook Mac 上的邮件无法缓存自定义属性,因此如果用户的网络关闭,邮件外接程序将无法访问其自定义属性。

Office.DelayDeliveryTime

DelayDeliveryTime对象使您能够管理邮件的延迟送达日期和时间。

Office.Diagnostics

将诊断信息提供给 Outlook 外接程序。

Office.EmailAddressDetails

提供电子邮件或约会的发件人或指定收件人的电子邮件属性。

Office.EmailUser

表示 Exchange Server 上的电子邮件帐户。

EmailUser对象主要在从项目中提取的 MeetingSuggestionTaskSuggestion Outlook接收。 若要了解有关此方案的详细信息,请参阅从项目中提取Outlook字符串.

Office.EnhancedLocation

表示约会的位置集。

Office.EnhancedLocationsChangedEventArgs

引发事件时提供当前 Office.EventType.EnhancedLocationsChanged 增强的位置。

Office.Entities

表示电子邮件或约会中找到的实体集合。仅限阅读模式。

Entities 对象是项目(电子邮件或约会)包含一个或多个服务器找到的实体时由 getEntitiesgetEntitiesByType 方法返回的实体数组的容器。可以使用代码中的这些实体为查看器提供附加上下文信息,如对项目中找到的地址的映射或打开项目中找到的电话号码的拨号程序。

如果项中不存在属性中指定的类型的实体,则与该实体关联的属性为 null。 例如,如果邮件包含街道地址和电话号码,addresses 属性和 phoneNumbers 属性将包含信息,其他属性将为空。

若要被识别为地址,字符串必须包含至少具有街道编号、街道名称、城市、州和邮政编码等元素的子集的美国通讯地址。

若要被识别为电话号码,字符串必须包含北美电话号码格式。

实体识别有赖于基于计算机了解大量数据的自然语言识别。实体的识别是不确定的,其成功有时取决于项中的特定上下文。

当方法返回属性数组时,仅指定实体的属性包含数据;所有其他 getEntitiesByType 属性为 null。

Office.From

提供一种方法,用于从外接程序中的邮件Outlook值。

Office.InfobarClickedEventArgs

提供有关引发事件的通知邮件的基本 Office.EventType.InfobarClicked 详细信息。

Office.InfobarDetails

提供有关引发事件的通知邮件的其他 Office.EventType.InfobarClicked 详细信息。

Office.InternetHeaders

对象表示在邮件项目离开邮件后保留的自定义 internet InternetHeaders Exchange并转换为 MIME 邮件。 这些邮件头在 MIME 邮件中存储为 x 标头。

Internet 标头按项存储为键/值对。

注意:此对象用于设置和获取邮件项目的自定义邮件头。 若要了解更多信息,请参阅Get and set internet headers on a message in an Outlook add-in.

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

表示位置的 ID。

Office.Mailbox

提供对 Microsoft Outlook加载项对象模型的访问权限。

关键属性:

  • diagnostics:向加载项Outlook诊断信息。

  • item:提供用于访问外接程序中的邮件或约会的方法Outlook约会。

  • userProfile:提供有关加载项中Outlook的信息。

Office.MasterCategories

表示邮箱上的类别主列表。

在Outlook中,用户可以使用类别标记邮件和约会,以对它们进行颜色编码。 用户在其邮箱的主列表中定义类别。 然后,他们可以将一个或多个类别应用于项目。

重要 提示:在委派或共享方案中,代理可以获取主列表中的类别,但不能添加或删除类别。

Office.MeetingSuggestion

表示在项目中找到的建议会议。 仅限阅读模式。

电子邮件中建议的会议列表在活动项目上调用 或 方法时返回的对象的 属性 meetingSuggestions Entities getEntities getEntitiesByType 中返回。

起始值和结束值是包含建议会议开始和结束的日期和时间的对象的字符串 Date 表示形式。 这些值用为当前用户指定的默认时区表示。

Office.Message

邮件的 Item 的子类。

重要 提示:这是一个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

通知邮件的操作的定义。

重要 提示:在新式 NotificationMessageAction Outlook 网页版,对象仅在撰写模式下可用。

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 对象的方法创建的设置将按外接程序和按用户进行保存。 即,它们仅可用于创建这些加载项的外接程序,并且只能从保存它们的用户邮箱访问。

虽然 Outlook 外接程序 API 仅将这些设置的访问权限限制到创建这些设置的外接程序,但这些设置不应被视为安全存储。 可以通过 Exchange Web 服务或扩展 MAPI 访问这些设置。 它们不应用于存储敏感信息,如用户凭据或安全令牌。

设置的名称是一个字符串,而值可以是字符串、数字、布尔值、null 值、对象或数组。

可通过 RoamingSettings 命名空间中的 roamingSettings 属性访问 Office.context 对象。

重要提示

  • RoamingSettings仅在首次加载加载项时,对象才从保留的存储中初始化。 对于任务窗格,这意味着它仅在任务窗格首次打开时初始化。 如果任务窗格导航到另一个页面或重新加载当前页面,则内存中的对象将重置为初始值,即使您的外接程序已保留更改。 在关闭并重新打开无 UI 加载项的情况下 (或项目的情况下,保留的更改) 不可用。

  • 通过 Windows 或 Mac 上的 Outlook 设置和保存时,这些设置仅在浏览器刷新后反映在 Outlook 网页中。

Office.Sensitivity

提供在加载项中获取和设置会议约会Outlook的方法。

Office.SeriesTime

对象提供用于获取和设置定期系列中的约会日期和时间的方法,以及获取定期系列中会议请求 SeriesTime 的日期和时间的方法。

Office.SessionData

提供用于管理项目的会话数据的方法。

重要 提示:整个 SessionData 对象每个外接程序限制为 50,000 个字符。

Office.SharedProperties

表示共享文件夹或共享邮箱中约会或邮件的属性, (预览) 。

有关如何使用此对象的信息,请参阅共享 文件夹和共享邮箱 文章。

Office.Subject

提供用于获取和设置 Outlook 外接程序中的约会或邮件的主题的方法。

Office.TaskSuggestion

表示项目中标识的建议任务。 仅限阅读模式。

电子邮件中建议的任务列表在活动项目上调用 或 方法时返回 taskSuggestions 的 Entities 对象的 属性 getEntities getEntitiesByType 中返回。

Office.Time

在撰写模式下,对象作为约会的 start 或 Time end 属性返回。

Office.UserProfile

有关与邮箱关联的用户的信息。 这包括帐户类型、显示名称、电子邮件地址和时区。

枚举

Office.MailboxEnums.ActionType

指定通知邮件中自定义操作的类型。

Office.MailboxEnums.AppointmentSensitivityType

指定约会的敏感度类型。

Office.MailboxEnums.AttachmentContentFormat

指定适用于附件内容的格式。

Office.MailboxEnums.AttachmentStatus

指定附件是添加到项目还是从项中删除。

Office.MailboxEnums.AttachmentType

指定附件的类型。

Office.MailboxEnums.CategoryColor

指定类别颜色。

注意:实际颜色取决于Outlook呈现方式。 在这种情况下,每个预设上显示的颜色适用于Outlook客户端。

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

表示 Outlook 网页视图的当前视图。

Office.MailboxEnums.RecipientType

指定约会收件人的类型。

Office.MailboxEnums.RecurrenceTimeZone

指定应用于定期的时区。

Office.MailboxEnums.RecurrenceType

指定重复的类型。

Office.MailboxEnums.ResponseType

指定对会议邀请的响应类型。

Office.MailboxEnums.RestVersion

指定对应于 REST 格式的项目 ID 的 REST API 的版本。

Office.MailboxEnums.SourceProperty

指定项目项中选定数据源 (Office.mailbox.item.getSelectedDataAsync 有关详细信息,请参阅) 。

Office.MailboxEnums.WeekNumber

指定一个月的星期。