Office.MessageRead interface

包:: outlook

重要说明：

这是一个内部 Outlook 对象，不直接通过现有接口公开。应将其视为的 Office.context.mailbox.item模式。有关详细信息，请参阅 “对象模型 ”页。
在邮件上调用 Office.context.mailbox.item 时，请注意，必须打开 Outlook 客户端中的阅读窗格。有关如何配置阅读窗格的指南，请参阅使用和配置阅读窗格预览邮件。

父接口：

扩展: Office.Message

注解

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/40-attachments/get-attachments-read.yaml

const item = Office.context.mailbox.item;

if (item.attachments.length > 0) {
    for (let i = 0; i < item.attachments.length; i++) {
        const attachment = item.attachments[i];
        console.log(`${i+1}. Name: ${attachment.name}`);
        console.log(`ID: ${attachment.id}`);
        console.log(`Type: ${attachment.attachmentType}`);
        console.log(`Inline content: ${attachment.isInline}`);
        console.log(`Size: ${attachment.size}`);
    }
} else {
    console.log("This mail item doesn't contain any attachments.");
}

属性

attachments	获取项的附件作为数组。
body	获取一个提供用于处理项目正文的方法的对象。
cc	提供对邮件的抄送 (Cc) 收件人的访问权限。对象的类型和访问级别取决于当前项的模式。属性`cc`返回一个数组，该数组包含邮件抄送行中列出的每个收件人的 EmailAddressDetails 对象。返回的最大收件人数因 Outlook 客户端而异。经典 Windows：500 个收件人 Android、经典 Mac UI、iOS：100 个收件人 Web 浏览器，新 Outlook：20 个收件人 (折叠视图) ,500 个收件人 (展开视图) 新 Mac UI：无限制
conversationId	获取包含特定消息的电子邮件会话的标识符。如果在阅读窗体或撰写窗体的回复中激活邮件应用程序，则此属性可以获得一个整数值。如果用户随后更改了回复邮件的主题（若发送回复），则该邮件的对话 ID 将改变且之前获取的值将不适用。对于撰写窗体的新项目，此属性获得一个 null 值。如果用户设置一个主题并保存该项目，`conversationId` 属性将返回一个值。
dateTimeCreated	获取项目创建的日期和时间。
dateTimeModified	获取项目最近一次修改的日期和时间。
end	获取约会结束的日期和时间。属性 `end` 是表示 `Date` 为协调世界时 (UTC) 日期和时间值的对象。可以使用 `convertToLocalClientTime` 方法将 `end` 属性值转换为客户端的本地日期和时间。使用 `Time.setAsync` 方法设置结束时间时，应使用 `convertToUtcClientTime` 方法将客户端的本地时间转换为服务器的 UTC。
from	获取邮件发件人的电子邮件地址。 `from` 和 `sender` 属性表示同一个人，邮件由代理人发送的除外。在这种情况下， `from` 属性表示委托器，属性 `sender` 表示委托。注意：属性`recipientTypeEmailAddressDetails`中 `from` 对象的属性未定义。属性 `from` 返回对象 `EmailAddressDetails` 。
internetMessageId	获取电子邮件的 Internet 消息标识符。重要提示：在 “已发送邮件” 文件夹中， `internetMessageId` 最近发送的项目可能尚不可用。在这种情况下，请考虑使用 Exchange Web Services 从服务器获取此属性。
itemClass	获取所选邮件的 Exchange Web Services 项类。
itemId	获取当前项目的 Exchange Web Services (EWS) 项标识符。
itemType	获取实例表示的项的类型。属性 `itemType` 返回枚举值之 `ItemType` 一，指示项目对象实例是消息还是约会。
location	获取会议请求的位置。 `location` 属性返回一个包含约会位置的字符串。
normalizedSubject	获取项目的主题，删除所有前缀 (包括 RE：和 FWD：) 。属性 `normalizedSubject` 获取项目的主题，其中包含电子邮件程序添加的任何标准前缀 (如 RE：和 FW：) 。若要获取包含完整前缀的项目主题，请使用 `subject` 属性。
notificationMessages	获取项目的通知邮件。
sender	获取电子邮件发件人的电子邮件地址。 `from` 和 `sender` 属性表示同一个人，邮件由代理人发送的除外。在这种情况下， `from` 属性表示委托器，属性 `sender` 表示委托。注意：属性`recipientTypeEmailAddressDetails`中 `sender` 对象的属性未定义。
start	获取约会开始的日期和时间。属性 `start` 是表示 `Date` 为协调世界时 (UTC) 日期和时间值的对象。可以使用 `convertToLocalClientTime` 方法将值转换为客户端的本地日期和时间。
subject	获取在项的主题字段中显示的说明。 `subject` 属性获取或设置由电子邮件服务器发送项目时的整个主题。 `subject` 属性返回一个字符串。 `normalizedSubject`使用属性获取主题减去任何前导前缀，例如 RE：和 FW：。
to	提供对邮件的“收件人”行上的收件人的访问权限。对象的类型和访问级别取决于当前项的模式。属性`to`返回一个数组，该数组包含邮件的“收件人”行中列出的每个收件人的 EmailAddressDetails 对象。返回的最大收件人数因 Outlook 客户端而异。经典 Windows：500 个收件人 Android、经典 Mac UI、iOS：100 个收件人 Web 浏览器，新 Outlook：20 个收件人 (折叠视图) ,500 个收件人 (展开视图) 新 Mac UI：无限制

