Office.LoadedMessageCompose interface

包:

outlook

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

注解

API 集：邮箱 1.15

最低权限级别： 读取/写入项目

适用的 Outlook 模式：Message Compose

重要说明：

• 实现 项目多选功能时，请确定是否已经可以通过调用访问 Office.context.mailbox.getSelectedItemsAsync 所选项目的所需属性。 如果可以，则无需调用 loadItemByIdAsync。

• 一次只能加载一个邮件项目。 实现 loadItemByIdAsync时，必须在处理项后调用 unloadAsync 。 在调用 loadItemByIdAsync 另一个项目之前必须执行此操作。

使用方

• Office.Mailbox： loadItemByIdAsync

示例

// Gets the sender's email address of each selected message.
async function getSenderEmailAddress(item) {
    const itemId = item.itemId;
    await new Promise((resolve) => {
        Office.context.mailbox.loadItemByIdAsync(itemId, (result) => {
            if (result.status === Office.AsyncResultStatus.Failed) {
                console.log(result.error.message);
                return;
            }

            const loadedItem = result.value;
            const sender = loadedItem.from.emailAddress;
            console.log(sender);

            // Unload the current message before processing another selected message.
            loadedItem.unloadAsync((asyncResult) => {
                if (asyncResult.status === Office.AsyncResultStatus.Failed) {
                    console.log(asyncResult.error.message);
                    return;
                }

                resolve();
            });
        });
    });
}

属性

bcc	获取邮件的密件抄 送 (密 件抄送) 行上的收件人。
body	获取项目的正文和格式。
categories	获取一个对象，该对象提供管理项类别的方法。
cc	获取邮件抄 送 (抄送) 行的收件人。
conversationId	获取包含特定消息的电子邮件会话的标识符。 如果在阅读窗体或撰写窗体的回复中激活邮件应用程序，则此属性可以获得一个整数值。 如果用户随后更改了回复邮件的主题（若发送回复），则该邮件的对话 ID 将改变且之前获取的值将不适用。 对于撰写窗体的新项目，此属性获得一个 null 值。
delayDeliveryTime	获取消息的延迟传递日期和时间。
from	获取邮件发件人的电子邮件地址。
inReplyTo	获取当前邮件回复的原始邮件的邮件 ID。
internetHeaders	获取消息的自定义 Internet 标头。 若要了解详细信息，请参阅如何在 Outlook 加载项中获取和设置邮件上的 Internet 标题。
itemType	获取实例表示的项的类型。 该 itemType 属性返回其中一个 ItemType 枚举值，指示项目对象实例是消息还是约会。
notificationMessages	获取项目的通知消息。
sensitivityLabel	获取邮件的敏感度标签。
seriesId	获取实例所属系列的 ID。 在 Outlook 网页版 和 Windows (新) 和经典 中，返回seriesId此项目所属的父 (系列) 项的 Exchange Web 服务 (EWS) ID。
subject	获取项目的主题字段中显示的说明。 该 subject 属性获取邮件服务器发送的项目的整个主题。
to	获取邮件“ 收件人 ”行上的收件人。 提供对邮件的“收件人”行上的收件人的访问权限。 对象的类型和访问级别取决于当前项目的模式。

方法

