Office. Loaded Message Compose interface

最低权限级别： 读取项

适用的 Outlook 模式：邮件Compose

重要说明：

在 Outlook on Windows 中， inReplyTo 无论用户做出何种更改（例如更改答复中的主题）都会在所有答复中保留该值。
对于同样是会议组织者的用户转发的新邮件和会议邀请，属性 inReplyTo 将返回 null 。

internetHeaders

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

获取消息的自定义 Internet 标头。

若要了解详细信息，请参阅在 Outlook 外接程序中获取和设置邮件的 Internet 标头。

internetHeaders: InternetHeaders;

属性值

Office.InternetHeaders

注解

最低权限级别： 读取项

适用的 Outlook 模式：邮件Compose

重要说明：仅 getAsync 支持 InternetHeaders 对象的方法。

itemType

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

获取实例表示的项的类型。

属性 itemType 返回枚举值之 ItemType 一，指示项目对象实例是消息还是约会。

itemType: MailboxEnums.ItemType | string;

属性值

Office.MailboxEnums.ItemType | string

注解

最低权限级别： 读取项

适用的 Outlook 模式：邮件Compose

notificationMessages

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

获取项的通知消息。

notificationMessages: NotificationMessages;

属性值

Office.NotificationMessages

注解

[ API 集：邮箱 1.3 ]

最低权限级别： 读取项

适用的 Outlook 模式：邮件Compose

重要说明：

getAllAsync仅支持 NotificationMessages 对象的方法。

sensitivityLabel

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

获取消息的敏感度标签。

sensitivityLabel: SensitivityLabel;

属性值

Office.SensitivityLabel

注解

[ API set： Mailbox 1.13 ]

最低权限级别： 读/写项

适用的 Outlook 模式：邮件Compose

重要说明：

若要在外接程序中使用敏感度标签功能，必须具有Microsoft 365 E5订阅。
getAsync仅支持 SensitivityLabel 对象的方法。

若要详细了解如何在外接程序中管理敏感度标签，请参阅在撰写模式下管理邮件或约会的敏感度标签。

seriesId

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

获取实例所属的序列的 ID。

在 Outlook 网页版和 Windows (new 和 classic) 中，seriesId返回此项所属的父 (系列) 项的 Exchange Web Services (EWS) ID。

seriesId: string;

属性值

string

注解

[ API set： Mailbox 1.7 ]

最低权限级别： 读取项

适用的 Outlook 模式：邮件Compose

重要提示：属性返回的 seriesId 标识符与 Exchange Web Services 项标识符相同。属性 seriesId 与 Outlook REST API 使用的 Outlook ID 不同。在使用此值进行 REST API 调用之前，应使用 Office.context.mailbox.convertToRestId进行转换。有关详细信息，请参阅使用 Outlook 外接程序中的 Outlook REST API。

对于没有父项（如单个约会、系列项目或会议请求）的项目，属性seriesIdnull返回，对于不是会议请求的任何其他项目，则返回 undefined 。

subject

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

获取在项的主题字段中显示的说明。

属性 subject 获取电子邮件服务器发送的项的整个主题。

subject: Subject;

属性值

Office.Subject

注解

最低权限级别： 读取项

适用的 Outlook 模式：邮件Compose

重要提示：仅 getAsync 支持 Subject 对象的方法。

to

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

获取邮件的“ 收件人 ”行上的收件人。提供对邮件的“收件人”行上的收件人的访问权限。对象的类型和访问级别取决于当前项的模式。

to: Recipients;

属性值

Office.Recipients

注解

最低权限级别： 读取项

适用的 Outlook 模式：邮件Compose

重要说明：

getAsync仅支持 Recipients 对象的方法。
根据 Outlook 客户端和平台，可能会对可以获取的收件人数施加限制。有关详细信息，请参阅 Recipients 对象。

方法详细信息

getAttachmentContentAsync(attachmentId, options, callback)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

从邮件或约会中获取附件，并将其作为 AttachmentContent 对象返回。

