Office.LoadedMessageRead interface

包:
outlook

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

注解

API 集：邮箱 1.15

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

适用的 Outlook 模式：消息阅读

重要说明：

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

  • 一次只能加载一个邮件项目。 实现 loadItemByIdAsync时，必须在处理项后调用 unloadAsync 。 在调用 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();
            });
        });
    });
}

属性

attachments

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

获取物品的正文及其格式。
categories

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

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

该cc属性返回的数组包含邮件抄送行上列出的每个收件人的 EmailAddressDetails 对象。 返回的最大收件人数因 Outlook 客户端而异。

  • Windows (经典) ：500 名收件人

  • Windows (经典 - 从版本 2511 开始处于预览状态 (内部版本 19426.20000) ) ：1,000 名收件人

  • Web 浏览器，Windows (新) ：折叠视图) (20 个收件人，展开视图) (500 个收件人
conversationId

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

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

获取项目创建的日期和时间。
dateTimeModified

获取项目最近一次修改的日期和时间。
end

获取约会结束的日期和时间。

该 end 属性是一个 Date 对象，表示为协调世界时 (UTC) 日期和时间值。 可以使用该 convertToLocalClientTime 方法将属性值转换为 end 客户端的本地日期和时间。

使用 Time.setAsync 方法设置结束时间时，应使用 convertToUtcClientTime 方法将客户端的本地时间转换为服务器的 UTC。
from

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

该 from 属性返回一个 EmailAddressDetails 对象。
internetMessageId

获取消息的 Internet 消息标识符。
itemClass

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

获取当前项的 Exchange Web 服务项标识符 。
itemType

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

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

获取会议请求的位置。

location 属性返回一个包含约会位置的字符串。
normalizedSubject

获取项目的主题，删除 (所有前缀，包括 RE： 和 FWD：) 。

normalizedSubject该属性获取项目的主题，以及电子邮件程序添加的任何标准前缀 (，例如 RE： 和 FW：) 。 若要获取包含完整前缀的项目主题，请使用 subject 属性。
notificationMessages

获取项目的通知消息。
recurrence

获取约会的重复周期模式。 获取会议请求的重复周期模式。 约会项目的读取和撰写模式。 会议请求项目的读取模式。

recurrence如果项目是系列或系列中的实例，则该属性返回Recurrence定期约会或会议请求的对象。 null 为单个约会和单个约会的会议请求返回。 undefined 为非会议请求的邮件返回。
sender

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

获取实例所属系列的 ID。

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

获取约会开始的日期和时间。

该 start 属性是一个 Date 对象，表示为协调世界时 (UTC) 日期和时间值。 可以使用该 convertToLocalClientTime 方法将值转换为客户端的本地日期和时间。
subject

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

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

subject 属性返回一个字符串。 使用该 normalizedSubject 属性获取主题减去任何前导前缀，例如 RE： 和 FW：。
to

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

该to属性返回的数组包含邮件“收件人”行上列出的每个收件人的 EmailAddressDetails 对象。 返回的最大收件人数因 Outlook 客户端而异。

  • Windows (经典) ：500 名收件人

  • Windows (经典 - 从版本 2511 开始处于预览状态 (内部版本 19426.20000) ) ：1,000 名收件人

  • Web 浏览器，Windows (新) ：折叠视图) (20 个收件人，展开视图) (500 个收件人

方法

displayReplyAllFormAsync(formData, options, callback)

显示一个回复表单，该表单包括所选邮件的发件人和所有收件人，或者包括所选约会的组织者和所有与会者。
displayReplyAllFormAsync(formData, callback)

显示一个回复表单，该表单包括所选邮件的发件人和所有收件人，或者包括所选约会的组织者和所有与会者。
displayReplyFormAsync(formData, options, callback)

显示答复窗体，其中仅包括所选邮件的发件人或所选约会的组织者。
displayReplyFormAsync(formData, callback)

显示答复窗体，其中仅包括所选邮件的发件人或所选约会的组织者。
getAllInternetHeadersAsync(options, callback)

以字符串形式获取消息的所有 Internet 标头。

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

以字符串形式获取消息的所有 Internet 标头。

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

获取以 Base64 编码的 EML 格式的当前消息。
getAsFileAsync(callback)

获取以 Base64 编码的 EML 格式的当前消息。
getAttachmentContentAsync(attachmentId, options, callback)

从邮件或约会中获取附件，并将其作为 AttachmentContent 对象返回。
getAttachmentContentAsync(attachmentId, callback)

从邮件或约会中获取附件，并将其作为 AttachmentContent 对象返回。
getInitializationContextAsync(options, callback)

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

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

返回所选项目中与 XML 清单文件中定义的正则表达式匹配的字符串值。
getRegExMatchesByName(name)

返回所选项目中与 XML 清单文件中定义的命名正则表达式匹配的字符串值。
getSelectedRegExMatches()

在突出显示的匹配项中返回与 XML 清单文件中定义的正则表达式匹配的字符串值。 突出显示的匹配项适用于上下文外接程序。
getSharedPropertiesAsync(options, callback)

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

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

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

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

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

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

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

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

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

属性详细信息

attachments

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

attachments: AttachmentDetails[];

属性值

Office.AttachmentDetails[]

注解

最低权限级别： 读取项目

适用的 Outlook 模式：消息阅读

重要说明：

  • 由于潜在的安全问题，某些类型的文件会受到 Outlook 阻止，并且不会返回。 有关详细信息，请参阅 Outlook 中阻止的附件。

  • 使用 “上传并共享 ”选项添加的附件将不返回。

body

获取物品的正文及其格式。

body: Body;

属性值

Office.Body

注解

API 集：邮箱 1.1

最低权限级别： 读取项目

适用的 Outlook 模式：消息阅读

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

categories

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

categories: Categories;

属性值

Office.Categories

注解

API 集：邮箱 1.8

最低权限级别： 读取项目

适用的 Outlook 模式：消息阅读

cc

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

该cc属性返回的数组包含邮件抄送行上列出的每个收件人的 EmailAddressDetails 对象。 返回的最大收件人数因 Outlook 客户端而异。

  • Windows (经典) ：500 名收件人

  • Windows (经典 - 从版本 2511 开始处于预览状态 (内部版本 19426.20000) ) ：1,000 名收件人

  • Web 浏览器，Windows (新) ：折叠视图) (20 个收件人，展开视图) (500 个收件人

cc: EmailAddressDetails[];

属性值

Office.EmailAddressDetails[]

注解

最低权限级别： 读取项目

适用的 Outlook 模式：消息阅读

conversationId

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

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

conversationId: string;

属性值

string

注解

最低权限级别： 读取项目

适用的 Outlook 模式：消息阅读

dateTimeCreated

获取项目创建的日期和时间。

dateTimeCreated: Date;

属性值

Date

注解

最低权限级别： 读取项目

适用的 Outlook 模式：消息阅读

dateTimeModified

获取项目最近一次修改的日期和时间。

dateTimeModified: Date;

属性值

Date

注解

API 集：邮箱 1.1

最低权限级别： 读取项目

适用的 Outlook 模式：约会与会者

重要提示： Android 或 iOS 上的 Outlook 不支持此属性。 有关 Outlook 移动版中支持的 API 的详细信息，请参阅移动设备上的 Outlook 支持的 Outlook JavaScript API。

end

获取约会结束的日期和时间。

该 end 属性是一个 Date 对象，表示为协调世界时 (UTC) 日期和时间值。 可以使用该 convertToLocalClientTime 方法将属性值转换为 end 客户端的本地日期和时间。

使用 Time.setAsync 方法设置结束时间时，应使用 convertToUtcClientTime 方法将客户端的本地时间转换为服务器的 UTC。

end: Date;

属性值

Date

注解

最低权限级别： 读取项目

适用的 Outlook 模式：消息阅读

from

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

该 from 属性返回一个 EmailAddressDetails 对象。

from: EmailAddressDetails;

属性值

Office.EmailAddressDetails

注解

最低权限级别： 读取项目

适用的 Outlook 模式：消息阅读

重要说明：

  • and 属性代表同一个人，除非消息是由具有“代表发送”权限的代理发送的。senderfrom 在这种情况下， from 该属性返回邮箱所有者或共享邮箱的电子邮件地址，该 sender 属性返回代理的地址。 如果代理同时具有 “代表发送” 和“ 发送方式 ”权限，则将应用 “发送方式” 权限。 有关邮箱委派的信息，请参阅 在 Exchange Online 中管理收件人的权限。

  • recipientType属性中from对象EmailAddressDetails的属性未定义。

internetMessageId

获取消息的 Internet 消息标识符。

internetMessageId: string;

属性值

string

注解

最低权限级别： 读取项目

适用的 Outlook 模式：消息阅读

【重要事项】在 “已发送邮件” 文件夹中，最近 internetMessageId 发送的邮件可能尚不可用。 在这种情况下，请考虑使用以下选项之一，具体取决于你的 Exchange 环境。

itemClass

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

itemClass: string;

属性值

string

注解

最低权限级别： 读取项目

适用的 Outlook 模式：消息阅读

重要说明：

下表列出了消息的默认项类。

项目类 说明
IPM。备注 新邮件和消息答复
IPM.Schedule.Meeting.Request 会议请求
IPM.Schedule.Meeting.Canceled 会议取消
IPM。Schedule.Meeting.Resp.Neg 响应以拒绝会议要求
IPM。Schedule.Meeting.Resp.Pos 接受会议请求的响应
IPM。Schedule.Meeting.Resp.Tent 响应以暂时接受会议要求

可以创建扩展默认物品类的自定义类。 例如， IPM.Note.Contoso.

itemId

获取当前项的 Exchange Web 服务项标识符 。

itemId: string;

属性值

string

注解

最低权限级别： 读取项目

适用的 Outlook 模式：消息阅读

重要说明：

  • 该 itemId 属性在撰写模式下不可用。 如果需要项目标识符，Office.context.mailbox.item.saveAsync 方法可用于将项目保存到存储，这将在回调函数的 asyncResult.value 参数中返回项目标识符。 如果已保存该项，可以改为调用 Office.context.mailbox.item.getItemIdAsync 该方法。

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

itemType

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

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

itemType: MailboxEnums.ItemType | string;

属性值

Office.MailboxEnums.ItemType | string

注解

最低权限级别： 读取项目

适用的 Outlook 模式：消息阅读

location

获取会议请求的位置。

location 属性返回一个包含约会位置的字符串。

location: string;

属性值

string

注解

最低权限级别： 读取项目

适用的 Outlook 模式：消息阅读

normalizedSubject

获取项目的主题，删除 (所有前缀，包括 RE： 和 FWD：) 。

normalizedSubject该属性获取项目的主题，以及电子邮件程序添加的任何标准前缀 (，例如 RE： 和 FW：) 。 若要获取包含完整前缀的项目主题，请使用 subject 属性。

normalizedSubject: string;

属性值

string

注解

最低权限级别： 读取项目

适用的 Outlook 模式：消息阅读

notificationMessages

获取项目的通知消息。

notificationMessages: NotificationMessages;

属性值

Office.NotificationMessages

注解

API 集：邮箱 1.3

最低权限级别： 读取项目

适用的 Outlook 模式：消息阅读

重要说明：

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

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

recurrence

获取约会的重复周期模式。 获取会议请求的重复周期模式。 约会项目的读取和撰写模式。 会议请求项目的读取模式。

recurrence如果项目是系列或系列中的实例，则该属性返回Recurrence定期约会或会议请求的对象。 null 为单个约会和单个约会的会议请求返回。 undefined 为非会议请求的邮件返回。

recurrence: Recurrence;

属性值

Office.Recurrence

注解

API 集：邮箱 1.7

最低权限级别： 读取项目

适用的 Outlook 模式：消息阅读

重要说明：

  • 会议请求的 itemClass 值为 IPM.Schedule.Meeting.Request。

  • 如果对象为 null，则 recurrence 指示对象是单个约会或单个约会的会议请求， 而不是 系列的一部分。

  • 仅支持 Recurrence 对象的属性和 getAsync 方法。

sender

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

sender: EmailAddressDetails;

属性值

Office.EmailAddressDetails

注解

最低权限级别： 读取项目

适用的 Outlook 模式：消息阅读

重要说明：

  • and 属性代表同一个人，除非消息是由具有“代表发送”权限的代理发送的。senderfrom 在这种情况下， from 该属性返回邮箱所有者或共享邮箱的电子邮件地址，该 sender 属性返回代理的地址。 如果代理同时具有 “代表发送” 和“ 发送方式 ”权限，则将应用 “发送方式” 权限。 有关邮箱委派的信息，请参阅 在 Exchange Online 中管理收件人的权限。

  • recipientType属性中sender对象EmailAddressDetails的属性未定义。

seriesId

获取实例所属系列的 ID。

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

seriesId: string;

属性值

string

注解

API 集：邮箱 1.7

最低权限级别： 读取项目

适用的 Outlook 模式：消息阅读

重要说明：

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

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

start

获取约会开始的日期和时间。

该 start 属性是一个 Date 对象，表示为协调世界时 (UTC) 日期和时间值。 可以使用该 convertToLocalClientTime 方法将值转换为客户端的本地日期和时间。

start: Date;

属性值

Date

注解

最低权限级别： 读取项目

适用的 Outlook 模式：消息阅读

subject

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

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

subject 属性返回一个字符串。 使用该 normalizedSubject 属性获取主题减去任何前导前缀，例如 RE： 和 FW：。

subject: string;

属性值

string

注解

最低权限级别： 读取项目

适用的 Outlook 模式：消息阅读

to

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

该to属性返回的数组包含邮件“收件人”行上列出的每个收件人的 EmailAddressDetails 对象。 返回的最大收件人数因 Outlook 客户端而异。

  • Windows (经典) ：500 名收件人

  • Windows (经典 - 从版本 2511 开始处于预览状态 (内部版本 19426.20000) ) ：1,000 名收件人

  • Web 浏览器，Windows (新) ：折叠视图) (20 个收件人，展开视图) (500 个收件人

to: EmailAddressDetails[];

属性值

Office.EmailAddressDetails[]

注解

最低权限级别： 读取项目

适用的 Outlook 模式：消息阅读

方法详细信息

displayReplyAllFormAsync(formData, options, callback)

显示一个回复表单，该表单包括所选邮件的发件人和所有收件人，或者包括所选约会的组织者和所有与会者。

displayReplyAllFormAsync(formData: string | ReplyFormData, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

参数

formData

string | Office.ReplyFormData

一个包含文本和 HTML 且表示答复窗体的正文的字符串。 字符串限制为 32 KB，或者是包含正文或附件数据和回调函数的 ReplyFormData 对象。

options
Office.AsyncContextOptions

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

callback

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

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

返回

void

注解

API 集：邮箱 1.9

最低权限级别： 读取项目

适用的 Outlook 模式：消息阅读

重要说明：

  • 在 Outlook 网页版和新的 Windows 版 Outlook 中，回复表单在 3 列视图中显示为弹出表单，在 2 列或 1 列视图中显示为弹出表单。

  • 如果任意字符串参数超出其限制，displayReplyAllFormAsync 将引发异常。

  • 在参数中 formData.attachments 指定附件时，Outlook 会尝试下载所有附件并将其附加到回复表单。 如果无法添加任何附件，则在窗体 UI 中显示错误。 如果这不可能，则不引发错误消息。

displayReplyAllFormAsync(formData, callback)

显示一个回复表单，该表单包括所选邮件的发件人和所有收件人，或者包括所选约会的组织者和所有与会者。

displayReplyAllFormAsync(formData: string | ReplyFormData, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

参数

formData

string | Office.ReplyFormData

一个包含文本和 HTML 且表示答复窗体的正文的字符串。 字符串限制为 32 KB，或者是包含正文或附件数据和回调函数的 ReplyFormData 对象。

callback

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

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

返回

void

注解

API 集：邮箱 1.9

最低权限级别： 读取项目

适用的 Outlook 模式：消息阅读

重要说明：

  • 在 Outlook 网页版和新的 Windows 版 Outlook 中，回复表单在 3 列视图中显示为弹出表单，在 2 列或 1 列视图中显示为弹出表单。

  • 如果任意字符串参数超出其限制，displayReplyAllFormAsync 将引发异常。

  • 在参数中 formData.attachments 指定附件时，Outlook 会尝试下载所有附件并将其附加到回复表单。 如果无法添加任何附件，则在窗体 UI 中显示错误。 如果这不可能，则不引发错误消息。

displayReplyFormAsync(formData, options, callback)

显示答复窗体，其中仅包括所选邮件的发件人或所选约会的组织者。

displayReplyFormAsync(formData: string | ReplyFormData, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

参数

formData

string | Office.ReplyFormData

一个包含文本和 HTML 且表示答复窗体的正文的字符串。 字符串限制为 32 KB，或者是包含正文或附件数据和回调函数的 ReplyFormData 对象。

options
Office.AsyncContextOptions

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

callback

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

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

返回

void

注解

API 集：邮箱 1.9

最低权限级别： 读取项目

适用的 Outlook 模式：消息阅读

重要说明：

  • 在 Outlook 网页版和新的 Windows 版 Outlook 中，回复表单在 3 列视图中显示为弹出表单，在 2 列或 1 列视图中显示为弹出表单。

  • 如果任意字符串参数超出其限制，displayReplyFormAsync 将引发异常。

  • 在参数中 formData.attachments 指定附件时，Outlook 会尝试下载所有附件并将其附加到回复表单。 如果无法添加任何附件，则在窗体 UI 中显示错误。 如果这不可能，则不引发错误消息。

displayReplyFormAsync(formData, callback)

显示答复窗体，其中仅包括所选邮件的发件人或所选约会的组织者。

displayReplyFormAsync(formData: string | ReplyFormData, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

参数

formData

string | Office.ReplyFormData

一个包含文本和 HTML 且表示答复窗体的正文的字符串。 字符串限制为 32 KB，或者是包含正文或附件数据和回调函数的 ReplyFormData 对象。

callback

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

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

返回

void

注解

API 集：邮箱 1.9

最低权限级别： 读取项目

适用的 Outlook 模式：消息阅读

重要说明：

  • 在 Outlook 网页版和新的 Windows 版 Outlook 中，回复表单在 3 列视图中显示为弹出表单，在 2 列或 1 列视图中显示为弹出表单。

  • 如果任意字符串参数超出其限制，displayReplyFormAsync 将引发异常。

  • 在参数中 formData.attachments 指定附件时，Outlook 会尝试下载所有附件并将其附加到回复表单。 如果无法添加任何附件，则在窗体 UI 中显示错误。 如果这不可能，则不引发错误消息。

getAllInternetHeadersAsync(options, callback)

以字符串形式获取消息的所有 Internet 标头。

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

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

参数

options
Office.AsyncContextOptions

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

callback

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

可选。 当该方法完成时，将使用单个参数（一个对象）asyncResultOffice.AsyncResult调用传入参数的callback函数。 成功后，Internet 标头数据将以字符串形式在属性中 asyncResult.value 提供。 有关返回的字符串值的格式信息，请参阅 RFC 2183 。 如果调用失败， asyncResult.error 属性将包含一个错误代码以及失败的原因。

返回

void

注解

API 集：邮箱 1.8

最低权限级别： 读取项目

适用的 Outlook 模式：消息阅读

getAllInternetHeadersAsync(callback)

以字符串形式获取消息的所有 Internet 标头。

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

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

参数

callback

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

可选。 当该方法完成时，将使用单个参数（一个对象）asyncResultOffice.AsyncResult调用传入参数的callback函数。 成功后，Internet 标头数据将以字符串形式在属性中 asyncResult.value 提供。 有关返回的字符串值的格式信息，请参阅 RFC 2183 。 如果调用失败， asyncResult.error 属性将包含一个错误代码以及失败的原因。

返回

void

注解

API 集：邮箱 1.8

最低权限级别： 读取项目

适用的 Outlook 模式：消息阅读

getAsFileAsync(options, callback)

获取以 Base64 编码的 EML 格式的当前消息。

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

参数

options
Office.AsyncContextOptions

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

callback

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

该方法完成后，将使用单个参数（一个对象）asyncResultOffice.AsyncResult调用传入回调参数的函数。 在属性中 asyncResult.value 返回消息的 Base64 编码的 EML 格式。 遇到的任何错误都会在属性中 asyncResult.error 返回。

返回

void

注解

API 集：邮箱 1.14

最低权限级别： 读取项目

适用的 Outlook 模式：消息阅读

getAsFileAsync(callback)

获取以 Base64 编码的 EML 格式的当前消息。

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

参数

callback

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

该方法完成后，将使用单个参数（一个对象）asyncResultOffice.AsyncResult调用传入回调参数的函数。 在属性中 asyncResult.value 返回消息的 Base64 编码的 EML 格式。 遇到的任何错误都会在属性中 asyncResult.error 返回。

返回

void

注解

API 集：邮箱 1.14

最低权限级别： 读取项目

适用的 Outlook 模式：消息阅读

getAttachmentContentAsync(attachmentId, options, callback)

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

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

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

返回

void

注解

API 集：邮箱 1.8

最低权限级别： 读取项目

适用的 Outlook 模式：消息阅读

重要说明：

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

  • 在 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

要获取的附件的标识符。

callback

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

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

返回

void

注解

API 集：邮箱 1.8

最低权限级别： 读取项目

适用的 Outlook 模式：消息阅读

重要说明：

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

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

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

错误：

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

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

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 模式：消息阅读

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 模式：消息阅读

getRegExMatches()

返回所选项目中与 XML 清单文件中定义的正则表达式匹配的字符串值。

getRegExMatches(): any;

返回

any

一个包含匹配在清单 XML 文件中定义的正则表达式的字符串数组的对象。 每个数组的名称等于匹配 ItemHasRegularExpressionMatch 规则的 RegExName 属性或 FilterName 匹配 ItemHasKnownEntity 规则的属性的相应值。 对于 ItemHasRegularExpressionMatch 规则，匹配字符串必须发生在该规则指定的项目的属性中。 简单类型定义支持的属性。

注解

API 集：邮箱 1.1

最低权限级别： 读取项目

适用的 Outlook 模式：约会与会者

重要说明：

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

  • 此方法与 Outlook 加载项的激活规则功能一起使用， Microsoft 365 统一清单不支持该功能。

  • 如果在项的 body 属性上指定 ItemHasRegularExpressionMatch 规则，则正则表达式应进一步筛选正文，并且不应尝试返回项的整个正文。 使用正则表达式（例如 .* 获取项的整个正文）并不总是返回预期的结果。 而是使用 Body.getAsync 方法检索整个正文。

getRegExMatchesByName(name)

返回所选项目中与 XML 清单文件中定义的命名正则表达式匹配的字符串值。

getRegExMatchesByName(name: string): string[];

参数

name

string

定义筛选器匹配的 ItemHasRegularExpressionMatch 规则元素的名称。

返回

string[]

一个数组，其中包含与清单 XML 文件中的规则元素中 ItemHasRegularExpressionMatch 定义的正则表达式匹配的字符串，并具有指定的 RegExName 元素值。

注解

API 集：邮箱 1.1

最低权限级别： 读取项目

适用的 Outlook 模式：约会与会者

重要说明：

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

  • 此方法与 Outlook 加载项的激活规则功能一起使用， Microsoft 365 统一清单不支持该功能。

  • 如果在项的 body 属性上指定 ItemHasRegularExpressionMatch 规则，则正则表达式应进一步筛选正文，并且不应尝试返回项的整个正文。 使用正则表达式（例如 .* 获取项的整个正文）并不总是返回预期的结果。 而是使用 Body.getAsync 方法检索整个正文。

getSelectedRegExMatches()

在突出显示的匹配项中返回与 XML 清单文件中定义的正则表达式匹配的字符串值。 突出显示的匹配项适用于上下文外接程序。

getSelectedRegExMatches(): any;

返回

any

一个包含匹配在清单 XML 文件中定义的正则表达式的字符串数组的对象。 每个数组的名称等于匹配 RegExName 规则的 ItemHasRegularExpressionMatch 属性或匹配 FilterName 规则的 ItemHasKnownEntity 属性的相应值。 对于 ItemHasRegularExpressionMatch 规则，匹配字符串必须发生在该规则指定的项目的属性中。 简单类型定义支持的属性。

注解

API 集：邮箱 1.6

最低权限级别： 读取项目

适用的 Outlook 模式：消息阅读

重要说明：

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

  • 此方法与 Outlook 加载项的激活规则功能一起使用， Microsoft 365 统一清单不支持该功能。

  • 如果在项的 body 属性上指定 ItemHasRegularExpressionMatch 规则，则正则表达式应进一步筛选正文，并且不应尝试返回项的整个正文。 使用正则表达式（如 .*）获取项目的整个正文并不总是返回预期的结果。 而是使用 Body.getAsync 方法检索整个正文。

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 模式：消息阅读

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 模式：消息阅读

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 模式：消息阅读

重要提示：仅 get 支持 CustomProperties 对象的 and getAll 方法。

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 另一个选定项之前必须执行此操作。