getAttachmentContentAsync(attachmentId, options, callback)	从邮件或约会中获取附件，并将其作为 AttachmentContent 对象返回。
getAttachmentContentAsync(attachmentId, callback)	从邮件或约会中获取附件，并将其作为 AttachmentContent 对象返回。
getAttachmentsAsync(options, callback)	以数组形式获取项的附件。
getAttachmentsAsync(callback)	以数组形式获取项的附件。
getComposeTypeAsync(options, callback)	指定消息撰写的类型及其强制类型。 邮件可以是新的，也可以是回复或转发。 强制类型可以是 HTML 或纯文本。
getComposeTypeAsync(callback)	指定消息撰写的类型及其强制类型。 邮件可以是新的，也可以是回复或转发。 强制类型可以是 HTML 或纯文本。
getConversationIndexAsync(options, callback)	获取当前消息在对话线程中的 Base64 编码位置。
getConversationIndexAsync(callback)	获取当前消息在对话线程中的 Base64 编码位置。
getInitializationContextAsync(options, callback)	获取由 可操作邮件激活加载项时传递的初始化数据。
getInitializationContextAsync(callback)	获取由 可操作邮件激活加载项时传递的初始化数据。
getItemClassAsync(options, callback)	获取所选邮件的 Exchange Web 服务项类。
getItemClassAsync(callback)	获取所选邮件的 Exchange Web 服务项类。
getItemIdAsync(options, callback)	异步获取 Exchange Web 服务 (EWS) 已保存项目的项目标识符。 调用时，此方法通过回调函数返回物品 ID。
getItemIdAsync(callback)	异步获取已保存项目的 ID。 调用时，此方法通过回调函数返回物品 ID。 注意：例如，如果加载项在撰写模式下调用 getItemIdAsync 项目， (例如，为了获取要 itemId 与 EWS 或 REST API) 一起使用的 ，请注意，当 Outlook 处于缓存模式时，可能需要一段时间才能将项目同步到服务器。 在同步该项之前，无法识别 ， itemId 因此使用它将返回错误。
getSharedPropertiesAsync(options, callback)	获取共享文件夹或共享邮箱中约会或邮件的属性。 有关使用此 API 的详细信息，请参阅在 Outlook 加载项中启用共享文件夹和共享邮箱方案。
getSharedPropertiesAsync(callback)	获取共享文件夹或共享邮箱中约会或邮件的属性。 有关使用此 API 的详细信息，请参阅在 Outlook 加载项中启用共享文件夹和共享邮箱方案。
isClientSignatureEnabledAsync(options, callback)	获取是否启用了客户端签名。 在 Windows (经典) 上的 Outlook 中，如果新邮件、答复或转发的默认签名设置为发送 Outlook 帐户的模板，则会返回 true API 调用。 在 Outlook 网页版和新的 Outlook on Windows 中，如果为撰写类型 newMail、 或 reply启用forward签名，则会返回 true API 调用。 如果在 Windows 上的 Outlook (经典) 中将设置设置为“无) (”，或者在 Windows 上的 Outlook 网页版 或新的 Outlook 中被禁用，则 API 调用将返回false。
isClientSignatureEnabledAsync(callback)	获取是否启用了客户端签名。 在 Windows (经典) 上的 Outlook 中，如果新邮件、答复或转发的默认签名设置为发送 Outlook 帐户的模板，则会返回 true API 调用。 在 Outlook 网页版和新的 Outlook on Windows 中，如果为撰写类型 newMail、 或 reply启用forward签名，则会返回 true API 调用。 如果在 Windows 上的 Outlook (经典) 中将设置设置为“无) (”，或者在 Windows 上的 Outlook 网页版 或新的 Outlook 中被禁用，则 API 调用将返回false。
loadCustomPropertiesAsync(callback, userContext)	异步加载所选项目上此外接程序的自定义属性。 自定义属性会以键值对的形式存储在每个应用和项的基础上。 此方法在回调中返回一个 CustomProperties 对象，该对象提供访问特定于当前项和当前加载项的自定义属性的方法。 项上的自定义属性未加密，因此不应将其用作安全存储。 自定义属性作为 asyncResult.value 属性中的 CustomProperties 对象提供。 此对象可用于从邮件项目中获取自定义属性。
saveAsync(options, callback)	异步将当前邮件另存为草稿。
saveAsync(callback)	异步将当前邮件另存为草稿。
unloadAsync(options, callback)	选择多个邮件项时，关闭当前装入的项，以便可以加载另一个选定的邮件项进行处理。
unloadAsync(callback)	选择多个邮件项时，关闭当前装入的项，以便可以加载另一个选定的邮件项进行处理。

属性详细信息

bcc

获取邮件的密件抄 送 (密 件抄送) 行上的收件人。

bcc: Recipients;

属性值

Office.Recipients

注解

API 集：邮箱 1.1

最低权限级别： 读取项目

适用的 Outlook 模式：Message Compose

重要说明：

• 仅 getAsync 支持 Recipients 对象的方法。

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

body

获取项目的正文和格式。

body: Body;

属性值

Office.Body

注解

API 集：邮箱 1.1

最低权限级别： 读取项目

适用的 Outlook 模式：Message Compose

重要提示： 仅支持 Body 对象的 getAsync and getTypeAsync 方法。

categories

获取一个对象，该对象提供管理项类别的方法。

categories: Categories;

属性值

Office.Categories

注解

API 集：邮箱 1.8

最低权限级别： 读取项目

适用的 Outlook 模式：Message Compose

cc

获取邮件抄 送 (抄送) 行的收件人。

cc: Recipients;

属性值

Office.Recipients

注解

最低权限级别： 读取项目

适用的 Outlook 模式：Message Compose

重要说明：

• 仅 getAsync 支持 Recipients 对象的方法。

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

conversationId

获取包含特定消息的电子邮件会话的标识符。

如果在阅读窗体或撰写窗体的回复中激活邮件应用程序，则此属性可以获得一个整数值。 如果用户随后更改了回复邮件的主题（若发送回复），则该邮件的对话 ID 将改变且之前获取的值将不适用。

对于撰写窗体的新项目，此属性获得一个 null 值。

conversationId: string;

属性值

string

注解

最低权限级别： 读取项目

适用的 Outlook 模式：Message Compose

delayDeliveryTime

获取消息的延迟传递日期和时间。

delayDeliveryTime: DelayDeliveryTime;

属性值

Office.DelayDeliveryTime

注解

API 集：邮箱 1.13

最低权限级别： 读取项目

适用的 Outlook 模式：Message Compose

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

from

获取邮件发件人的电子邮件地址。

from: From;

属性值

Office.From

注解

API 集：邮箱 1.7

最低权限级别： 读取项目

适用的 Outlook 模式：Message Compose

inReplyTo

获取当前邮件回复的原始邮件的邮件 ID。

inReplyTo: string;

属性值

string

注解

API 集：邮箱 1.14

最低权限级别： 读取项目

适用的 Outlook 模式：Message Compose

重要说明：

• 在 Windows 上的 Outlook 中， inReplyTo 无论用户是否进行更改（例如更改回复中的主题），该值都将保留在所有回复上。

• inReplyTo该属性将返回null由同时也是会议组织者的用户转发的新消息和会议邀请。

internetHeaders

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

若要了解详细信息，请参阅如何在 Outlook 加载项中获取和设置邮件上的 Internet 标题。

internetHeaders: InternetHeaders;

属性值

Office.InternetHeaders

注解

API 集：邮箱 1.8

最低权限级别： 读取项目

适用的 Outlook 模式：Message Compose

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

itemType

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

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

itemType: MailboxEnums.ItemType | string;

属性值

Office.MailboxEnums.ItemType | string

注解

最低权限级别： 读取项目

适用的 Outlook 模式：Message Compose

notificationMessages

获取项目的通知消息。

notificationMessages: NotificationMessages;

属性值

Office.NotificationMessages

注解

API 集：邮箱 1.3

最低权限级别： 读取项目

适用的 Outlook 模式：Message Compose

重要说明：

• 若要了解可实现的不同类型的通知消息，请参阅为 Outlook 加载项创建通知。

• 仅 getAllAsync 支持 NotificationMessages 对象的方法。

sensitivityLabel

获取邮件的敏感度标签。

sensitivityLabel: SensitivityLabel;

属性值

Office.SensitivityLabel

注解

API 集：邮箱 1.13

最低权限级别： 读取/写入项目

适用的 Outlook 模式：Message Compose

重要说明：

• 若要在加载项中使用敏感度标签功能，必须具有 Microsoft 365 E5 订阅。

• 仅 getAsync 支持 SensitivityLabel 对象的方法。

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

seriesId

获取实例所属系列的 ID。

在 Outlook 网页版 和 Windows (新) 和经典 中，返回seriesId此项目所属的父 (系列) 项的 Exchange Web 服务 (EWS) ID。

seriesId: string;

属性值

string

注解

API 集：邮箱 1.7

最低权限级别： 读取项目

适用的 Outlook 模式：Message Compose

重要提示： 该 seriesId 属性返回的标识符与 Exchange Web 服务项标识符相同。 该 seriesId 属性与 Outlook REST API 使用的 Outlook ID 并不完全相同。 在使用此值进行 REST API 调用之前，应使用 Office.context.mailbox.convertToRestId. 有关更多详细信息，请参阅 通过 Outlook 加载项使用 Outlook REST API。

seriesId该属性null返回没有父项的项目（如单个约会、系列项目或会议请求），并返回undefined非会议请求的任何其他项目。

subject

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

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

subject: Subject;

属性值

Office.Subject

注解

最低权限级别： 读取项目

适用的 Outlook 模式：Message Compose

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

to

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

to: Recipients;

属性值

Office.Recipients

注解

最低权限级别： 读取项目

适用的 Outlook 模式：Message Compose

重要说明：

• 仅 getAsync 支持 Recipients 对象的方法。

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

方法详细信息

getAttachmentContentAsync(attachmentId, options, callback)

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

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

参数

attachmentId

string

要获取的附件的标识符。 在 Outlook 网页版和新的 Outlook Windows 版中，在当前撰写会话期间，为尚未上传到服务器的内联图像在本地生成的临时附件 ID 受支持。

options

Office.AsyncContextOptions

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

callback

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

可选。 当该方法完成时，将使用单个参数（一个对象）asyncResultOffice.AsyncResult调用传入参数的callback函数。 如果调用失败， asyncResult.error 属性将包含一个错误代码以及失败的原因。

返回

void

注解

API 集：邮箱 1.8

最低权限级别： 读取项目

适用的 Outlook 模式：Message Compose

重要说明：

• 该 getAttachmentContentAsync 方法从项目中获取具有指定标识符的附件。 作为最佳做法，应从调用中 getAttachmentsAsync 获取附件的标识符，然后在同一会话中使用该标识符检索附件。

• 从 2026 年 3 月 30 日开始，在调用或addFileAttachmentAsyncaddFileAttachmentFromBase64Async设置为true完成后isInline，在将 Outlook 网页版和新的 Outlook on Windows 中的邮件中的内联图像上传到服务器时，会在本地分配临时附件 ID。 临时附件 ID 以 为前缀。addinId 将图像上传到服务器后，会为它们分配一个 Exchange Web 服务 (EWS) ID。 仅在当前撰写会话期间支持临时附件 ID。 有关内联图像处理方式的更改的详细信息，请参阅 Outlook 加载项中内联图像附件 ID 的更改。

• 在 Outlook 网页版和 Windows 上的新版 Outlook 中，getAttachmentContentAsync不支持使用“上传并共享”选项添加的附件。

• 在 Outlook 网页版、移动设备和 Windows 上的新 Outlook 中，附件标识符仅在同一会话中有效。 当用户关闭应用时，或者如果用户开始撰写内联表单然后随后弹出表单以在单独的窗口中继续，则会话结束。

错误：

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

• InvalidAttachmentId ：附件标识符不存在。

getAttachmentContentAsync(attachmentId, callback)

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

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

参数

attachmentId

string

要获取的附件的标识符。 在 Outlook 网页版和新的 Outlook Windows 版中，在当前撰写会话期间，为尚未上传到服务器的内联图像在本地生成的临时附件 ID 受支持。

callback

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

可选。 当该方法完成时，将使用单个参数（一个对象）asyncResultOffice.AsyncResult调用传入参数的callback函数。 如果调用失败， asyncResult.error 属性将包含一个错误代码以及失败的原因。

返回

void

注解

API 集：邮箱 1.8

最低权限级别： 读取项目

适用的 Outlook 模式：Message Compose

重要说明：

• 该 getAttachmentContentAsync 方法从项目中获取具有指定标识符的附件。 作为最佳做法，应从调用中 getAttachmentsAsync 获取附件的标识符，然后在同一会话中使用该标识符检索附件。

• 从 2026 年 3 月 30 日开始，在调用或addFileAttachmentAsyncaddFileAttachmentFromBase64Async设置为true完成后isInline，在将 Outlook 网页版和新的 Outlook on Windows 中的邮件中的内联图像上传到服务器时，会在本地分配临时附件 ID。 临时附件 ID 以 为前缀。addinId 将图像上传到服务器后，会为它们分配一个 Exchange Web 服务 (EWS) ID。 仅在当前撰写会话期间支持临时附件 ID。 有关内联图像处理方式的更改的详细信息，请参阅 Outlook 加载项中内联图像附件 ID 的更改。

• 在 Outlook 网页版和 Windows 上的新版 Outlook 中，getAttachmentContentAsync不支持使用“上传并共享”选项添加的附件。

• 在 Outlook 网页版、移动设备和 Windows 上的新 Outlook 中，附件标识符仅在同一会话中有效。 当用户关闭应用时，或者如果用户开始撰写内联表单然后随后弹出表单以在单独的窗口中继续，则会话结束。

错误：

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

• InvalidAttachmentId ：附件标识符不存在。

getAttachmentsAsync(options, callback)

以数组形式获取项的附件。

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

参数

options

Office.AsyncContextOptions

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

callback

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

可选。 当该方法完成时， callback 将使用类型 Office.AsyncResult为 . 如果调用失败， asyncResult.error 属性将包含一个错误代码以及失败的原因。 如果调用成功，则会在属性中asyncResult.value返回一个对象数AttachmentDetailsCompose组。

返回

void

注解

API 集：邮箱 1.8

最低权限级别： 读取项目

适用的 Outlook 模式：Message Compose

重要说明：

• 从 2026 年 3 月 30 日开始，在调用或addFileAttachmentAsyncaddFileAttachmentFromBase64Async设置为true完成后isInline，在将 Outlook 网页版和新的 Outlook on Windows 中的邮件中的内联图像上传到服务器时，会在本地分配临时附件 ID。 临时附件 ID 以 为前缀。addinId 将图像上传到服务器后，会为它们分配一个 Exchange Web 服务 (EWS) ID。 仅在当前撰写会话期间支持临时附件 ID。 有关内联图像处理方式的更改的详细信息，请参阅 Outlook 加载项中内联图像附件 ID 的更改。

• 在 Outlook 网页版和 Windows 上的新版 Outlook 中，用户可以选择“上传并共享”选项将附件上传到 OneDrive，并在邮件项目中包含指向该文件的链接。 但是，由于仅包含链接， getAttachmentsAsync 因此不会返回此附件。

getAttachmentsAsync(callback)

以数组形式获取项的附件。

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

参数

callback

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

可选。 当该方法完成时， callback 将使用类型 Office.AsyncResult为 . 如果调用失败， asyncResult.error 属性将包含一个错误代码以及失败的原因。 如果调用成功，则会在属性中asyncResult.value返回一个对象数AttachmentDetailsCompose组。

返回

void

注解

API 集：邮箱 1.8

最低权限级别： 读取项目

适用的 Outlook 模式：Message Compose

重要说明：

• 从 2026 年 3 月 30 日开始，在调用或addFileAttachmentAsyncaddFileAttachmentFromBase64Async设置为true完成后isInline，在将 Outlook 网页版和新的 Outlook on Windows 中的邮件中的内联图像上传到服务器时，会在本地分配临时附件 ID。 临时附件 ID 以 为前缀。addinId 将图像上传到服务器后，会为它们分配一个 Exchange Web 服务 (EWS) ID。 仅在当前撰写会话期间支持临时附件 ID。 有关内联图像处理方式的更改的详细信息，请参阅 Outlook 加载项中内联图像附件 ID 的更改。

• 在 Outlook 网页版和 Windows 上的新版 Outlook 中，用户可以选择“上传并共享”选项将附件上传到 OneDrive，并在邮件项目中包含指向该文件的链接。 但是，由于仅包含链接， getAttachmentsAsync 因此不会返回此附件。

getComposeTypeAsync(options, callback)

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

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

参数

options

Office.AsyncContextOptions

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

callback

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

当该方法完成时， callback 将使用类型 Office.AsyncResult为 . 成功后，该 asyncResult.value 属性包含一个具有项的撰写类型和强制类型的对象。

返回

void

一个对象，其中包含 ComposeType 消息项的 和 CoercionType 枚举值。

注解

API 集：邮箱 1.10

最低权限级别： 读取项目

适用的 Outlook 模式：Message Compose

getComposeTypeAsync(callback)

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

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

参数

callback

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

当该方法完成时， callback 将使用类型 Office.AsyncResult为 . 成功后，该 asyncResult.value 属性包含一个具有项的撰写类型和强制类型的对象。

返回

void

一个对象，其中包含 ComposeType 消息项的 和 CoercionType 枚举值。

注解

API 集：邮箱 1.10

最低权限级别： 读取项目

适用的 Outlook 模式：Message Compose

getConversationIndexAsync(options, callback)

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

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

参数

options

Office.AsyncContextOptions

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

callback

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

当该方法完成时，将使用单个参数（一个对象）asyncResultOffice.AsyncResult调用传入参数的callback函数。 在属性中 asyncResult.value 返回当前消息在对话中的 Base64 编码位置。

返回

void

注解

API 集：邮箱 1.14

最低权限级别： 读取项目

适用的 Outlook 模式：Message Compose

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

getConversationIndexAsync(callback)

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

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

参数

callback

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

当该方法完成时，将使用单个参数（一个对象）asyncResultOffice.AsyncResult调用传入参数的callback函数。 在属性中 asyncResult.value 返回当前消息在对话中的 Base64 编码位置。

返回

void

注解

API 集：邮箱 1.14

最低权限级别： 读取项目

适用的 Outlook 模式：Message Compose

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

getInitializationContextAsync(options, callback)

获取由 可操作邮件激活加载项时传递的初始化数据。

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

参数

options

Office.AsyncContextOptions

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

callback

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

当该方法完成时， callback 将使用类型 Office.AsyncResult为 . 成功后，初始化上下文数据将以字符串 (的形式提供，如果属性中 asyncResult.value 没有初始化上下文) 则为空字符串提供。

返回

void

注解

API 集：邮箱 1.8

最低权限级别： 读取项目

适用的 Outlook 模式：Message Compose

getInitializationContextAsync(callback)

获取由 可操作邮件激活加载项时传递的初始化数据。

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

参数

callback

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

当该方法完成时， callback 将使用类型 Office.AsyncResult为 . 成功后，初始化上下文数据将以字符串 (的形式提供，如果属性中 asyncResult.value 没有初始化上下文) 则为空字符串提供。

返回

void

注解

API 集：邮箱 1.8

最低权限级别： 读取项目

适用的 Outlook 模式：Message Compose

getItemClassAsync(options, callback)

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

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

参数

options

Office.AsyncContextOptions

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

callback

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

当该方法完成时，将使用单个参数（一个对象）asyncResultOffice.AsyncResult调用传入参数的callback函数。 在属性中 asyncResult.value 返回消息类。

返回

void

注解

API 集：邮箱 1.14

最低权限级别： 读取项目

适用的 Outlook 模式：Message Compose

重要说明：

下表列出了默认消息类。

项目类	说明
IPM。备注	新邮件和消息答复
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)

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

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

