通过

Office.Display interface

  • 参考
包:
outlook

注意

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

提供属性，用于临时设置在阅读模式下邮件正文或主题中显示的内容。

注解

[ API 集：邮箱预览 ]

最低权限级别： 读/写项

适用的 Outlook 模式：邮件读取

属性

body

获取一个 对象，用于临时设置在阅读模式下的消息正文中显示的内容。
subject

获取一个 对象，用于临时设置在阅读模式下消息的主题中显示的内容。

属性详细信息

body

注意

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

获取一个 对象，用于临时设置在阅读模式下的消息正文中显示的内容。

body: DisplayedBody;

属性值

Office.DisplayedBody

注解

[ API 集：邮箱预览 ]

最低权限级别： 读/写项

适用的 Outlook 模式：邮件读取

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/99-preview-apis/set-displayed-body-subject.yaml

// This snippet temporarily sets the content displayed in the body of a message in read mode.
// The set content will remain visible until the user switches to a different message in the Reading Pane or closes the window of the current message.
const bodyText = $("#body-text-field")
  .val()
  .toString();
Office.context.mailbox.item.display.body.setAsync(bodyText, (asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log(`Action failed with error: ${asyncResult.error.message}`);
    return;
  }

  console.log("Temporarily set the content displayed in the body.");
});

subject

注意

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

获取一个 对象，用于临时设置在阅读模式下消息的主题中显示的内容。

subject: DisplayedSubject;

属性值

Office.DisplayedSubject

注解

[ API 集：邮箱预览 ]

最低权限级别： 读/写项

适用的 Outlook 模式：邮件读取

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/99-preview-apis/set-displayed-body-subject.yaml

// This snippet temporarily sets the content displayed in the subject field of a message in read mode.
// The set content will remain visible until the user switches to a different message in the Reading Pane or closes the window of the current message.
const subjectText = $("#subject-text-field")
  .val()
  .toString();
Office.context.mailbox.item.display.subject.setAsync(subjectText, (asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log(`Action failed with error: ${asyncResult.error.message}`);
    return;
  }

  console.log("Temporarily set the content displayed in the subject field.");
});