outlook package

接口

Office.AccessControls

表示访问控制,用于指定是否可以复制粘贴、打印或保存消息的解密内容。

Office.Appointment

处理约会的 项目 的子类。

重要提示:这是一个内部 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 中,用户可以使用类别对邮件和约会进行颜色编码来标记邮件和约会。 用户在其邮箱的 主列表中定义类别 。 然后,他们可以将一个或多个类别应用于项目。

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

Office.CategoryDetails

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

Office.CoercionTypeOptions

提供数据格式的选项。

Office.Contact

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

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

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

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

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

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

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

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

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

Office.Ews

提供用于确定组织是否支持 Exchange Web 服务 (EWS) 回调令牌的方法。

Office.From

提供获取 Outlook 加载项中邮件的发件人值的方法。

Office.InfobarClickedEventArgs

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

Office.InfobarDetails

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

Office.InitializationContextChangedEventArgs

在事件发生时Office.EventType.InitializationContextChanged,提供来自可操作消息InsightMessage 通知、智能警报对话框或集成垃圾邮件报告对话框的数据。

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模式。 有关详细信息,请参阅 Outlook 项目对象模型

子接口:

Office.ItemRead

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

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

子接口:

Office.LoadedMessageCompose

表示当前正在加载的撰写模式下的消息。 在撰写模式下对消息调用时Office.context.mailbox.loadItemByIdAsync返回一个LoadedMessageCompose对象。

Office.LoadedMessageRead

表示当前正在加载的读取模式下的消息。 在读取模式下对消息调用时Office.context.mailbox.loadItemByIdAsync返回一个LoadedMessageRead对象。

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

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

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

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

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

Office.Message

用于消息的 项目 的子类。

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

子接口:

Office.MessageCompose

Office.context.mailbox.item 的邮件撰写模式。

重要说明

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

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

父接口:

Office.MessageDecryptEventCompletedOptions

指定 加密加载项 在处理完 OnMessageDecrypt 事件后的行为。

Office.MessageForm

表示用于撰写新邮件的表单的详细信息。

Office.MessageFormAttachment

文件或 Outlook 项附件。 显示新消息窗体时使用。

Office.MessageRead

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

重要说明

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

  • 调用 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,将在对象的Entities属性中phoneNumbers返回包含电子邮件中找到的电话号码的对象数组PhoneNumber返回。

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

Office.Recipients

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

Office.RecipientsChangedEventArgs

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

Office.RecipientsChangedFields

表示 RecipientsChangedEventArgs.changedRecipientFields 对象。

Office.Recurrence

Recurrence 对象提供获取和设置约会重复周期模式的方法,但仅获取会议请求的重复周期模式。 它将具有一个字典,其中包含以下键seriesTime:、recurrenceTyperecurrencePropertiesrecurrenceTimeZone可选) (。

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

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

会话数据特定于单个邮件项目。 即使相同的加载项用于设置或检索数据,它也不在多个项之间共享。

Office.SharedProperties

表示共享文件夹或共享邮箱中约会或邮件的属性。

有关如何使用此对象的详细信息,请参阅在 Outlook 加载项中启用共享文件夹和共享邮箱方案

Office.SmartAlertsEventCompletedOptions

指定智能警报加载项在处理 OR OnAppointmentSend 事件时的OnMessageSend行为。

Office.SpamReportingEventArgs

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

Office.SpamReportingEventCompletedOptions

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

Office.Subject

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

Office.TaskSuggestion

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

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

警告:基于实体的上下文 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 格式的项目 ID 的 REST API 的版本。

Office.MailboxEnums.SaveLocation

指定加载项要保存数据的位置。

Office.MailboxEnums.SendModeOverride

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

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

Office.MailboxEnums.SourceProperty

指定项中所选数据的源 (Office.mailbox.item.getSelectedDataAsync 了解详细信息) 。

Office.MailboxEnums.TokenStatus

指定组织中 Exchange Web 服务 (EWS) 回调令牌或 REST API 令牌的状态。

Office.MailboxEnums.WeekNumber

指定月份中的星期。