参数

callback

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

当该方法完成时，将使用单个参数（一个对象）asyncResultOffice.AsyncResult调用传入参数的callback函数。 在属性中 asyncResult.value 返回消息类。

返回

void

注解

API 集：邮箱 1.14

最低权限级别： 读取项目

适用的 Outlook 模式：Message Compose

重要说明：

下表列出了默认消息类。

项目类	说明
IPM。备注	新邮件和消息答复
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)

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

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

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

参数

options

Office.AsyncContextOptions

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

callback

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

当该方法完成时， callback 将使用类型 Office.AsyncResult为 . 在属性中 asyncResult.value 返回项目的 EWS 项 ID。

返回

void

注解

API 集：邮箱 1.8

最低权限级别： 读取项目

适用的 Outlook 模式：Message 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)

异步获取已保存项目的 ID。

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

注意：例如，如果加载项在撰写模式下调用 getItemIdAsync 项目， (例如，为了获取要 itemId 与 EWS 或 REST API) 一起使用的 ，请注意，当 Outlook 处于缓存模式时，可能需要一段时间才能将项目同步到服务器。 在同步该项之前，无法识别 ， itemId 因此使用它将返回错误。

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

参数

callback

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

当该方法完成时， callback 将使用类型 Office.AsyncResult为 .

