使用Office.js Outlook插件为邮件头添加标记的API实现咨询

关于Office.context.mailbox.item的相关方法 #

Office.context.mailbox.item本身没有直接添加可视化邮件头标记的原生API，无法直接将自定义标记渲染到Outlook默认的邮件头部区域。但你可以通过customProperties存储标记数据，再结合自定义UI实现类似效果。

customProperties的具体实现步骤 #

1. 存储标记数据

使用customProperties保存标记的状态或内容，数据会绑定到当前邮件：

// 获取当前邮件的自定义属性集合
Office.context.mailbox.item.customProperties.getAsync((result) => {
  if (result.status === Office.AsyncResultStatus.Succeeded) {
    const customProps = result.value;
    // 设置自定义标记键值对，比如标记为"已处理"
    customProps.set("mailHeaderTag", "已处理");
    // 将属性保存到服务器
    customProps.saveAsync((saveResult) => {
      saveResult.status === Office.AsyncResultStatus.Succeeded
        ? console.log("标记已成功存储")
        : console.error(`存储失败: ${saveResult.error.message}`);
    });
  } else {
    console.error(`获取属性失败: ${result.error.message}`);
  }
});

2. 实现可视化展示

由于无法直接修改Outlook默认邮件头部UI，可通过两种方式展示标记：

• 在插件任务窗格显示：读取customProperties的值，在插件任务窗格中渲染对应的标识或文字，让用户直观看到当前邮件的标记状态。
• 插入到邮件正文头部：若允许修改邮件内容，可在正文最上方插入带样式的HTML元素，模拟邮件头标记效果：

// 读取现有正文内容并插入自定义标记
Office.context.mailbox.item.body.getAsync(Office.CoercionType.Html, (result) => {
  if (result.status === Office.AsyncResultStatus.Succeeded) {
    const headerTag = '<div style="background: #e7f3ff; padding: 8px; border-left: 4px solid #1a73e8; margin-bottom: 16px;">已处理标记</div>';
    // 将标记插入到正文开头
    Office.context.mailbox.item.body.setAsync(
      headerTag + result.value,
      { coercionType: Office.CoercionType.Html },
      (setResult) => {
        setResult.status === Office.AsyncResultStatus.Succeeded
          ? console.log("标记已插入正文")
          : console.error(`插入失败: ${setResult.error.message}`);
      }
    );
  }
});

3. 读取已存储的标记

当用户打开邮件时，读取customProperties获取标记数据并展示：

Office.context.mailbox.item.customProperties.getAsync((result) => {
  if (result.status === Office.AsyncResultStatus.Succeeded) {
    const tagValue = result.value.get("mailHeaderTag");
    if (tagValue) {
      // 在任务窗格或自定义UI中展示标记内容
      console.log(`当前邮件标记: ${tagValue}`);
    }
  }
});

补充说明 #

如果需要完全复刻截图中Outlook原生邮件头标记的显示位置（如自带类别标签的展示区域），目前Office JS API暂未提供修改默认邮件头部UI的能力，只能通过上述自定义UI的方式实现替代效果。

内容的提问来源于stack exchange，提问作者Sora