方法

displayReplyAllForm(formData)	显示一个答复表单，其中包括所选邮件的发件人和所有收件人或组织者以及所选约会的所有与会者。
displayReplyForm(formData)	显示答复窗体，其中仅包括所选邮件的发件人或所选约会的组织者。
getEntities()	获取在所选项目的正文中找到的实体。警告：基于实体的上下文 Outlook 加载项现已停用。但是，仍支持正则表达式规则。建议更新上下文加载项，以使用正则表达式规则作为替代解决方案。有关如何实现这些规则的指南，请参阅上下文 Outlook 加载项。
getEntitiesByType(entityType)	获取所选项目的正文中找到的指定实体类型的所有实体的数组。警告：基于实体的上下文 Outlook 加载项现已停用。但是，仍支持正则表达式规则。建议更新上下文加载项，以使用正则表达式规则作为替代解决方案。有关如何实现这些规则的指南，请参阅上下文 Outlook 加载项。
getFilteredEntitiesByName(name)	返回所选项中的已知实体，这些实体通过仅外接程序清单文件中定义的命名筛选器。警告：基于实体的上下文 Outlook 加载项现已停用。但是，仍支持正则表达式规则。建议更新上下文加载项，以使用正则表达式规则作为替代解决方案。有关如何实现这些规则的指南，请参阅上下文 Outlook 加载项。
getRegExMatches()	返回所选项中与仅外接程序清单文件中定义的正则表达式匹配的字符串值。
getRegExMatchesByName(name)	返回所选项中与仅外接程序清单文件中定义的命名正则表达式匹配的字符串值。
loadCustomPropertiesAsync(callback, userContext)	异步加载所选项目上此外接程序的自定义属性。自定义属性以键值对的形式存储在每个应用、每个项目的基础上。此方法在回调中返回 CustomProperties 对象，该对象提供访问特定于当前项和当前加载项的自定义属性的方法。自定义属性不会对项进行加密，因此不应将其用作安全存储。自定义属性作为 `asyncResult.value` 属性中的 `CustomProperties` 对象提供。此对象可用于从邮件项获取、设置、保存和删除自定义属性。

属性详细信息

attachments

获取项的附件作为数组。

attachments: AttachmentDetails[];

属性值

Office.AttachmentDetails[]

注解

最低权限级别： 读取项

适用的 Outlook 模式：邮件读取

重要说明：

由于潜在的安全问题，某些类型的文件会受到 Outlook 阻止，并且不会返回。有关详细信息，请参阅 Outlook 中阻止的附件。
不会返回使用 “上传和共享 ”选项添加的附件。

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/40-attachments/get-attachments-read.yaml

const item = Office.context.mailbox.item;

if (item.attachments.length > 0) {
    for (let i = 0; i < item.attachments.length; i++) {
        const attachment = item.attachments[i];
        console.log(`${i+1}. Name: ${attachment.name}`);
        console.log(`ID: ${attachment.id}`);
        console.log(`Type: ${attachment.attachmentType}`);
        console.log(`Inline content: ${attachment.isInline}`);
        console.log(`Size: ${attachment.size}`);
    }
} else {
    console.log("This mail item doesn't contain any attachments.");
}

body

获取一个提供用于处理项目正文的方法的对象。

body: Body;

属性值

Office.Body

注解

[ API set： Mailbox 1.1 ]

最低权限级别： 读取项

适用的 Outlook 模式：邮件读取

示例

// This example gets the body of the item as plain text.
Office.context.mailbox.item.body.getAsync(
    "text",
    { asyncContext: "This is passed to the callback" },
    function callback(result) {
        // Do something with the result.
    });

// The following is an example of the result parameter passed to the callback function.
{
    "value": "TEXT of whole body (including threads below)",
    "status": "succeeded",
    "asyncContext": "This is passed to the callback"
}

cc

提供对邮件的抄送 (Cc) 收件人的访问权限。对象的类型和访问级别取决于当前项的模式。

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

经典 Windows：500 个收件人
Android、经典 Mac UI、iOS：100 个收件人
Web 浏览器，新 Outlook：20 个收件人 (折叠视图) ,500 个收件人 (展开视图)
新 Mac UI：无限制

cc: EmailAddressDetails[];

属性值

Office.EmailAddressDetails[]

注解

最低权限级别： 读取项

适用的 Outlook 模式：邮件读取

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-cc-message-read.yaml

const msgCc = Office.context.mailbox.item.cc;
console.log("Message copied to:");
for (let i = 0; i < msgCc.length; i++) {
  console.log(msgCc[i].displayName + " (" + msgCc[i].emailAddress + ")");
}

conversationId

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

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

对于撰写窗体的新项目，此属性获得一个 null 值。如果用户设置一个主题并保存该项目，conversationId 属性将返回一个值。

conversationId: string;

属性值

string

注解