返回

void

注解

API 集：邮箱 1.8

最低权限级别： 读取项目

适用的 Outlook 模式：Message Compose

错误：

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

getSharedPropertiesAsync(options, callback)

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

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

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

参数

options

Office.AsyncContextOptions

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

callback

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

当该方法完成时，将使用单个参数（一个对象）asyncResultOffice.AsyncResult调用传入参数的callback函数。 该 asyncResult.value 属性提供共享项的属性。

返回

void

注解

API 集：邮箱 1.8（用于支持共享文件夹），邮箱 1.13（用于支持共享邮箱）

最低权限级别： 读取项目

适用的 Outlook 模式：Message Compose

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

a. 委派访问/共享文件夹

1. 邮箱所有者启动邮件。 这可以是新邮件、答复或转发。

2. 他们保存邮件，然后将其从自己的 “草稿” 文件夹移动到与代理人共享的文件夹中。

3. 代理从共享文件夹打开草稿，然后继续撰写。

b. 在与用户主邮箱相同的面板中打开的共享邮箱 (Web、经典 Windows) 或尚未升级为完整帐户的共享邮箱 (新的 Windows)

1. 共享邮箱用户启动邮件。 这可以是新邮件、答复或转发。

2. 他们保存邮件，然后将其从自己的 “草稿” 文件夹移动到共享邮箱中的文件夹中。