方法 getAttachmentContentAsync 从项中获取具有指定标识符的附件。最佳做法是，应从通话中获取附件的标识符，然后在同一 getAttachmentsAsync 会话中使用该标识符检索附件。在 Outlook 网页版和新 Outlook on Windows 中，附件标识符仅在同一会话中有效。当用户关闭应用时，会话结束，或者如果用户开始撰写内联窗体，然后弹出窗体以在单独的窗口中继续。

getAttachmentContentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void): void;

参数

attachmentId: string

要获取的附件的标识符。

options: Office.AsyncContextOptions

包含以下一个或多个属性的对象文本：- asyncContext：开发人员可以在回调函数中提供他们想要访问的任何对象。

callback: (asyncResult: Office.AsyncResult<Office.AttachmentContent>) => void

可选。方法完成后，使用单个参数 asyncResult（即 Office.AsyncResult 对象）调用在参数中callback传递的函数。如果调用失败，属性 asyncResult.error 将包含错误代码，其中包含失败的原因。

void

注解

最低权限级别： 读取项

适用的 Outlook 模式：邮件Compose

错误：

AttachmentTypeNotSupported ：不支持附件类型。不支持的类型包括 RTF 格式的嵌入图像，或者电子邮件或日历项目以外的项目附件类型 (，例如联系人或任务项) 。
InvalidAttachmentId ：附件标识符不存在。

getAttachmentContentAsync(attachmentId, callback)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

从邮件或约会中获取附件，并将其作为 AttachmentContent 对象返回。

getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void): void;

参数

attachmentId: string

要获取的附件的标识符。

callback: (asyncResult: Office.AsyncResult<Office.AttachmentContent>) => void

void

注解

最低权限级别： 读取项

适用的 Outlook 模式：邮件Compose

错误：

AttachmentTypeNotSupported ：不支持附件类型。不支持的类型包括 RTF 格式的嵌入图像，或者电子邮件或日历项目以外的项目附件类型 (，例如联系人或任务项) 。
InvalidAttachmentId ：附件标识符不存在。

getAttachmentsAsync(options, callback)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

获取项的附件作为数组。

getAttachmentsAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<AttachmentDetailsCompose[]>) => void): void;

参数

options: Office.AsyncContextOptions

包含以下一个或多个属性的对象文本：- asyncContext：开发人员可以在回调函数中提供他们想要访问的任何对象。

callback: (asyncResult: Office.AsyncResult<Office.AttachmentDetailsCompose[]>) => void

可选。方法完成后，使用类型的Office.AsyncResult单个参数调用在参数中callback传递的函数。如果调用失败，属性 asyncResult.error 将包含错误代码，其中包含失败的原因。

void

注解

最低权限级别： 读取项

适用的 Outlook 模式：邮件Compose

getAttachmentsAsync(callback)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

获取项的附件作为数组。

getAttachmentsAsync(callback?: (asyncResult: Office.AsyncResult<AttachmentDetailsCompose[]>) => void): void;

参数

callback: (asyncResult: Office.AsyncResult<Office.AttachmentDetailsCompose[]>) => void

void

注解

最低权限级别： 读取项

适用的 Outlook 模式：邮件Compose

getComposeTypeAsync(options, callback)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

指定邮件撰写的类型及其强制类型。邮件可以是新邮件，也可以是答复或转发。强制类型可以是 HTML 或纯文本。

getComposeTypeAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<any>) => void): void;

参数

options: Office.AsyncContextOptions

包含以下一个或多个属性的对象文本：- asyncContext：开发人员可以在回调函数中提供他们想要访问的任何对象。

callback: (asyncResult: Office.AsyncResult<any>) => void

方法完成后，使用类型的Office.AsyncResult单个参数调用在参数中callback传递的函数。成功时， asyncResult.value 属性包含具有项的撰写类型和强制类型的对象。

void

具有 ComposeType 消息项的和 CoercionType 枚举值的对象。

注解

最低权限级别： 读取项

适用的 Outlook 模式：邮件Compose

getComposeTypeAsync(callback)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