最低权限级别： 读取项

适用的 Outlook 模式：邮件读取

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-conversation-id-message.yaml

console.log(`Conversation ID: ${Office.context.mailbox.item.conversationId}`);

dateTimeCreated

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

dateTimeCreated: Date;

属性值

Date

注解

最低权限级别： 读取项

适用的 Outlook 模式：邮件读取

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-date-time-created-read.yaml

console.log(`Creation date and time: ${Office.context.mailbox.item.dateTimeCreated}`);

dateTimeModified

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

dateTimeModified: Date;

属性值

Date

注解

[ API set： Mailbox 1.1 ]

最低权限级别： 读取项

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

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

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-date-time-modified-read.yaml

console.log(`Date and time item last modified: ${Office.context.mailbox.item.dateTimeModified}`);

end

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

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

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

end: Date;

属性值

Date

注解

最低权限级别： 读取项

适用的 Outlook 模式：邮件读取

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-end-read.yaml

const time = Office.context.mailbox.item.end;
const localTime = Office.context.mailbox.convertToLocalClientTime(time);
console.log(`Appointment ends (local): ${localTime.month + 1}/${localTime.date}/${localTime.year}, ${localTime.hours}:${localTime.minutes}:${localTime.seconds}`);

from

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

from 和 sender 属性表示同一个人，邮件由代理人发送的除外。在这种情况下， from 属性表示委托器，属性 sender 表示委托。

注意：属性recipientTypeEmailAddressDetails中 from 对象的属性未定义。

属性 from 返回对象 EmailAddressDetails 。

from: EmailAddressDetails;

属性值

Office.EmailAddressDetails

注解

最低权限级别： 读取项

适用的 Outlook 模式：邮件读取

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-from-message-read.yaml

const msgFrom = Office.context.mailbox.item.from;
console.log("Message received from: " + msgFrom.displayName + " (" + msgFrom.emailAddress + ")");

internetMessageId

获取电子邮件的 Internet 消息标识符。

重要提示：在 “已发送邮件” 文件夹中， internetMessageId 最近发送的项目可能尚不可用。在这种情况下，请考虑使用 Exchange Web Services 从服务器获取此属性。

internetMessageId: string;

属性值

string

注解

最低权限级别： 读取项

适用的 Outlook 模式：邮件读取

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-internet-message-id-read.yaml

console.log(`Internet message ID: ${Office.context.mailbox.item.internetMessageId}`);

itemClass

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

itemClass: string;

属性值

string

注解

最低权限级别： 读取项

适用的 Outlook 模式：邮件读取

重要说明：

下表列出了邮件的默认项类。

Item 类	说明
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。

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-item-class-read.yaml

console.log(`Item class: ${Office.context.mailbox.item.itemClass}`);

itemId

获取当前项目的 Exchange Web Services (EWS) 项标识符。

itemId: string;

属性值

string

注解

最低权限级别： 读取项

适用的 Outlook 模式：邮件读取

重要说明：

属性 itemId 在撰写模式下不可用。如果需要项目标识符，Office.context.mailbox.item.saveAsync 方法可用于将项目保存到存储，这将在回调函数的 asyncResult.value 参数中返回项目标识符。如果项已保存，可以改为调用 Office.context.mailbox.item.getItemIdAsync 方法。
返回的项目 ID 与 Outlook 条目 ID 或 Outlook REST API 使用的 ID 不同。在使用此值进行 REST API 调用之前，应使用 Office.context.mailbox.convertToRestId进行转换。

示例

// The following code checks for the presence of an item
// identifier. If the `itemId` property returns `null` or
// `undefined`, it saves the item to the store and gets the
// item identifier from the asynchronous result.
// **Important**: `saveAsync` was introduced with requirement set 1.3
// so you can't get the `itemId` in Compose mode in earlier sets.
let itemId = Office.context.mailbox.item.itemId;
if (itemId === null || itemId == undefined) {
    Office.context.mailbox.item.saveAsync(function(result) {
        itemId = result.value;
    });
}

itemType

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

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

itemType: MailboxEnums.ItemType | string;

属性值

Office.MailboxEnums.ItemType | string

注解

最低权限级别： 读取项

适用的 Outlook 模式：邮件读取

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-item-type.yaml

const itemType = Office.context.mailbox.item.itemType;
switch (itemType) {
    case Office.MailboxEnums.ItemType.Appointment:
        console.log(`Current item is an ${itemType}.`);
        break;
    case Office.MailboxEnums.ItemType.Message:
        console.log(`Current item is a ${itemType}. A message could be an email, meeting request, meeting response, or meeting cancellation.`);
        break;
}

location

获取会议请求的位置。

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

location: string;

属性值

string

注解

最低权限级别： 读取项

适用的 Outlook 模式：邮件读取

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-location-read.yaml

console.log(`Appointment location: ${Office.context.mailbox.item.location}`);

normalizedSubject

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

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

normalizedSubject: string;

属性值

string

注解

最低权限级别： 读取项

适用的 Outlook 模式：邮件读取

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-normalized-subject-read.yaml

console.log(`Normalized subject: ${Office.context.mailbox.item.normalizedSubject}`);