3. 另一个共享邮箱用户从共享邮箱打开草稿，然后继续撰写。

满足这些条件后，消息将在共享上下文中可用，并且支持这些共享方案的加载项可以获取项的共享属性。 发送邮件后，通常会在发件人个人邮箱的 “已发送邮件 ”文件夹中找到它。

以下平台支持该 getSharedPropertiesAsync 方法，没有附加条件。

• 使用“打开其他邮箱”选项在单独的选项卡或窗口中打开共享邮箱时Outlook 网页版。

• 共享邮箱升级为完整帐户时在 Windows 上新建 Outlook。

getSharedPropertiesAsync(callback)

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

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

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

参数

callback

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

当该方法完成时，将使用单个参数（一个对象）asyncResultOffice.AsyncResult调用传入参数的callback函数。 该 asyncResult.value 属性提供共享项的属性。

返回

void

注解

API 集：邮箱 1.8（用于支持共享文件夹），邮箱 1.13（用于支持共享邮箱）

最低权限级别： 读取项目

适用的 Outlook 模式：Message Compose

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

a. 委派访问/共享文件夹

1. 邮箱所有者启动邮件。 这可以是新邮件、答复或转发。

2. 他们保存邮件，然后将其从自己的 “草稿” 文件夹移动到与代理人共享的文件夹中。