指定邮件撰写的类型及其强制类型。邮件可以是新邮件，也可以是答复或转发。强制类型可以是 HTML 或纯文本。

getComposeTypeAsync(callback: (asyncResult: Office.AsyncResult<any>) => void): void;

参数

callback: (asyncResult: Office.AsyncResult<any>) => void

void

具有 ComposeType 消息项的和 CoercionType 枚举值的对象。

注解

最低权限级别： 读取项

适用的 Outlook 模式：邮件Compose

getConversationIndexAsync(options, callback)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

获取会话线程中当前消息的 Base64 编码位置。

getConversationIndexAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;

参数

options: Office.AsyncContextOptions

包含以下一个或多个属性的对象文本：- asyncContext：开发人员可以在回调函数中提供他们想要访问的任何对象。

callback: (asyncResult: Office.AsyncResult<string>) => void

方法完成后，使用单个参数 asyncResult（即 Office.AsyncResult 对象）调用在参数中callback传递的函数。在属性中返回 asyncResult.value 会话中当前消息的 Base64 编码位置。

void

注解

最低权限级别： 读取项

适用的 Outlook 模式：邮件Compose

提示：可以使用会话索引在会话线程中查找消息。然后，使用其内容为正在撰写的当前消息提供上下文。

getConversationIndexAsync(callback)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

获取会话线程中当前消息的 Base64 编码位置。

getConversationIndexAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;

参数

callback: (asyncResult: Office.AsyncResult<string>) => void

void

注解

最低权限级别： 读取项

适用的 Outlook 模式：邮件Compose

提示：可以使用会话索引在会话线程中查找消息。然后，使用其内容为正在撰写的当前消息提供上下文。

getInitializationContextAsync(options, callback)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

获取当加载项被可操作消息激活时传递的初始化数据。

getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;

参数

options: Office.AsyncContextOptions

包含以下一个或多个属性的对象文本：- asyncContext：开发人员可以在回调函数中提供他们想要访问的任何对象。

callback: (asyncResult: Office.AsyncResult<string>) => void

方法完成后，使用类型的Office.AsyncResult单个参数调用在参数中callback传递的函数。成功时，初始化上下文数据以字符串 (或空字符串的形式提供（如果属性中 asyncResult.value 没有初始化上下文) ）。

void

注解

最低权限级别： 读取项

适用的 Outlook 模式：邮件Compose

getInitializationContextAsync(callback)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

获取当加载项被可操作消息激活时传递的初始化数据。

getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;

参数

callback: (asyncResult: Office.AsyncResult<string>) => void

void

注解

最低权限级别： 读取项

适用的 Outlook 模式：邮件Compose

getItemClassAsync(options, callback)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

获取所选邮件的 Exchange Web Services 项类。

getItemClassAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;

参数

options: Office.AsyncContextOptions

包含以下一个或多个属性的对象文本：- asyncContext：开发人员可以在回调函数中提供他们想要访问的任何对象。

callback: (asyncResult: Office.AsyncResult<string>) => void

方法完成后，使用单个参数 asyncResult（即 Office.AsyncResult 对象）调用在参数中callback传递的函数。消息类在属性中 asyncResult.value 返回。

void

注解

最低权限级别： 读取项

适用的 Outlook 模式：邮件Compose

重要说明：

下表列出了默认消息类。

Item 类	说明
IPM。注意	新邮件和邮件答复
IPM。Note.SMIME	也可以签名的加密邮件
IPM。Note.SMIME.MultipartSigned	已明文签名的邮件
IPM.Schedule.Meeting.Request	会议请求
IPM.Schedule.Meeting.Canceled	会议取消
IPM。Schedule.Meeting.Resp.Neg	响应以拒绝会议要求
IPM。Schedule.Meeting.Resp.Pos	接受会议请求的响应
IPM。Schedule.Meeting.Resp.Tent	响应以暂时接受会议要求

getItemClassAsync(callback)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

获取所选邮件的 Exchange Web Services 项类。

getItemClassAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;

参数