notificationMessages

获取项目的通知邮件。

notificationMessages: NotificationMessages;

属性值

Office.NotificationMessages

注解

[ API 集：邮箱 1.3 ]

最低权限级别： 读取项

适用的 Outlook 模式：邮件读取

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

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/35-notifications/add-getall-remove.yaml

// Adds a progress indicator to the mail item.
const id = (document.getElementById("notificationId") as HTMLInputElement).value;
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.ProgressIndicator,
    message: "Progress indicator with id = " + id
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);

...

// Adds an informational notification to the mail item.
const id = (document.getElementById("notificationId") as HTMLInputElement).value;
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Non-persistent informational notification message with id = " + id,
    icon: "PG.Icon.16",
    persistent: false
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);

...

// Adds a persistent information notification to the mail item.
const id = (document.getElementById("notificationId") as HTMLInputElement).value;
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Persistent informational notification message with id = " + id,
    icon: "PG.Icon.16",
    persistent: true
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);

...

// Gets all the notification messages and their keys for the current mail item.
Office.context.mailbox.item.notificationMessages.getAllAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log(asyncResult.error.message);
    return;
  }

  console.log(asyncResult.value);
});

...

// Replaces a notification message of a given key with another message.
const id = (document.getElementById("notificationId") as HTMLInputElement).value;
Office.context.mailbox.item.notificationMessages.replaceAsync(
  id,
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Notification message with id = " + id + " has been replaced with an informational message.",
    icon: "icon2",
    persistent: false
  },
  handleResult);

...

// Removes a notification message from the current mail item.
const id = (document.getElementById("notificationId") as HTMLInputElement).value;
Office.context.mailbox.item.notificationMessages.removeAsync(id, handleResult);

sender

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

from 和 sender 属性表示同一个人，邮件由代理人发送的除外。在这种情况下， from 属性表示委托器，属性 sender 表示委托。

注意：属性recipientTypeEmailAddressDetails中 sender 对象的属性未定义。

sender: EmailAddressDetails;

属性值

Office.EmailAddressDetails

注解

最低权限级别： 读取项

适用的 Outlook 模式：邮件读取

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-sender-message-read.yaml

const msgSender = Office.context.mailbox.item.sender;
console.log("Sender: " + msgSender.displayName + " (" + msgSender.emailAddress + ")");

start

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

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

start: Date;

属性值

Date

注解

最低权限级别： 读取项

适用的 Outlook 模式：邮件读取

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-start-read.yaml

const time = Office.context.mailbox.item.start;
const localTime = Office.context.mailbox.convertToLocalClientTime(time);
console.log(`Appointment starts (local): ${localTime.month + 1}/${localTime.date}/${localTime.year}, ${localTime.hours}:${localTime.minutes}:${localTime.seconds}`);

subject

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

subject 属性获取或设置由电子邮件服务器发送项目时的整个主题。

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

subject: string;

属性值

string

注解

最低权限级别： 读取项

适用的 Outlook 模式：邮件读取

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-subject-read.yaml

console.log(`Subject: ${Office.context.mailbox.item.subject}`);

to

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

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

经典 Windows：500 个收件人
Android、经典 Mac UI、iOS：100 个收件人
Web 浏览器，新 Outlook：20 个收件人 (折叠视图) ,500 个收件人 (展开视图)
新 Mac UI：无限制

to: EmailAddressDetails[];

属性值

Office.EmailAddressDetails[]

注解

最低权限级别： 读取项

适用的 Outlook 模式：邮件读取

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-to-message-read.yaml

const msgTo = Office.context.mailbox.item.to;
const distributionLists = [];
const externalRecipients = [];
const internalRecipients = [];
const otherRecipients = [];
for (let i = 0; i < msgTo.length; i++) {
    switch (msgTo[i].recipientType) {
    case Office.MailboxEnums.RecipientType.DistributionList:
        distributionLists.push(msgTo[i]);
        break;
    case Office.MailboxEnums.RecipientType.ExternalUser:
        externalRecipients.push(msgTo[i]);
        break;
    case Office.MailboxEnums.RecipientType.User:
        internalRecipients.push(msgTo[i]);
        break;
    case Office.MailboxEnums.RecipientType.Other:
        otherRecipients.push(msgTo[i]);
    }
}

if (distributionLists.length > 0) {
    console.log("Distribution Lists:");
    distributionLists.forEach((recipient) => console.log(`${recipient.displayName}, ${recipient.emailAddress}`));
}

if (externalRecipients.length > 0) {
    console.log("External Recipients:");
    externalRecipients.forEach((recipient) => console.log(`${recipient.displayName}, ${recipient.emailAddress}`));
}

if (internalRecipients.length > 0) {
    console.log("Internal Recipients:");
    internalRecipients.forEach((recipient) => console.log(`${recipient.displayName}, ${recipient.emailAddress}`));
}

if (otherRecipients.length > 0) {
    console.log("Other Recipients:");
    otherRecipients.forEach((recipient) => console.log(`${recipient.displayName}, ${recipient.emailAddress}`));
}

方法详细信息

displayReplyAllForm(formData)

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

displayReplyAllForm(formData: string | ReplyFormData): void;