3. 代理从共享文件夹打开草稿，然后继续撰写。

b. 在与用户主邮箱相同的面板中打开的共享邮箱 (Web、经典 Windows) 或尚未升级为完整帐户的共享邮箱 (新的 Windows)

1. 共享邮箱用户启动邮件。 这可以是新邮件、答复或转发。

2. 他们保存邮件，然后将其从自己的 “草稿” 文件夹移动到共享邮箱中的文件夹中。

3. 另一个共享邮箱用户从共享邮箱打开草稿，然后继续撰写。

满足这些条件后，消息将在共享上下文中可用，并且支持这些共享方案的加载项可以获取项的共享属性。 发送邮件后，通常会在发件人个人邮箱的 “已发送邮件 ”文件夹中找到它。

以下平台支持该 getSharedPropertiesAsync 方法，没有附加条件。

• 使用“打开其他邮箱”选项在单独的选项卡或窗口中打开共享邮箱时Outlook 网页版。

• 共享邮箱升级为完整帐户时在 Windows 上新建 Outlook。

isClientSignatureEnabledAsync(options, callback)

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

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

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

参数

options

Office.AsyncContextOptions

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

callback

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

当该方法完成时， callback 将使用类型 Office.AsyncResult为 .

返回

void

注解

API 集：邮箱 1.10