callback: (asyncResult: Office.AsyncResult<string>) => void

方法完成后，使用单个参数 asyncResult（即 Office.AsyncResult 对象）调用在参数中callback传递的函数。消息类在属性中 asyncResult.value 返回。

void

注解

最低权限级别： 读取项

适用的 Outlook 模式：邮件Compose

重要说明：

下表列出了默认消息类。

Item 类	说明
IPM。注意	新邮件和邮件答复
IPM。Note.SMIME	也可以签名的加密邮件
IPM。Note.SMIME.MultipartSigned	已明文签名的邮件
IPM.Schedule.Meeting.Request	会议请求
IPM.Schedule.Meeting.Canceled	会议取消
IPM。Schedule.Meeting.Resp.Neg	响应以拒绝会议要求
IPM。Schedule.Meeting.Resp.Pos	接受会议请求的响应
IPM。Schedule.Meeting.Resp.Tent	响应以暂时接受会议要求

getItemIdAsync(options, callback)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

异步获取已保存项的 Exchange Web Services (EWS) 项标识符。

调用时，此方法通过回调函数返回项 ID。

getItemIdAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;

参数

options: Office.AsyncContextOptions

包含以下一个或多个属性的对象文本：- asyncContext：开发人员可以在回调函数中提供他们想要访问的任何对象。

callback: (asyncResult: Office.AsyncResult<string>) => void

方法完成后，使用类型的Office.AsyncResult单个参数调用在参数中callback传递的函数。在属性中 asyncResult.value 返回该项的 EWS 项 ID。

void

注解

最低权限级别： 读取项

适用的 Outlook 模式：邮件Compose

重要说明：

返回的项目 ID 与 Outlook 条目 ID 或 Outlook REST API 使用的 ID 不同。在使用此值进行 REST API 调用之前，应使用 Office.context.mailbox.convertToRestId进行转换。
例如，如果你的外接程序调用 getItemIdAsync 撰写模式下的项目 (，若要获取 itemId 用于 EWS 或 REST API) ，请注意，当 Outlook 处于缓存模式时，可能需要一段时间才能将项目同步到服务器。在项目同步之前， itemId 无法识别，并且使用它将返回错误。

错误：

ItemNotSaved ：在保存项目之前，无法检索 ID。

getItemIdAsync(callback)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

异步获取已保存项的 ID。

调用时，此方法通过回调函数返回项 ID。

注意：例如，如果你的外接程序调用 getItemIdAsync 撰写模式下的某个项目 (，若要获取 itemId 用于 EWS 或 REST API) ，请注意，当 Outlook 处于缓存模式时，可能需要一段时间才能将项目同步到服务器。在项目同步之前， itemId 无法识别，并且使用它将返回错误。

getItemIdAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;

参数

callback: (asyncResult: Office.AsyncResult<string>) => void

方法完成后，使用类型的Office.AsyncResult单个参数调用在参数中callback传递的函数。

void

注解

[ API set： Mailbox 1.8 for shared folder support， Mailbox 1.13 for shared mailbox support ]

最低权限级别： 读取项

适用的 Outlook 模式：邮件Compose

错误：

ItemNotSaved ：在保存项目之前，无法检索 ID。

getSharedPropertiesAsync(options, callback)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

获取共享文件夹或共享邮箱中约会或邮件的属性。

有关使用此 API 的详细信息，请参阅在 Outlook 外接程序中启用共享文件夹和共享邮箱方案。

getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void): void;

参数

options: Office.AsyncContextOptions

包含以下一个或多个属性的对象文本：- asyncContext：开发人员可以在回调函数中提供他们想要访问的任何对象。

callback: (asyncResult: Office.AsyncResult<Office.SharedProperties>) => void

方法完成后，使用单个参数 asyncResult（即 Office.AsyncResult 对象）调用在参数中callback传递的函数。属性 asyncResult.value 提供共享项的属性。

void

注解

最低权限级别： 读取项

适用的 Outlook 模式：邮件Compose