参数

formData: string | Office.ReplyFormData

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

void

注解

[ API set： Mailbox 1.1 ]

最低权限级别： 读取项

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

重要说明：

在Outlook 网页版和新的 Outlook on Windows 中，答复窗体在 3 列视图中显示为弹出窗体，在 2 列或 1 列视图中显示为弹出窗体。
如果任意字符串参数超出其限制，displayReplyAllForm 将引发异常。
在参数中 formData.attachments 指定附件时，Outlook 会尝试下载所有附件并将其附加到答复表单。如果无法添加任何附件，则在窗体 UI 中显示错误。如果这不可能，则不引发错误消息。
Android 版或 iOS 版 Outlook 不支持此方法。有关 Outlook mobile 中支持的 API 的详细信息，请参阅移动设备上的 Outlook 中支持的 Outlook JavaScript API。

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/55-display-items/display-reply-forms.yaml

Office.context.mailbox.item.displayReplyAllForm("This is a reply ALL with <b>some bold text</b>.");

...

// Define attachments.
const base64Attachment = {
  base64file:
    "iVBORw0KGgoAAAANSUhEUgAAAGAAAABgCAIAAABt+uBvAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAACxEAAAsRAX9kX5EAAAAZdEVYdFNvZnR3YXJlAHBhaW50Lm5ldCA0LjAuMTM0A1t6AAAF3klEQVR4Xt2aMcolRRSFdQUuwSW4AAMzU8ENzAIMDA1NzHUBgqmZkbG4ADGVQRgGZBBElAERRPg9eC+PQ73qc6u66lZ3v48bzH+7uqr6VN/T1f3mjafT8Pr7b37+8G3En99+5akTcAqB/n7+48uP3vvp3TdvgT//+uE7P3woBwv07+s/Xn32jKXhwKF/Xr3wpgdxpEC/ffnp8/ffKkQpAg3QDDr6Ocs5RiCzm0ILEQca02qB7u2mPQ4xpnUCabtBWDWFdbfYmBYJ1HLZN6PBP3794uOiAcdKY0oXKLQbFE71jkBS33FrjClRoNBuXjx7J/QUNNCdZBtTikAtdtO1+JBA34Z5xjRfIG03I/YBTYVMScY0U6DQbsbXGdevF2C6Mc0RKLQbHEUbbz0MZNKPuYnGNCpQaDdY0iQTDR9zU4xpSCB9t+PQ719/7k3T0P49bkw7BQrtZnBajTS+uIwYU7dA4ZzynrhMWF/3sc+YOgQK7WaiNQpCh9bRu36tAmm7wT2MovOmaUAaPY3G6DKmWCBtNzaYN80EJjIuDUejMSmBUC/abnCrL3Di8IEwErhAvUGrCxRa4C+ffLDAicMVmhW42K2VLgUK67zlFXwcqL9GmltseUXlDirOvMXIbqKdHc/vieGTIJoE6rL93djNWwy9OHwqRCyQqM+J6LpeFj4bIhZoTWVdWCCLBbvkY93HwqdCdJg0AheQ/XRf9mivhk+C6BMIscawUdR5m0MRPjzRLZAFZMo2pnBHlhE+NhELJGa5YNO42Jh8VCIWCBnMEu8WRf4WC147sAxYjGLcjPDxiCaBDMxS+MKCF1cUdXbF+UhEh0CGqDjksz9CZ++2fRiiWyCgKw532QJjEhMYCR+A2COQoStuwcYyw5i8a2K/QIZ+Ei/YWM41Ju+UGBUI6Bses4eIqf6Nzkc+43N4j8QEgQxdcZApe2OJdRp/R/G+iGkCGbriFmws9TqF4b0QkwUC4SNmwcYSu419xuTnE/MFMrCSRT9FZG8s9xmTn0xkCQSKfu4Di5y9sew1Jj+NOFIgC1hG9q+y7b+s+QnE8QJZYJ0n/g+rKvoBYuFNibMIZJG9sYQx6Y8n3o44l0AILDKWOtW/xf/g8RbE6QSygGVkbyyrxuTHiJMKZLHgjbcY0bPEqQWySN1YFmN5lriAQBZJxlSM4lniMgIhMjaWxRCeJa4kkAWcdaIxFZ17lrieQBazNpZFt54lriqQBXZ9g8ZUdOhZ4toCIWxj6UP2U/TmWSJRoDU/9V1YIIDdcONr9L64dond2P19T8QjmDSDdUYhTJHpcR7z90Am/bVBx6NtFLcIv+pXAzfgo71qaFAmWx9linjYl9UWIJN4zD3454527ncD+DP7g5nBgyI8S5xCIIMHzbCbKjwowrPESQXyVD48aHXcWCDc7dm/Wxk8qKcymfZN2gJ+mfqDDODhPJUDLmTrAeotiFaBLJI2IwYP5KnZ2IaeByrC2xEVgdCFeCfIqzgexVNT0T9Ab30VqAgEwneCjIrj/j01CVFTFuKrQF0gQ/wCaQHJJ1Yc9+ypYcKawgXqrwJKIEPfmRMrjrv11BhTZh4LZGAdhDFNqTju0FN70TW1ZTdVWgUCoTFh1JGK46481U9YU70fITsEMrQxjVQc9+OpTnRNhXZTpVsgI5zKjorjHjzVjK6pkWXbKZCBm1kYU2/F8bmeakDXVJfdVBkSCGB+wpi6lo5P9FSEvpF77abKqECGNqbGiuNTPLWNrikc2mE3VeYIZOj1DCuOG3uqhq6pEbupMlMgA7PfMiY9e27pqTvEGozbTZX5AgFtTFsVx208ReiammI3VVIEMrQxYbWLS+KjnvofXVMT7aZKokCGKIqi4viQp3pOTyJdIAO3wJYx3SqOk/hT1FSS3VRZJBDQxlQUkaipPLupsk4gQxuTjmy7qbJaIEM4SzXW2E2VYwQyhDHdYqXdVDlSIKCNabHdVDlYIOPemA6xmyqnEMgwYzrQbio8Pf0HxndUxitiwgUAAAAASUVORK5CYII=",
  inLine: true,
  name: "script_lab.png",
  type: Office.MailboxEnums.AttachmentType.Base64
};
const fileAttachment = {
  inLine: true,
  name: "dog.jpg",
  type: Office.MailboxEnums.AttachmentType.File,
  url: "https://i.imgur.com/9S36xvA.jpg"
};
const itemAttachment = {
  itemId: Office.context.mailbox.item.itemId,
  name: "test_email.msg",
  type: Office.MailboxEnums.AttachmentType.Item
};