最低权限级别： 读取项目

适用的 Outlook 模式：Message Compose

isClientSignatureEnabledAsync(callback)

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

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

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

参数

callback

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

当该方法完成时， callback 将使用类型 Office.AsyncResult为 .

返回

void

注解

API 集：邮箱 1.10

最低权限级别： 读取项目

适用的 Outlook 模式：Message Compose

loadCustomPropertiesAsync(callback, userContext)

异步加载所选项目上此外接程序的自定义属性。

自定义属性会以键值对的形式存储在每个应用和项的基础上。 此方法在回调中返回一个 CustomProperties 对象，该对象提供访问特定于当前项和当前加载项的自定义属性的方法。 项上的自定义属性未加密，因此不应将其用作安全存储。

自定义属性作为 asyncResult.value 属性中的 CustomProperties 对象提供。 此对象可用于从邮件项目中获取自定义属性。

loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult<CustomProperties>) => void, userContext?: any): void;

参数

callback

(asyncResult: Office.AsyncResult<Office.CustomProperties>) => void

当该方法完成时， callback 将使用类型 Office.AsyncResult为 .

userContext

any

可选。 开发人员可以提供他们想要在回调函数中访问的任何对象。 此对象可以通过回调函数中的 asyncResult.asyncContext 属性进行访问。

返回

void

注解

API 集：邮箱 1.1

若要了解有关自定义属性的详细信息，请参阅 获取和设置 Outlook 加载项的加载项元数据。

最低权限级别： 读取项目

适用的 Outlook 模式：Message Compose

saveAsync(options, callback)

异步将当前邮件另存为草稿。

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

参数

options

Office.AsyncContextOptions

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

callback

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

当该方法完成时，将使用单个参数（一个对象）asyncResultOffice.AsyncResult调用传入参数的callback函数。 在属性中 asyncResult.value 返回 EWS 消息 ID。

返回

void

注解

API 集：邮箱 1.3

最低权限级别： 读取/写入项目

适用的 Outlook 模式：Message Compose

重要说明：

• 在 Outlook 网页版、新的 Windows 版 Outlook 或处于联机模式 (非缓存模式) 的经典 Windows 版 Outlook 中，项目将保存到服务器。 在 Outlook 缓存模式下，该项目被保存到本地缓存中。

• 使用 HTML 格式的内容时，请务必注意 Outlook 客户端可能会修改内容。 这意味着对 、 甚至saveAsyncBody.setAsync等Body.getAsync方法的后续调用可能不会导致相同的内容。

• 返回的标识符与 Exchange Web 服务 (EWS) 项标识符相同。 返回的项 ID 与 Outlook 条目 ID 或 Outlook REST API 使用的 ID 并不完全相同。 在使用此值进行 REST API 调用之前，应使用 Office.context.mailbox.convertToRestId.

• 如果加载项在撰写模式下调用 saveAsync 项目以获取要用于 EWS 或 REST API 的项目 ID，请注意，当 Outlook 处于缓存模式时，可能需要一段时间才能将项目实际同步到服务器。 在项同步之前，使用项 ID 将返回错误。