重要提示：在消息Compose模式下，Outlook 网页版或 Windows (新) 和经典) 不支持此 API，除非满足以下条件。

a. 委托访问权限/共享文件夹

邮箱所有者启动邮件。这可以是新邮件、答复或转发。
他们保存邮件，然后将其从自己的 Drafts 文件夹移动到与委托共享的文件夹。
委托从共享文件夹中打开草稿，然后继续撰写。

b. 共享邮箱 (仅适用于经典 Outlook on Windows)

共享邮箱用户启动邮件。这可以是新邮件、答复或转发。
他们保存邮件，然后将其从自己的 Drafts 文件夹移动到共享邮箱中的文件夹。
另一个共享邮箱用户打开共享邮箱中的草稿，然后继续撰写。

消息现在位于共享上下文中，支持这些共享方案的加载项可以获取项的共享属性。邮件发送后，通常位于发件人的 “已发送邮件” 文件夹中。

getSharedPropertiesAsync(callback)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

获取共享文件夹或共享邮箱中约会或邮件的属性。

有关使用此 API 的详细信息，请参阅在 Outlook 外接程序中启用共享文件夹和共享邮箱方案。

getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void): void;

参数

callback: (asyncResult: Office.AsyncResult<Office.SharedProperties>) => void

方法完成后，使用单个参数 asyncResult（即 Office.AsyncResult 对象）调用在参数中callback传递的函数。属性 asyncResult.value 提供共享项的属性。

void

注解

[ API set： Mailbox 1.8 for shared folder support， Mailbox 1.13 for shared mailbox support ]

最低权限级别： 读取项

适用的 Outlook 模式：邮件Compose

重要提示：在消息Compose模式下，Outlook 网页版或 Windows (新) 和经典) 不支持此 API，除非满足以下条件。

a. 委托访问权限/共享文件夹

邮箱所有者启动邮件。这可以是新邮件、答复或转发。
他们保存邮件，然后将其从自己的 Drafts 文件夹移动到与委托共享的文件夹。
委托从共享文件夹中打开草稿，然后继续撰写。

b. 共享邮箱 (仅适用于 Windows 版 Outlook)

共享邮箱用户启动邮件。这可以是新邮件、答复或转发。
他们保存邮件，然后将其从自己的 Drafts 文件夹移动到共享邮箱中的文件夹。
另一个共享邮箱用户打开共享邮箱中的草稿，然后继续撰写。

消息现在位于共享上下文中，支持这些共享方案的加载项可以获取项的共享属性。邮件发送后，通常位于发件人的 “已发送邮件” 文件夹中。

isClientSignatureEnabledAsync(options, callback)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

获取是否启用了客户端签名。

在 Outlook on Windows (经典) 中，如果新邮件、答复或转发的默认签名设置为发送 Outlook 帐户的模板，则 API 调用将返回 true 。在 Outlook 网页版和新的 Windows 版 Outlook 中，如果为撰写类型 newMail、或 forward启用了签名，reply则 API 调用将返回。true 如果在 Outlook on Windows (经典) 中将设置设置为“ (无) ”，或者在 Outlook 网页版或新的 Windows 版 Outlook 中禁用这些设置，则 API 调用将返回 false。

isClientSignatureEnabledAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<boolean>) => void): void;

参数

options: Office.AsyncContextOptions

包含以下一个或多个属性的对象文本：- asyncContext：开发人员可以在回调函数中提供他们想要访问的任何对象。

callback: (asyncResult: Office.AsyncResult<boolean>) => void

方法完成后，使用类型的Office.AsyncResult单个参数调用在参数中callback传递的函数。

void

注解

最低权限级别： 读取项

适用的 Outlook 模式：邮件Compose

isClientSignatureEnabledAsync(callback)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

获取是否启用了客户端签名。

isClientSignatureEnabledAsync(callback: (asyncResult: Office.AsyncResult<boolean>) => void): void;

参数

callback: (asyncResult: Office.AsyncResult<boolean>) => void

方法完成后，使用类型的Office.AsyncResult单个参数调用在参数中callback传递的函数。

void

注解