// Create the reply with attachments.
Office.context.mailbox.item.displayReplyAllForm({
  htmlBody:
    "This is a reply with an inline Base64-encoded attachment, an inline image, and an item attachment.<br><img src='cid:script_lab.png'><br><img src='cid:dog.jpg'>",
  attachments: [base64Attachment, fileAttachment, itemAttachment],
  callback: (result) => {
    if (result.status === Office.AsyncResultStatus.Failed) {
      console.error(`Action failed with message ${result.error.message}`);
      return;
    }

    console.log("Created a reply-all form with attachments.");
  }
});

displayReplyForm(formData)

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

displayReplyForm(formData: string | ReplyFormData): void;

参数

formData: string | Office.ReplyFormData

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

void

注解

[ API set： Mailbox 1.1 ]

最低权限级别： 读取项

适用的 Outlook 模式：邮件读取

重要说明：

在Outlook 网页版和新的 Outlook on Windows 中，答复窗体在 3 列视图中显示为弹出窗体，在 2 列或 1 列视图中显示为弹出窗体。
如果任意字符串参数超出其限制，displayReplyForm 将引发异常。
在参数中 formData.attachments 指定附件时，Outlook 会尝试下载所有附件并将其附加到答复表单。如果无法添加任何附件，则在窗体 UI 中显示错误。如果这不可能，则不引发错误消息。
Android 版或 iOS 版 Outlook 不支持此方法。有关 Outlook mobile 中支持的 API 的详细信息，请参阅移动设备上的 Outlook 中支持的 Outlook JavaScript API。

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/55-display-items/display-reply-forms.yaml

Office.context.mailbox.item.displayReplyForm("This is a reply with <i>some text in italics</i>.");

...

