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

表示项目上的附件。 仅限撰写模式。

对象数组 AttachmentDetailsComposegetAttachmentsAsync 方法返回。

Office.AttachmentsChangedEventArgs

提供有关引发 Office.EventType.AttachmentsChanged 事件的邮件项目附件的信息。

Office.Body

body 对象提供用于添加和更新邮件或约会内容的方法。 它将在所选项目的 body 属性中返回。

Office.Categories

表示项的类别。

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

重要提示:在 Outlook 网页版 和新的 Outlook on Windows 中,不能使用 API 来管理在Compose模式下应用于邮件的类别。

Office.CategoryDetails

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

Office.CoercionTypeOptions

提供数据格式的选项。

Office.Contact

表示有关联系人 (的详细信息,类似于从项目正文中提取的物理联系人或业务卡) 。 仅限阅读模式。

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

警告:基于实体的上下文 Outlook 加载项现已停用。 但是,仍支持正则表达式规则。 建议更新上下文加载项,以使用正则表达式规则作为替代解决方案。 有关如何实现这些规则的指南,请参阅 上下文 Outlook 加载项

Office.CustomProperties

对象 CustomProperties 表示特定于特定邮件项目和特定于 Outlook 加载项的自定义属性。 例如,加载项可能需要保存一些特定于激活加载项的当前消息的数据。 如果用户将来重新访问同一消息并再次激活加载项,则外接程序将能够检索已保存为自定义属性的数据。

若要详细了解 CustomProperties,请参阅 获取和设置 Outlook 外接程序的外接程序元数据。

Office.DelayDeliveryTime

通过 DelayDeliveryTime 对象,可以管理邮件的延迟传递日期和时间。

Office.Diagnostics

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

Office.Display

提供属性,用于临时设置在阅读模式下邮件正文或主题中显示的内容。

Office.DisplayedBody

提供一种方法,用于暂时设置在阅读模式下在邮件正文中显示的内容。

Office.DisplayedSubject

提供一种暂时设置在阅读模式下邮件主题中显示的内容的方法。

Office.EmailAddressDetails

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

Office.EmailUser

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

Office.EnhancedLocation

表示约会上的位置集。

Office.EnhancedLocationsChangedEventArgs

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

Office.Entities

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

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

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

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

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

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

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

警告:基于实体的上下文 Outlook 加载项现已停用。 但是,仍支持正则表达式规则。 建议更新上下文加载项,以使用正则表达式规则作为替代解决方案。 有关如何实现这些规则的指南,请参阅 上下文 Outlook 加载项

Office.From

提供一种从 Outlook 外接程序中邮件的值获取 的方法。

Office.InfobarClickedEventArgs

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

Office.InfobarDetails

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

Office.InternetHeaders

对象 InternetHeaders 表示在邮件项离开 Exchange 并转换为 MIME 邮件后保留的自定义 Internet 标头。

Internet 标头按项存储为字符串键值对。

注意:此对象用于设置和获取邮件项上的自定义标头。 若要了解详细信息,请参阅在 Outlook 外接程序中获取和设置邮件的 Internet 标头

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

对象 MailboxEvent 作为参数传递给实现 基于事件的激活的外接程序的事件处理程序,包括 智能警报集成的垃圾邮件报告功能。 它允许加载项向 Outlook 客户端表示它已完成事件处理。

Office.MasterCategories

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

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

重要说明:在委托或共享方案中,委托可以获取主列表中的类别,但不能添加或删除类别。

Office.MeetingSuggestion

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

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

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

警告:基于实体的上下文 Outlook 加载项现已停用。 但是,仍支持正则表达式规则。 建议更新上下文加载项,以使用正则表达式规则作为替代解决方案。 有关如何实现这些规则的指南,请参阅 上下文 Outlook 加载项

Office.Message

消息的 Item 的子类。

重要说明:这是一个内部 Outlook 对象,不会通过现有接口直接公开。 应将其视为 的 Office.context.mailbox.item模式。 有关详细信息,请参阅 “对象模型 ”页。

子接口:

Office.MessageCompose

邮件撰写模式 为 Office.context.mailbox.item