• 在 Outlook 网页版和 Windows 上的新 Outlook 中，对将从共享邮箱帐户发送的邮件进行调用时saveAsync，草稿保存到的邮箱帐户各不相同。 如果发件人从其个人邮箱创建新邮件，并在“ 发件人 ”字段中选择共享邮箱帐户， saveAsync 则会将草稿保存到用户个人邮箱的“ 草稿” 文件夹。 如果发件人 (“ 打开其他邮箱 ”选项（例如) ）在单独的浏览器选项卡中打开共享邮箱帐户，并在那里创建新邮件， saveAsync 则会将草稿保存到共享邮箱的 “草稿” 文件夹。

错误：

• InvalidAttachmentId ：附件标识符不存在。

saveAsync(callback)

异步将当前邮件另存为草稿。

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

参数

callback

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

当该方法完成时，将使用单个参数（一个对象）asyncResultOffice.AsyncResult调用传入参数的callback函数。 在属性中 asyncResult.value 返回 EWS 消息 ID。

返回

void

注解

API 集：邮箱 1.3

最低权限级别： 读取/写入项目

适用的 Outlook 模式：Message Compose

重要说明：

• 在 Outlook 网页版、新的 Windows 版 Outlook 或处于联机模式 (非缓存模式) 的经典 Windows 版 Outlook 中，项目将保存到服务器。 在 Outlook 缓存模式下，该项目被保存到本地缓存中。

• 使用 HTML 格式的内容时，请务必注意 Outlook 客户端可能会修改内容。 这意味着对 、 甚至saveAsyncBody.setAsync等Body.getAsync方法的后续调用可能不会导致相同的内容。

• 返回的标识符与 Exchange Web 服务 (EWS) 项标识符相同。 返回的项 ID 与 Outlook 条目 ID 或 Outlook REST API 使用的 ID 并不完全相同。 在使用此值进行 REST API 调用之前，应使用 Office.context.mailbox.convertToRestId.

• 如果加载项在撰写模式下调用 saveAsync 项目以获取要用于 EWS 或 REST API 的项目 ID，请注意，当 Outlook 处于缓存模式时，可能需要一段时间才能将项目实际同步到服务器。 在项同步之前，使用项 ID 将返回错误。

• 在 Outlook 网页版和 Windows 上的新 Outlook 中，对将从共享邮箱帐户发送的邮件进行调用时saveAsync，草稿保存到的邮箱帐户各不相同。 如果发件人从其个人邮箱创建新邮件，并在“ 发件人 ”字段中选择共享邮箱帐户， saveAsync 则会将草稿保存到用户个人邮箱的“ 草稿” 文件夹。 如果发件人 (“ 打开其他邮箱 ”选项（例如) ）在单独的浏览器选项卡中打开共享邮箱帐户，并在那里创建新邮件， saveAsync 则会将草稿保存到共享邮箱的 “草稿” 文件夹。

错误：

• InvalidAttachmentId ：附件标识符不存在。

unloadAsync(options, callback)

选择多个邮件项时，关闭当前装入的项，以便可以加载另一个选定的邮件项进行处理。

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

参数

options

Office.AsyncContextOptions

包含 asyncContext 属性的对象文本。 将要在回调函数 asyncContext 中访问的任何对象分配给该属性。

callback

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

可选。 该方法完成后，将使用单个参数（一个对象）asyncResultOffice.AsyncResult调用传入回调参数的函数。

返回

void

注解

API 集：邮箱 1.15

最低权限级别： 读取/写入项目

适用的 Outlook 模式：Message Compose

重要说明：

• 若要了解有关处理多封选定邮件的详细信息，请参阅 在多封邮件上激活 Outlook 加载项。

• 使用所选邮件项加载 loadItemByIdAsync时，必须在处理后调用 unloadAsync 。 在调用 loadItemByIdAsync 另一个选定项之前必须执行此操作。

unloadAsync(callback)

选择多个邮件项时，关闭当前装入的项，以便可以加载另一个选定的邮件项进行处理。

unloadAsync(callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

参数

callback

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

可选。 该方法完成后，将使用单个参数（一个对象）asyncResultOffice.AsyncResult调用传入回调参数的函数。

返回

void

注解

API 集：邮箱 1.15

最低权限级别： 读取/写入项目

适用的 Outlook 模式：Message Compose

重要说明：

• 若要了解有关处理多封选定邮件的详细信息，请参阅 在多封邮件上激活 Outlook 加载项。

• 使用所选邮件项加载 loadItemByIdAsync时，必须在处理后调用 unloadAsync 。 在调用 loadItemByIdAsync 另一个选定项之前必须执行此操作。