// Define attachments.
const base64Attachment = {
  base64file:
    "iVBORw0KGgoAAAANSUhEUgAAAGAAAABgCAIAAABt+uBvAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAACxEAAAsRAX9kX5EAAAAZdEVYdFNvZnR3YXJlAHBhaW50Lm5ldCA0LjAuMTM0A1t6AAAF3klEQVR4Xt2aMcolRRSFdQUuwSW4AAMzU8ENzAIMDA1NzHUBgqmZkbG4ADGVQRgGZBBElAERRPg9eC+PQ73qc6u66lZ3v48bzH+7uqr6VN/T1f3mjafT8Pr7b37+8G3En99+5akTcAqB/n7+48uP3vvp3TdvgT//+uE7P3woBwv07+s/Xn32jKXhwKF/Xr3wpgdxpEC/ffnp8/ffKkQpAg3QDDr6Ocs5RiCzm0ILEQca02qB7u2mPQ4xpnUCabtBWDWFdbfYmBYJ1HLZN6PBP3794uOiAcdKY0oXKLQbFE71jkBS33FrjClRoNBuXjx7J/QUNNCdZBtTikAtdtO1+JBA34Z5xjRfIG03I/YBTYVMScY0U6DQbsbXGdevF2C6Mc0RKLQbHEUbbz0MZNKPuYnGNCpQaDdY0iQTDR9zU4xpSCB9t+PQ719/7k3T0P49bkw7BQrtZnBajTS+uIwYU7dA4ZzynrhMWF/3sc+YOgQK7WaiNQpCh9bRu36tAmm7wT2MovOmaUAaPY3G6DKmWCBtNzaYN80EJjIuDUejMSmBUC/abnCrL3Di8IEwErhAvUGrCxRa4C+ffLDAicMVmhW42K2VLgUK67zlFXwcqL9GmltseUXlDirOvMXIbqKdHc/vieGTIJoE6rL93djNWwy9OHwqRCyQqM+J6LpeFj4bIhZoTWVdWCCLBbvkY93HwqdCdJg0AheQ/XRf9mivhk+C6BMIscawUdR5m0MRPjzRLZAFZMo2pnBHlhE+NhELJGa5YNO42Jh8VCIWCBnMEu8WRf4WC147sAxYjGLcjPDxiCaBDMxS+MKCF1cUdXbF+UhEh0CGqDjksz9CZ++2fRiiWyCgKw532QJjEhMYCR+A2COQoStuwcYyw5i8a2K/QIZ+Ei/YWM41Ju+UGBUI6Bses4eIqf6Nzkc+43N4j8QEgQxdcZApe2OJdRp/R/G+iGkCGbriFmws9TqF4b0QkwUC4SNmwcYSu419xuTnE/MFMrCSRT9FZG8s9xmTn0xkCQSKfu4Di5y9sew1Jj+NOFIgC1hG9q+y7b+s+QnE8QJZYJ0n/g+rKvoBYuFNibMIZJG9sYQx6Y8n3o44l0AILDKWOtW/xf/g8RbE6QSygGVkbyyrxuTHiJMKZLHgjbcY0bPEqQWySN1YFmN5lriAQBZJxlSM4lniMgIhMjaWxRCeJa4kkAWcdaIxFZ17lrieQBazNpZFt54lriqQBXZ9g8ZUdOhZ4toCIWxj6UP2U/TmWSJRoDU/9V1YIIDdcONr9L64dond2P19T8QjmDSDdUYhTJHpcR7z90Am/bVBx6NtFLcIv+pXAzfgo71qaFAmWx9linjYl9UWIJN4zD3454527ncD+DP7g5nBgyI8S5xCIIMHzbCbKjwowrPESQXyVD48aHXcWCDc7dm/Wxk8qKcymfZN2gJ+mfqDDODhPJUDLmTrAeotiFaBLJI2IwYP5KnZ2IaeByrC2xEVgdCFeCfIqzgexVNT0T9Ab30VqAgEwneCjIrj/j01CVFTFuKrQF0gQ/wCaQHJJ1Yc9+ypYcKawgXqrwJKIEPfmRMrjrv11BhTZh4LZGAdhDFNqTju0FN70TW1ZTdVWgUCoTFh1JGK46481U9YU70fITsEMrQxjVQc9+OpTnRNhXZTpVsgI5zKjorjHjzVjK6pkWXbKZCBm1kYU2/F8bmeakDXVJfdVBkSCGB+wpi6lo5P9FSEvpF77abKqECGNqbGiuNTPLWNrikc2mE3VeYIZOj1DCuOG3uqhq6pEbupMlMgA7PfMiY9e27pqTvEGozbTZX5AgFtTFsVx208ReiammI3VVIEMrQxYbWLS+KjnvofXVMT7aZKokCGKIqi4viQp3pOTyJdIAO3wJYx3SqOk/hT1FSS3VRZJBDQxlQUkaipPLupsk4gQxuTjmy7qbJaIEM4SzXW2E2VYwQyhDHdYqXdVDlSIKCNabHdVDlYIOPemA6xmyqnEMgwYzrQbio8Pf0HxndUxitiwgUAAAAASUVORK5CYII=",
  inLine: true,
  name: "script_lab.png",
  type: Office.MailboxEnums.AttachmentType.Base64
};
const fileAttachment = {
  inLine: true,
  name: "dog.jpg",
  type: Office.MailboxEnums.AttachmentType.File,
  url: "https://i.imgur.com/9S36xvA.jpg"
};
const itemAttachment = {
  itemId: Office.context.mailbox.item.itemId,
  name: "test_email.msg",
  type: Office.MailboxEnums.AttachmentType.Item
};

// Create the reply with attachments.
Office.context.mailbox.item.displayReplyForm({
  htmlBody:
    "This is a reply with an inline Base64-encoded attachment, an inline image, and an item attachment.<br><img src='cid:script_lab.png'><br><img src='cid:dog.jpg'>",
  attachments: [base64Attachment, fileAttachment, itemAttachment],
  callback: (result) => {
    if (result.status === Office.AsyncResultStatus.Failed) {
      console.error(`Action failed with message ${result.error.message}`);
      return;
    }

    console.log("Created a reply with attachments.");
  }
});

getEntities()

警告

现已弃用此 API。

Use regular expression rules instead.

获取在所选项目的正文中找到的实体。

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

getEntities(): Entities;

Office.Entities

注解

[ API set： Mailbox 1.1 ]

最低权限级别： 读取项

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

getEntitiesByType(entityType)

警告

现已弃用此 API。

Use regular expression rules instead.

获取所选项目的正文中找到的指定实体类型的所有实体的数组。

getEntitiesByType(entityType: MailboxEnums.EntityType | string): Array<string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion>;

参数

entityType: Office.MailboxEnums.EntityType | string

枚举值之 EntityType 一。

Array<string | Office.Contact | Office.MeetingSuggestion | Office.PhoneNumber | Office.TaskSuggestion>