重要说明

  • 这是一个内部 Outlook 对象,不直接通过现有接口公开。 应将其视为 的 Office.context.mailbox.item模式。 有关详细信息,请参阅 “对象模型 ”页。

  • 在邮件上调用 Office.context.mailbox.item 时,请注意,必须打开 Outlook 客户端中的阅读窗格。 有关如何配置阅读窗格的指南,请参阅 使用和配置阅读窗格预览邮件

父接口:

Office.MessageRead

Office.context.mailbox.item 的邮件读取模式。

重要说明

  • 这是一个内部 Outlook 对象,不直接通过现有接口公开。 应将其视为 的 Office.context.mailbox.item模式。 有关详细信息,请参阅 “对象模型 ”页。

  • 在邮件上调用 Office.context.mailbox.item 时,请注意,必须打开 Outlook 客户端中的阅读窗格。 有关如何配置阅读窗格的指南,请参阅 使用和配置阅读窗格预览邮件

父接口:

Office.NotificationMessageAction

通知消息的操作定义。

Office.NotificationMessageDetails

NotificationMessageDetails 对象的数组由 NotificationMessages.getAllAsync 方法返回。

Office.NotificationMessages

NotificationMessages 对象作为项目的 notificationMessages 属性返回。

Office.OfficeThemeChangedEventArgs

提供引发 Office.EventType.OfficeThemeChanged 事件的更新的 Office 主题。

Office.Organizer

表示约会组织者,即使使用别名或委托创建约会。 此对象提供一种方法来获取 Outlook 外接程序中约会的组织者值。

Office.PhoneNumber

表示项目中标识的电话号码。 仅限阅读模式。

在对所选项目调用 getEntities 方法时,将在对象的 属性EntitiesphoneNumbers返回包含电子邮件中找到的电话号码的对象数组PhoneNumber

警告:基于实体的上下文 Outlook 加载项现已停用。 但是,仍支持正则表达式规则。 建议更新上下文加载项,以使用正则表达式规则作为替代解决方案。 有关如何实现这些规则的指南,请参阅 上下文 Outlook 加载项

Office.Recipients

表示项目的收件人。 仅限撰写模式。

Office.RecipientsChangedEventArgs

在引发事件时提供收件人字段的 Office.EventType.RecipientsChanged 更改状态。

Office.RecipientsChangedFields

表示 RecipientsChangedEventArgs.changedRecipientFields 对象。

Office.Recurrence

对象 Recurrence 提供用于获取和设置约会的重复模式的方法,但仅获取会议请求的重复模式。 它将具有包含以下键的字典: seriesTimerecurrenceTyperecurrencePropertiesrecurrenceTimeZone (可选) 。

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,请参阅 获取和设置 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

指定 智能警报加载项 在完成处理 OnMessageSendOnAppointmentSend 事件时的行为。

Office.SpamReportingEventArgs

提供有关报告未经请求的消息时发生的事件的信息 Office.EventType.SpamReporting

Office.SpamReportingEventCompletedOptions

指定 集成垃圾邮件报告加载项 在完成处理 SpamReporting 事件后的行为。

Office.Subject

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

Office.TaskSuggestion

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

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

警告:基于实体的上下文 Outlook 加载项现已停用。 但是,仍支持正则表达式规则。 建议更新上下文加载项,以使用正则表达式规则作为替代解决方案。 有关如何实现这些规则的指南,请参阅 上下文 Outlook 加载项

Office.Time

对象 Time 在撰写模式下作为约会的开始或结束属性返回。

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

指定实体的类型。

警告:基于实体的上下文 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.OWAView

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

Office.MailboxEnums.RecipientType

指定邮件或约会的收件人类型。

Office.MailboxEnums.RecurrenceTimeZone

指定应用于定期的时区。

Office.MailboxEnums.RecurrenceType

指定重复周期的类型。

Office.MailboxEnums.ResponseType

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

Office.MailboxEnums.RestVersion

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

Office.MailboxEnums.SendModeOverride

指定在运行时替代清单中设置的选项的 发送模式选项

有关如何实现智能警报加载项的信息,请参阅使用智能警报处理 Outlook 外接程序中的 OnMessageSend 和 OnAppointmentSend 事件

Office.MailboxEnums.SourceProperty

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

Office.MailboxEnums.WeekNumber

指定当月的周。