如果传入 entityType 的值不是枚举的有效成员 EntityType ，则该方法返回 null。如果指定类型的任何实体都不存在于该项目的正文中，该方法将返回空数组。否则，返回的数组中对象的类型取决于 entityType 参数中请求实体的类型。

注解

[ API set： Mailbox 1.1 ]

最低权限级别：受限

适用的 Outlook 模式：邮件读取

getFilteredEntitiesByName(name)

警告

现已弃用此 API。

Use regular expression rules instead.

返回所选项中的已知实体，这些实体通过仅外接程序清单文件中定义的命名筛选器。

getFilteredEntitiesByName(name: string): Array<string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion>;

参数

name: string

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

Array<string | Office.Contact | Office.MeetingSuggestion | Office.PhoneNumber | Office.TaskSuggestion>

与外接程序清单文件中的规则元素中 ItemHasKnownEntity 定义的正则表达式匹配的实体，这些实体具有指定的 FilterName 元素值。如果清单中没有 ItemHasKnownEntity 元素，其 FilterName 元素值与参数匹配 name ，则该方法返回 null。 name如果参数与清单中的元素匹配ItemHasKnownEntity，但当前项中没有匹配的实体，则该方法将返回一个空数组。

注解

[ API set： Mailbox 1.1 ]

最低权限级别： 读取项

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

getRegExMatches()

返回所选项中与仅外接程序清单文件中定义的正则表达式匹配的字符串值。

getRegExMatches(): any;

any

一个对象，该对象包含与外接程序清单文件中定义的正则表达式匹配的字符串数组。每个数组的名称等于匹配 ItemHasRegularExpressionMatch 规则的 RegExName 属性的相应值。 ItemHasRegularExpressionMatch对于规则，匹配的字符串必须出现在由该规则指定的项的属性中。简单类型定义支持的属性。

注解

[ API set： Mailbox 1.1 ]

最低权限级别： 读取项

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

重要说明：

基于实体的上下文 Outlook 加载项现已停用。但是，仍支持正则表达式规则。建议更新上下文加载项，以使用正则表达式规则作为替代解决方案。有关如何实现这些规则的指南，请参阅上下文 Outlook 加载项。
此方法与 Outlook 加载项的激活规则功能一起使用，Microsoft 365 的统一清单不支持此功能。
如果在项的 body 属性上指定 ItemHasRegularExpressionMatch 规则，则正则表达式应进一步筛选正文，并且不应尝试返回项的整个正文。使用等 .* 正则表达式获取项的整个正文并不总是返回预期结果。而是使用 Body.getAsync 方法检索整个正文。
Android 版或 iOS 版 Outlook 不支持此方法。有关 Outlook mobile 中支持的 API 的详细信息，请参阅移动设备上的 Outlook 中支持的 Outlook JavaScript API。

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/75-regex-matches/contextual.yaml

// This API only works when you click on the highlighted word "ScriptLab".
console.log(Office.context.mailbox.item.getRegExMatches());

getRegExMatchesByName(name)

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

getRegExMatchesByName(name: string): string[];

参数

name: string

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

string[]

一个数组，其中包含与外接程序清单文件中的规则元素中 ItemHasRegularExpressionMatch 定义的正则表达式匹配的字符串，以及指定的 RegExName 元素值。

注解

[ API set： Mailbox 1.1 ]

最低权限级别： 读取项

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

重要说明：

基于实体的上下文 Outlook 加载项现已停用。但是，仍支持正则表达式规则。建议更新上下文加载项，以使用正则表达式规则作为替代解决方案。有关如何实现这些规则的指南，请参阅上下文 Outlook 加载项。
此方法与 Outlook 加载项的激活规则功能一起使用，Microsoft 365 的统一清单不支持此功能。
如果在项的 body 属性上指定 ItemHasRegularExpressionMatch 规则，则正则表达式应进一步筛选正文，并且不应尝试返回项的整个正文。使用等 .* 正则表达式获取项的整个正文并不总是返回预期结果。而是使用 Body.getAsync 方法检索整个正文。
Android 版或 iOS 版 Outlook 不支持此方法。有关 Outlook mobile 中支持的 API 的详细信息，请参阅移动设备上的 Outlook 中支持的 Outlook JavaScript API。

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/75-regex-matches/contextual.yaml

// This API only works when you click on the highlighted word "ScriptLab".
console.log(Office.context.mailbox.item.getRegExMatchesByName("sampleRegexName"));

loadCustomPropertiesAsync(callback, userContext)

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

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

自定义属性作为 asyncResult.value 属性中的 CustomProperties 对象提供。此对象可用于从邮件项获取、设置、保存和删除自定义属性。

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

参数

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

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

userContext: any

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

void

注解

[ API set： Mailbox 1.1 ]

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

最低权限级别： 读取项

适用的 Outlook 模式：邮件读取

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/15-item-custom-properties/load-set-get-save.yaml

Office.context.mailbox.item.loadCustomPropertiesAsync((result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.error(`loadCustomPropertiesAsync failed with message ${result.error.message}`);
    return;
  }

  customProps = result.value;
  console.log("Loaded the CustomProperties object.");
});

反馈

此页面是否有帮助？