Office.Body interface

body 对象提供用于添加和更新消息或约会内容的方法。 它在所选项目的 body 属性中返回。

注解

API 集:邮箱 1.1

若要了解如何获取或设置邮件项目的正文,请参阅在 Outlook 中获取或设置邮件或约会的正文。

HTML 表格边框颜色的已知问题

Windows 版 Outlook:如果在 Compose 模式下将 HTML 表中的各种单元格边框设置为不同颜色,则单元格的边框可能不会反映预期的颜色。 有关已知行为,请访问 OfficeDev/office-js 问题 #1818。

最低权限级别: 读取项目

适用的 Outlook 模式:Compose 或 Read

使用方

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/20-item-body/add-inline-base64-image.yaml

// Get the current body of the message or appointment.
Office.context.mailbox.item.body.getAsync(Office.CoercionType.Html, (bodyResult) => {
  if (bodyResult.status === Office.AsyncResultStatus.Failed) {
    console.log(`Failed to get body: ${bodyResult.error.message}`);
    return;
  }

  // Add the Base64-encoded image to the end of the body.
  const options = { isInline: true, asyncContext: bodyResult.value };
  Office.context.mailbox.item.addFileAttachmentFromBase64Async(base64String, "sample.png", options, (attachResult) => {
    if (attachResult.status === Office.AsyncResultStatus.Failed) {
      console.log(`Failed to attach file: ${attachResult.error.message}`);
      return;
    }

    let body = attachResult.asyncContext;
    body += '<img src="cid:sample.png" />';

    Office.context.mailbox.item.body.setAsync(body, { coercionType: Office.CoercionType.Html }, (setResult) => {
      if (setResult.status === Office.AsyncResultStatus.Failed) {
        console.log(`Failed to set body: ${setResult.error.message}`);
        return;
      }
      
      console.log("Inline Base64-encoded image added to the end of the body.");
    });
  });
});

方法

appendOnSendAsync(data, options, callback)

在发送指定内容时附加到项正文末尾,在任何签名之后。

若要使用 appendOnSendAsync,必须在清单中指定补充权限。 详细信息因清单类型而异。 请参阅 了解Outlook加载项权限。 若要了解有关发送时追加及其配置的详细信息,请参阅 在 Outlook 加载项中实现发送时附加。

appendOnSendAsync(data, callback)

在发送指定内容时附加到项正文末尾,在任何签名之后。

若要使用 appendOnSendAsync,必须在清单中指定补充权限。 详细信息因清单类型而异。 请参阅 了解Outlook加载项权限。 若要了解有关发送时追加及其配置的详细信息,请参阅 在 Outlook 加载项中实现发送时附加。

getAsync(coercionType, options, callback)

按 指定的格式 coercionType返回当前整个正文。

getAsync(coercionType, callback)

按 指定的格式 coercionType返回当前整个正文。

getTypeAsync(options, callback)

获取一个值,该值指示内容采用 HTML 格式还是文本格式。

getTypeAsync(callback)

获取一个值,该值指示内容采用 HTML 格式还是文本格式。

prependAsync(data, options, callback)

将指定内容添加到项目正文开头。

prependAsync(data, callback)

将指定内容添加到项目正文开头。

prependOnSendAsync(data, options, callback)

发送邮件项目时,在邮件或约会正文的开头预置 HTML 或纯文本。

若要使用 prependOnSendAsync,必须在清单中指定补充权限。 详细信息因清单类型而异。 有关指南,请参阅 了解 Outlook 加载项权限。

prependOnSendAsync(data, callback)

发送邮件项目时,在邮件或约会正文的开头预置 HTML 或纯文本。

若要使用 prependOnSendAsync,必须在清单中指定补充权限。 详细信息因清单类型而异。 有关指南,请参阅 了解 Outlook 加载项权限。

setAsync(data, options, callback)

将整个正文替换为指定的文本。

setAsync(data, callback)

将整个正文替换为指定的文本。

setSelectedDataAsync(data, options, callback)

将正文中的所选内容更换为指定文本。

setSelectedDataAsync 方法将指定的字符串插入项目正文中的光标位置,或者,如果在编辑器中选定了文本,它就会替换所选文本。 如果光标从未出现在项目正文中,或者如果该项目的正文不关注 UI,该字符串将插入到正文内容的顶部。 插入后,光标放置在插入内容的末尾。

setSelectedDataAsync(data, callback)

将正文中的所选内容更换为指定文本。

setSelectedDataAsync 方法将指定的字符串插入项目正文中的光标位置,或者,如果在编辑器中选定了文本,它就会替换所选文本。 如果光标从未出现在项目正文中,或者如果该项目的正文不关注 UI,该字符串将插入到正文内容的顶部。 插入后,光标放置在插入内容的末尾。

setSignatureAsync(data, options, callback)

如果项正文没有现有签名,则向其添加签名。 如果正文中已有签名,则替换该签名。

setSignatureAsync(data, callback)

如果项正文没有现有签名,则向其添加签名。 如果正文中已有签名,则替换该签名。

方法详细信息

appendOnSendAsync(data, options, callback)

在发送指定内容时附加到项正文末尾,在任何签名之后。

若要使用 appendOnSendAsync,必须在清单中指定补充权限。 详细信息因清单类型而异。 请参阅 了解Outlook加载项权限。 若要了解有关发送时追加及其配置的详细信息,请参阅 在 Outlook 加载项中实现发送时附加。

appendOnSendAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

参数

data

string

要添加到正文末尾的字符串。 字符串限制为 5,000 个字符。

options

Office.AsyncContextOptions & Office.CoercionTypeOptions

包含以下一个或多个属性的对象文本:- asyncContext:开发人员可以在回调函数中提供他们希望访问的任何对象。 coercionType :要追加的数据的所需格式。 参数中的字符串将转换为此格式。

callback

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

可选。 当该方法完成时, callback 将使用类型 Office.AsyncResult为 . asyncResult.error 属性中将提供遇到的所有错误。

返回

void

注解

API 集:邮箱 1.9

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

适用的 Outlook 模式:Compose

建议:调用 getTypeAsync,然后将其返回的值传递给 options.coercionType 参数。

重要说明:

  • 如果用户正在运行在清单中实现ItemSend发送时功能的加载项,则发送时追加会在发送时功能之前运行。

  • 如果加载项实现发送时功能和处理程序中的ItemSend调用appendOnSendAsync,appendOnSendAsync则调用将返回错误,因为不支持此方案。

  • 要清除上一次appendOnSendAsync调用中的数据,可以在参数设置为 null的情况下再次data调用它。

  • 不支持 SVG 文件。 请改用 JPG 或 PNG 文件。

  • 该 appendOnSendAsync 方法不支持内联 CSS。 请改用内部或外部 CSS。

  • 当前使用该loadItemByIdAsync方法加载的消息不支持此appendOnSendAsync方法。 有关详细信息,请参阅 在多封邮件上激活 Outlook 加载项。

错误:

  • DataExceedsMaximumSize :参数 data 超过 5,000 个字符。

  • InvalidFormatError : options.coercionType 参数设置为 Office.CoercionType.Html ,但邮件正文为纯文本。

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/20-item-body/append-text-on-send.yaml

// This snippet appends text to the end of the message or appointment's body once it's sent.
const text = (document.getElementById("text-field") as HTMLInputElement).value;

// It's recommended to call getTypeAsync and pass its returned value to the options.coercionType parameter of the appendOnSendAsync call.
Office.context.mailbox.item.body.getTypeAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log("Action failed with error: " + asyncResult.error.message);
    return;
  }

  const bodyFormat = asyncResult.value;
  Office.context.mailbox.item.body.appendOnSendAsync(text, { coercionType: bodyFormat }, (asyncResult) => {
    if (asyncResult.status === Office.AsyncResultStatus.Failed) {
      console.log("Action failed with error: " + asyncResult.error.message);
      return;
    }

    console.log(`"${text}" will be appended to the body once the message or appointment is sent. Send the mail item to test this feature.`);
  });
});

appendOnSendAsync(data, callback)

在发送指定内容时附加到项正文末尾,在任何签名之后。

若要使用 appendOnSendAsync,必须在清单中指定补充权限。 详细信息因清单类型而异。 请参阅 了解Outlook加载项权限。 若要了解有关发送时追加及其配置的详细信息,请参阅 在 Outlook 加载项中实现发送时附加。

appendOnSendAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

参数

data

string

要添加到正文末尾的字符串。 字符串限制为 5,000 个字符。

callback

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

可选。 当该方法完成时, callback 将使用类型 Office.AsyncResult为 . asyncResult.error 属性中将提供遇到的所有错误。

返回

void

注解

API 集:邮箱 1.9

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

适用的 Outlook 模式:Compose

建议:调用 getTypeAsync,然后将其返回的值传递给 options.coercionType 参数。

重要说明:

  • 如果用户正在运行在清单中实现ItemSend发送时功能的加载项,则发送时追加会在发送时功能之前运行。

  • 如果加载项实现发送时功能和处理程序中的ItemSend调用appendOnSendAsync,appendOnSendAsync则调用将返回错误,因为不支持此方案。

  • 要清除上一次appendOnSendAsync调用中的数据,可以在参数设置为 null的情况下再次data调用它。

  • 不支持 SVG 文件。 请改用 JPG 或 PNG 文件。

  • 该 appendOnSendAsync 方法不支持内联 CSS。 请改用内部或外部 CSS。

  • 当前使用该loadItemByIdAsync方法加载的消息不支持此appendOnSendAsync方法。 有关详细信息,请参阅 在多封邮件上激活 Outlook 加载项。

错误:

  • DataExceedsMaximumSize :参数 data 超过 5,000 个字符。

  • InvalidFormatError : options.coercionType 参数设置为 Office.CoercionType.Html ,但邮件正文为纯文本。

getAsync(coercionType, options, callback)

按 指定的格式 coercionType返回当前整个正文。

getAsync(coercionType: Office.CoercionType | string, options: Office.AsyncContextOptions & { bodyMode?: MailboxEnums.BodyMode }, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;

参数

coercionType

Office.CoercionType | string

用于返回的正文的格式。

options

Office.AsyncContextOptions & { bodyMode?: Office.MailboxEnums.BodyMode }

包含一个或多个以下属性的对象文本。 asyncContext :想要在回调函数中访问的任何数据。 bodyMode :在 Outlook 网页版、移动设备和 Windows 上的新 Outlook 中,指定是仅返回当前邮件的正文还是邮件对话的整个正文。 如果未指定值, bodyMode 则默认为 Office.MailboxEnums.BodyMode.FullBody,这将返回消息对话的整个正文。 该bodyMode属性仅适用于 Message Compose 图面上的回复。 在 Windows (经典) 和 Mac 上的 Outlook 中将忽略此值。

callback

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

可选。 方法完成后,将使用类型为 Office.AsyncResult 的单个参数调用传入参数的 callback 函数。 正文在属性中 asyncResult.value 以请求的格式提供。

返回

void

注解

API 集:邮箱 1.3

最低权限级别: 读取项目

适用的 Outlook 模式:Compose 或 Read

重要说明:

  • 使用 HTML 格式的正文时,请务必注意,该方法返回的 Body.getAsync 值不一定与之前在该方法中 Body.setAsync 传递的值完全相同。 客户端可以修改传递给 setAsync 的值,以使其使用其呈现引擎高效呈现。

  • 在 Outlook 网页版和新的 Outlook on Windows 中,在调用中getAsync指定可能Office.CoercionType.Text并不总是提供可靠的格式。 请改为指定, Office.CoercionType.Html 尤其是在正文包含表格、列表和链接等格式化元素时。

  • 在 Outlook 网页版 和 Windows 上的新版 Outlook 中,用户可以在“设置>”、“邮件>布局>”、“邮件 (组织”、“邮件整理”中将其邮件组织为对话或单条邮件,请参阅“更改邮件列表在 Outlook) 中的显示方式”。 此设置会影响向用户显示的邮件正文量 (即,邮件的整个对话线程或仅当前邮件) 。 在 Message Compose 模式下,特别是对于对包含多条消息的对话线程的回复,如果希望返回的正文反映用户的设置,请在getAsync调用中指定bodyMode: Office.MailboxEnums.BodyMode.HostConfig参数。 如果按对话对邮件进行分组,则仅返回当前回复的正文。 相反,如果单独显示消息,则返回整个对话线程。

  • 在移动设备上的 Outlook 中,该 bodyMode 属性从版本 4.2538.0 开始可用。

  • 在移动设备上的 Outlook 中,指定返回 bodyMode: Office.MailboxEnums.BodyMode.HostConfig 当前回复的正文。

  • 在移动设备上的 Outlook 中,在快速答复模式下 (邮件) 底部的答复字段时,仅返回当前答复的正文。 即使在调用中getAsync指定了,这bodyMode: Office.MailboxEnums.BodyMode.FullBody也适用。

  • 使用该loadItemByIdAsync方法加载的消息不支持此bodyMode选项。 有关详细信息,请参阅 在多封邮件上激活 Outlook 加载项。

getAsync(coercionType, callback)

按 指定的格式 coercionType返回当前整个正文。

getAsync(coercionType: Office.CoercionType | string, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;

参数

coercionType

Office.CoercionType | string

用于返回的正文的格式。

callback

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

可选。 方法完成后,将使用类型为 Office.AsyncResult 的单个参数调用传入参数的 callback 函数。 正文在属性中 asyncResult.value 以请求的格式提供。

返回

void

注解

API 集:邮箱 1.3

最低权限级别: 读取项目

适用的 Outlook 模式:Compose 或 Read

重要说明:

  • 使用 HTML 格式的正文时,请务必注意,该方法返回的 Body.getAsync 值不一定与之前在该方法中 Body.setAsync 传递的值完全相同。 客户端可以修改传递给 setAsync 的值,以使其使用其呈现引擎高效呈现。

  • 在 Outlook 网页版和新的 Outlook on Windows 中,在调用中getAsync指定可能Office.CoercionType.Text并不总是提供可靠的格式。 请改为指定, Office.CoercionType.Html 尤其是在正文包含表格、列表和链接等格式化元素时。

  • 在 Outlook 网页版 和 Windows 上的新版 Outlook 中,用户可以在“设置>”、“邮件>布局>”、“邮件 (组织”、“邮件整理”中将其邮件组织为对话或单条邮件,请参阅“更改邮件列表在 Outlook) 中的显示方式”。 此设置会影响向用户显示的邮件正文量 (即,邮件的整个对话线程或仅当前邮件) 。 在 Message Compose 模式下,特别是对于对包含多条消息的对话线程的回复,如果希望返回的正文反映用户的设置,请在getAsync调用中指定bodyMode: Office.MailboxEnums.BodyMode.HostConfig参数。 如果按对话对邮件进行分组,则仅返回当前回复的正文。 相反,如果单独显示消息,则返回整个对话线程。

  • 在移动设备上的 Outlook 中,该 bodyMode 属性从版本 4.2538.0 开始可用。

  • 在移动设备上的 Outlook 中,指定返回 bodyMode: Office.MailboxEnums.BodyMode.HostConfig 当前回复的正文。

  • 在移动设备上的 Outlook 中,在快速答复模式下 (邮件) 底部的答复字段时,仅返回当前答复的正文。 即使在调用中getAsync指定了,这bodyMode: Office.MailboxEnums.BodyMode.FullBody也适用。

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/20-item-body/add-inline-base64-image.yaml

// Get the current body of the message or appointment.
Office.context.mailbox.item.body.getAsync(Office.CoercionType.Html, (bodyResult) => {
  if (bodyResult.status === Office.AsyncResultStatus.Failed) {
    console.log(`Failed to get body: ${bodyResult.error.message}`);
    return;
  }

  // Add the Base64-encoded image to the end of the body.
  const options = { isInline: true, asyncContext: bodyResult.value };
  Office.context.mailbox.item.addFileAttachmentFromBase64Async(base64String, "sample.png", options, (attachResult) => {
    if (attachResult.status === Office.AsyncResultStatus.Failed) {
      console.log(`Failed to attach file: ${attachResult.error.message}`);
      return;
    }

    let body = attachResult.asyncContext;
    body += '<img src="cid:sample.png" />';

    Office.context.mailbox.item.body.setAsync(body, { coercionType: Office.CoercionType.Html }, (setResult) => {
      if (setResult.status === Office.AsyncResultStatus.Failed) {
        console.log(`Failed to set body: ${setResult.error.message}`);
        return;
      }
      
      console.log("Inline Base64-encoded image added to the end of the body.");
    });
  });
});

getTypeAsync(options, callback)

获取一个值,该值指示内容采用 HTML 格式还是文本格式。

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

参数

options
Office.AsyncContextOptions

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

callback

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

可选。 当该方法完成时, callback 将使用类型 Office.AsyncResult为 . 内容类型作为属性中的asyncResult.value值之一CoercionType返回。

返回

void

注解

API 集:邮箱 1.1

最低权限级别: 读取项目

适用的 Outlook 模式:Compose

重要提示:在 Android 和 iOS 上的 Outlook 中,“邮件Compose”模式不支持此方法。 仅支持约会组织者模式。 有关 Outlook 移动版中支持的 API 的详细信息,请参阅移动设备上的 Outlook 支持的 Outlook JavaScript API。

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/20-item-body/get-body-format.yaml

// Get the mail item's body format (plain text or HTML) and log it to the console.
Office.context.mailbox.item.body.getTypeAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log("Action failed with error: " + asyncResult.error.message);
    return;
  }

  console.log("Body format: " + asyncResult.value);
});

getTypeAsync(callback)

获取一个值,该值指示内容采用 HTML 格式还是文本格式。

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

参数

callback

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

可选。 当该方法完成时, callback 将使用类型 Office.AsyncResult为 . 内容类型作为属性中的asyncResult.value值之一CoercionType返回。

返回

void

注解

API 集:邮箱 1.1

最低权限级别: 读取项目

适用的 Outlook 模式:Compose

重要提示:在 Android 和 iOS 上的 Outlook 中,“邮件Compose”模式不支持此方法。 仅支持约会组织者模式。 有关 Outlook 移动版中支持的 API 的详细信息,请参阅移动设备上的 Outlook 支持的 Outlook JavaScript API。

prependAsync(data, options, callback)

将指定内容添加到项目正文开头。

prependAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

参数

data

string

将插入到正文开头的字符串。 字符串大小限制为 1,000,000 个字符。

options

Office.AsyncContextOptions & Office.CoercionTypeOptions

包含以下一个或多个属性的对象文本:- asyncContext:开发人员可以在回调函数中提供他们希望访问的任何对象。 coercionType :所需的正文格式。 参数中的字符串将转换为此格式。

callback

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

可选。 当该方法完成时, callback 将使用类型 Office.AsyncResult为 . asyncResult.error 属性中将提供遇到的所有错误。

返回

void

注解

API 集:邮箱 1.1

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

适用的 Outlook 模式:Compose

建议:调用 getTypeAsync,然后将返回的值传递给 options.coercionType 参数。

重要说明:

  • 在前面添加内容后,光标的位置取决于加载项正在运行的客户端。 在 Outlook 网页版 和 Windows (新的和经典) 上,光标位置在正文的预先存在内容中保持不变。 例如,如果光标在调用前 prependAsync 位于正文的开头,则它将出现在调用后正文的预置内容和预先存在的内容之间。 在 Mac 上的 Outlook 中,不会保留光标位置。 调用后 prependAsync 光标将消失,仅当用户在邮件项正文中选择某些内容时才会重新显示。

  • 使用 HTML 格式的正文时,请务必注意,客户端可以修改传递给 prependAsync 的值,以使其通过其呈现引擎高效呈现。 这意味着,对 Body.getAsync 邮箱 1.3 中引入的方法的后续调用返回的值 () 不一定包含上一次 prependAsync 调用中传递的确切值。

  • 在 HTML 标记中包含链接时,可以通过将定位点 () >< 上的属性设置为id“LPNoLP”来禁用联机链接预览。 例如, '<a id="LPNoLP" href="http://www.contoso.com">Click here!</a>'.

  • 在 Android 和 iOS 上的 Outlook 中,Message Compose 模式不支持此方法。 仅支持约会组织者模式。 有关 Outlook 移动版中支持的 API 的详细信息,请参阅移动设备上的 Outlook 支持的 Outlook JavaScript API。

  • 不支持 SVG 文件。 请改用 JPG 或 PNG 文件。

  • 该 prependAsync 方法不支持内联 CSS。 请改用内部或外部 CSS。

  • 当前使用该loadItemByIdAsync方法加载的消息不支持此prependAsync方法。 有关详细信息,请参阅 在多封邮件上激活 Outlook 加载项。

错误:

  • DataExceedsMaximumSize :数据参数超过 1,000,000 个字符。

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/20-item-body/prepend-text-to-item-body.yaml

/* This snippet adds text to the beginning of the message or appointment's body. 

  When prepending a link in HTML markup to the body, you can disable the online link preview by setting the anchor tag's id attribute to "LPNoLP". For example, '<a id="LPNoLP" href="https://www.contoso.com">Click here!</a>'.
*/
const text = (document.getElementById("text-field") as HTMLInputElement).value;

// It's recommended to call getTypeAsync and pass its returned value to the options.coercionType parameter of the prependAsync call.
Office.context.mailbox.item.body.getTypeAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log("Action failed with error: " + asyncResult.error.message);
    return;
  }

  const bodyFormat = asyncResult.value;
  Office.context.mailbox.item.body.prependAsync(text, { coercionType: bodyFormat }, (asyncResult) => {
    if (asyncResult.status === Office.AsyncResultStatus.Failed) {
      console.log("Action failed with error: " + asyncResult.error.message);
      return;
    }

    console.log(`"${text}" prepended to the body.`);
  });
});

prependAsync(data, callback)

将指定内容添加到项目正文开头。

prependAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

参数

data

string

将插入到正文开头的字符串。 字符串大小限制为 1,000,000 个字符。

callback

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

可选。 当该方法完成时, callback 将使用类型 Office.AsyncResult为 . asyncResult.error 属性中将提供遇到的所有错误。

返回

void

注解

API 集:邮箱 1.1

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

适用的 Outlook 模式:Compose

建议:调用 getTypeAsync,然后将返回的值传递给 options.coercionType 参数。

重要说明:

  • 在前面添加内容后,光标的位置取决于加载项正在运行的客户端。 在 Outlook 网页版 和 Windows (新的和经典) 上,光标位置在正文的预先存在内容中保持不变。 例如,如果光标在调用前 prependAsync 位于正文的开头,则它将出现在调用后正文的预置内容和预先存在的内容之间。 在 Mac 上的 Outlook 中,不会保留光标位置。 调用后 prependAsync 光标将消失,仅当用户在邮件项正文中选择某些内容时才会重新显示。

  • 使用 HTML 格式的正文时,请务必注意,客户端可以修改传递给 prependAsync 的值,以使其通过其呈现引擎高效呈现。 这意味着,对 Body.getAsync 邮箱 1.3 中引入的方法的后续调用返回的值 () 不一定包含上一次 prependAsync 调用中传递的确切值。

  • 在 HTML 标记中包含链接时,可以通过将定位点 () >< 上的属性设置为id“LPNoLP”来禁用联机链接预览。 例如, '<a id="LPNoLP" href="http://www.contoso.com">Click here!</a>'.

  • 在 Android 和 iOS 上的 Outlook 中,Message Compose 模式不支持此方法。 仅支持约会组织者模式。 有关 Outlook 移动版中支持的 API 的详细信息,请参阅移动设备上的 Outlook 支持的 Outlook JavaScript API。

  • 不支持 SVG 文件。 请改用 JPG 或 PNG 文件。

  • 该 prependAsync 方法不支持内联 CSS。 请改用内部或外部 CSS。

  • 当前使用该loadItemByIdAsync方法加载的消息不支持此prependAsync方法。 有关详细信息,请参阅 在多封邮件上激活 Outlook 加载项。

错误:

  • DataExceedsMaximumSize :数据参数超过 1,000,000 个字符。

prependOnSendAsync(data, options, callback)

发送邮件项目时,在邮件或约会正文的开头预置 HTML 或纯文本。

若要使用 prependOnSendAsync,必须在清单中指定补充权限。 详细信息因清单类型而异。 有关指南,请参阅 了解 Outlook 加载项权限。

prependOnSendAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

参数

data

string

要附加到消息或约会正文开头的字符串。 字符串限制为 5,000 个字符。

options

Office.AsyncContextOptions & Office.CoercionTypeOptions

包含以下一个或多个属性的对象文本:- asyncContext:可以在回调函数中访问的任何对象。 coercionType :所需的正文格式。 参数中的 data 字符串将转换为此格式。

callback

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

可选。 当该方法完成时, callback 将使用类型 Office.AsyncResult为 . asyncResult.error 属性中将提供遇到的所有错误。

返回

void

注解

API 集:邮箱 1.13

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

适用的 Outlook 模式:Compose

建议:调用 getTypeAsync,然后将其返回的值传递给 options.coercionType 参数。

重要提示:实施 prependOnSendAsync时,请记住以下事项。

  • 在 智能警报加载项中,发送时预置功能首先运行。

  • 在预置内容后添加一行新行。

  • 如果多个活动加载项 prependOnSendAsync调用,则插入内容的顺序取决于加载项的运行顺序。 上次运行的加载项的内容显示在先前预置的内容上方。

  • 如果加载项尝试将 HTML 插入纯文本正文,则不会在其内容前面添加。 相反,纯文本将插入到 HTML 正文中。

  • 不支持 SVG 文件。 请改用 JPG 或 PNG 文件。

  • 该 prependOnSendAsync 方法不支持内联 CSS。 请改用内部或外部 CSS。

  • 当前使用该loadItemByIdAsync方法加载的消息不支持此prependOnSendAsync方法。 有关详细信息,请参阅 在多封邮件上激活 Outlook 加载项。

错误:

  • DataExceedsMaximumSize :参数 data 超过 5,000 个字符。

  • InvalidFormatError : options.coercionType 参数设置为 Office.CoercionType.Html,但项正文为纯文本格式。

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/20-item-body/prepend-text-on-send.yaml

// This snippet prepends text to the beginning of the message or appointment's body once it's sent.
const text = (document.getElementById("text-field") as HTMLInputElement).value;

// It's recommended to call getTypeAsync and pass its returned value to the options.coercionType parameter of the prependOnSendAsync call.
Office.context.mailbox.item.body.getTypeAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log("Action failed with error: " + asyncResult.error.message);
    return;
  }

  const bodyFormat = asyncResult.value;
  Office.context.mailbox.item.body.prependOnSendAsync(text, { coercionType: bodyFormat }, (asyncResult) => {
    if (asyncResult.status === Office.AsyncResultStatus.Failed) {
      console.log("Action failed with error: " + asyncResult.error.message);
      return;
    }

    console.log(`"${text}" will be prepended to the body once the message or appointment is sent. Send the mail item to test this feature.`);
  });
});

prependOnSendAsync(data, callback)

发送邮件项目时,在邮件或约会正文的开头预置 HTML 或纯文本。

若要使用 prependOnSendAsync,必须在清单中指定补充权限。 详细信息因清单类型而异。 有关指南,请参阅 了解 Outlook 加载项权限。

prependOnSendAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

参数

data

string

要附加到消息或约会正文开头的字符串。 字符串限制为 5,000 个字符。

callback

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

可选。 当该方法完成时, callback 将使用类型 Office.AsyncResult为 . asyncResult.error 属性中将提供遇到的所有错误。

返回

void

注解

API 集:邮箱 1.13

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

适用的 Outlook 模式:Compose

建议:调用 getTypeAsync,然后将其返回的值传递给 options.coercionType 参数。

重要提示:实施 prependOnSendAsync时,请记住以下事项。

  • 在 智能警报加载项中,发送时预置功能首先运行。

  • 在预置内容后添加一行新行。

  • 如果多个活动加载项 prependOnSendAsync调用,则插入内容的顺序取决于加载项的运行顺序。 上次运行的加载项的内容显示在先前预置的内容上方。

  • 如果加载项尝试将 HTML 插入纯文本正文,则不会在其内容前面添加。 相反,纯文本将插入到 HTML 正文中。

  • 不支持 SVG 文件。 请改用 JPG 或 PNG 文件。

  • 该 prependOnSendAsync 方法不支持内联 CSS。 请改用内部或外部 CSS。

  • 当前使用该loadItemByIdAsync方法加载的消息不支持此prependOnSendAsync方法。 有关详细信息,请参阅 在多封邮件上激活 Outlook 加载项。

错误:

  • DataExceedsMaximumSize :参数 data 超过 5,000 个字符。

  • InvalidFormatError : options.coercionType 参数设置为 Office.CoercionType.Html,但项正文为纯文本格式。

setAsync(data, options, callback)

将整个正文替换为指定的文本。

setAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions & { bodyMode?: MailboxEnums.BodyMode }, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

参数

data

string

替换现有正文的字符串。 字符串大小限制为 1,000,000 个字符。

options

Office.AsyncContextOptions & Office.CoercionTypeOptions & { bodyMode?: Office.MailboxEnums.BodyMode }

包含一个或多个以下属性的对象文本。 asyncContext :想要在回调函数中访问的任何数据。 coercionType :所需的正文格式。 参数中的 data 字符串将转换为此格式。 bodyMode :在 Outlook 网页版和新版 Outlook on Windows 中,指定是仅设置当前邮件的正文还是邮件对话的整个正文。 如果未指定值, bodyMode 则默认为 Office.MailboxEnums.BodyMode.FullBody,替换整个正文,包括对话线程中的先前消息。 该bodyMode属性仅适用于 Message Compose 图面上的回复。 在 Windows (经典) 、Mac 和移动设备上的 Outlook 中将忽略它。

callback

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

可选。 方法完成后,将使用类型为 Office.AsyncResult 的单个参数调用传入参数的 callback 函数。 asyncResult.error 属性中将提供遇到的所有错误。

返回

void

注解

API 集:邮箱 1.3

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

适用的 Outlook 模式:Compose

建议:调用 getTypeAsync,然后将返回的值传递给 options.coercionType 参数。

重要说明:

  • 正文替换为指定内容后,光标的位置取决于加载项正在运行的客户端。 在经典 Windows 版 Outlook 中,光标显示在邮件项正文的开头。 在 Outlook 网页版和新版 Outlook on Windows 中,光标显示在邮件项目正文的末尾。 在 Mac 上的 Outlook 中,不会保留光标位置。 调用后 prependAsync 光标将消失,仅当用户在邮件项正文中选择某些内容时才会重新显示。

  • 使用 HTML 格式的正文时,请务必注意,该方法返回的 Body.getAsync 值不一定与之前在该方法中 Body.setAsync 传递的值完全相同。 客户端可以修改传递给 setAsync 的值,以使其使用其呈现引擎高效呈现。

  • 在 HTML 标记中包含链接时,可以通过将定位点 () >< 上的属性设置为id“LPNoLP”来禁用联机链接预览。 例如, '<a id="LPNoLP" href="http://www.contoso.com">Click here!</a>'.

  • 在 Windows (经典) 和 Mac 上的 Outlook 中,加载项用户无法使用“撤销”命令还原此操作。

  • 在 Android 和 iOS 上的 Outlook 中,Message Compose 模式不支持此方法。 仅支持约会组织者模式。 有关 Outlook 移动版中支持的 API 的详细信息,请参阅移动设备上的 Outlook 支持的 Outlook JavaScript API。

  • 不支持 SVG 文件。 请改用 JPG 或 PNG 文件。

  • 该 setAsync 方法不支持内联 CSS。 请改用内部或外部 CSS。

  • 当前使用该loadItemByIdAsync方法加载的消息不支持此setAsync方法。 有关详细信息,请参阅 在多封邮件上激活 Outlook 加载项。

  • 在 Windows 上的 Outlook 网页版 和新版 Outlook 中,用户可以在“设置>”、“邮件>布局>”、“邮件组织”、“邮件组织”中将其邮件组织为对话或单个邮件, (请参阅更改邮件列表在 Outlook) 中的显示方式。 此设置会影响向用户显示的邮件正文量 (即,邮件的整个对话线程或仅当前邮件) 。 在 Message Compose 模式下,特别是对于回复包含多条消息的对话线程,如果要在设置消息正文时遵循用户的设置,请在setAsync调用中指定bodyMode: Office.MailboxEnums.BodyMode.HostConfig参数。 如果邮件按对话分组,则仅设置当前回复的正文。 相反,如果单独显示邮件,则整个正文(包括对话线程中的先前邮件)将被替换。

  • 在 Outlook 网页版和新的 Outlook on Windows 中,如果未指定该属性或将其设置为 Office.MailboxEnums.BodyMode.FullBody,则bodyMode将替换邮件的整个正文,包括来自对话线程的先前邮件。 即使用户的消息是按对话组织的,这同样适用。 在此方案中,用户的设置暂时更改为 单条消息:不对邮件>进行分组仅一封邮件或在通话期间setAsync将电子邮件显示为单个邮件。 系统会向用户显示一条通知,提醒他们注意此更改。 调用完成后,将恢复用户的设置。

错误:

  • DataExceedsMaximumSize :数据参数超过 1,000,000 个字符。

  • InvalidFormatError : options.coercionType 参数设置为 Office.CoercionType.Html ,并且邮件正文为纯文本。

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/20-item-body/add-inline-base64-image.yaml

// Get the current body of the message or appointment.
Office.context.mailbox.item.body.getAsync(Office.CoercionType.Html, (bodyResult) => {
  if (bodyResult.status === Office.AsyncResultStatus.Failed) {
    console.log(`Failed to get body: ${bodyResult.error.message}`);
    return;
  }

  // Add the Base64-encoded image to the end of the body.
  const options = { isInline: true, asyncContext: bodyResult.value };
  Office.context.mailbox.item.addFileAttachmentFromBase64Async(base64String, "sample.png", options, (attachResult) => {
    if (attachResult.status === Office.AsyncResultStatus.Failed) {
      console.log(`Failed to attach file: ${attachResult.error.message}`);
      return;
    }

    let body = attachResult.asyncContext;
    body += '<img src="cid:sample.png" />';

    Office.context.mailbox.item.body.setAsync(body, { coercionType: Office.CoercionType.Html }, (setResult) => {
      if (setResult.status === Office.AsyncResultStatus.Failed) {
        console.log(`Failed to set body: ${setResult.error.message}`);
        return;
      }
      
      console.log("Inline Base64-encoded image added to the end of the body.");
    });
  });
});

setAsync(data, callback)

将整个正文替换为指定的文本。

setAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

参数

data

string

将替换现有正文的字符串。 字符串限制为 1,000,000 个字符。

callback

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

可选。 方法完成后,将使用类型为 Office.AsyncResult 的单个参数调用传入参数的 callback 函数。 asyncResult.error 属性中将提供遇到的所有错误。

返回

void

注解

API 集:邮箱 1.3

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

适用的 Outlook 模式:Compose

建议:调用 getTypeAsync,然后将返回的值传递给 options.coercionType 参数。

重要说明:

  • 正文替换为指定内容后,光标的位置取决于加载项正在运行的客户端。 在经典 Windows 版 Outlook 中,光标显示在邮件项正文的开头。 在 Outlook 网页版和新版 Outlook on Windows 中,光标显示在邮件项目正文的末尾。 在 Mac 上的 Outlook 中,不会保留光标位置。 调用后 prependAsync 光标将消失,仅当用户在邮件项正文中选择某些内容时才会重新显示。

  • 使用 HTML 格式的正文时,请务必注意,该方法返回的 Body.getAsync 值不一定与之前在该方法中 Body.setAsync 传递的值完全相同。 客户端可以修改传递给 setAsync 的值,以使其使用其呈现引擎高效呈现。

  • 在 HTML 标记中包含链接时,可以通过将定位点 () >< 上的属性设置为id“LPNoLP”来禁用联机链接预览。 例如, '<a id="LPNoLP" href="http://www.contoso.com">Click here!</a>'.

  • 在 Windows (经典) 和 Mac 上的 Outlook 中,加载项用户无法使用“撤销”命令还原此操作。

  • 在 Android 和 iOS 上的 Outlook 中,Message Compose 模式不支持此方法。 仅支持约会组织者模式。 有关 Outlook 移动版中支持的 API 的详细信息,请参阅移动设备上的 Outlook 支持的 Outlook JavaScript API。

  • 不支持 SVG 文件。 请改用 JPG 或 PNG 文件。

  • 该 setAsync 方法不支持内联 CSS。 请改用内部或外部 CSS。

  • 当前使用该loadItemByIdAsync方法加载的消息不支持此setAsync方法。 有关详细信息,请参阅 在多封邮件上激活 Outlook 加载项。

  • 在 Windows 上的 Outlook 网页版 和新版 Outlook 中,用户可以在“设置>”、“邮件>布局>”、“邮件组织”、“邮件组织”中将其邮件组织为对话或单个邮件, (请参阅更改邮件列表在 Outlook) 中的显示方式。 此设置会影响向用户显示的邮件正文量 (即,邮件的整个对话线程或仅当前邮件) 。 在 Message Compose 模式下,特别是对于包含多条消息的对话线程中的回复,如果要在设置消息正文时遵循用户的设置,请在调用中setAsync指定bodyMode: Office.MailboxEnums.BodyMode.HostConfig参数。 如果邮件按对话分组,则仅设置当前回复的正文。 相反,如果单独显示邮件,则整个正文(包括对话线程中的先前邮件)将被替换。

  • 在 Outlook 网页版和新的 Outlook on Windows 中,如果未指定该属性或将其设置为 Office.MailboxEnums.BodyMode.FullBody,则bodyMode将替换邮件的整个正文,包括来自对话线程的先前邮件。 即使用户的消息是按对话组织的,这同样适用。 在此方案中,用户的设置暂时更改为 单条消息:不对邮件>进行分组仅一封邮件或在通话期间setAsync将电子邮件显示为单个邮件。 系统会向用户显示一条通知,提醒他们注意此更改。 调用完成后,将恢复用户的设置。

错误:

  • DataExceedsMaximumSize :数据参数超过 1,000,000 个字符。

  • InvalidFormatError : options.coercionType 参数设置为 Office.CoercionType.Html ,并且邮件正文为纯文本。

setSelectedDataAsync(data, options, callback)

将正文中的所选内容更换为指定文本。

setSelectedDataAsync 方法将指定的字符串插入项目正文中的光标位置,或者,如果在编辑器中选定了文本,它就会替换所选文本。 如果光标从未出现在项目正文中,或者如果该项目的正文不关注 UI,该字符串将插入到正文内容的顶部。 插入后,光标放置在插入内容的末尾。

setSelectedDataAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

参数

data

string

将替换现有正文的字符串。 字符串限制为 1,000,000 个字符。

options

Office.AsyncContextOptions & Office.CoercionTypeOptions

包含以下一个或多个属性的对象文本:- asyncContext:开发人员可以在回调函数中提供他们希望访问的任何对象。 coercionType :所需的正文格式。 参数中的字符串将转换为此格式。

callback

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

可选。 当该方法完成时, callback 将使用类型 Office.AsyncResult为 . asyncResult.error 属性中将提供遇到的所有错误。

返回

void

注解

API 集:邮箱 1.1

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

适用的 Outlook 模式:Compose

建议:调用 getTypeAsync ,然后将返回的值传递给 options.coercionType 参数。

重要说明:

  • 在 HTML 标记中包含链接时,可以通过将定位点 () >< 上的属性设置为id“LPNoLP”来禁用联机链接预览。 例如, '<a id="LPNoLP" href="http://www.contoso.com">Click here!</a>'.

  • 不支持 SVG 文件。 请改用 JPG 或 PNG 文件。

  • 该 setSelectedDataAsync 方法不支持内联 CSS。 请改用内部或外部 CSS。

  • 当前使用该loadItemByIdAsync方法加载的消息不支持此setSelectedDataAsync方法。 有关详细信息,请参阅 在多封邮件上激活 Outlook 加载项。

错误:

  • DataExceedsMaximumSize :参数 data 超过 1,000,000 个字符。

  • InvalidFormatError : options.coercionType 参数设置为 Office.CoercionType.Html ,并且邮件正文为纯文本。

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/20-item-body/replace-selected-text.yaml

/* This snippet replaces selected text in a message or appointment's body with specified text.

  If you want to use a link in HTML markup as a value of the setSelectedDataAsync call's data parameter, you can disable online link preview by setting the anchor tag's id attribute to "LPNoLP". For example, '<a id="LPNoLP" href="https://www.contoso.com">Click here!</a>'.
*/
const text = (document.getElementById("text-field") as HTMLInputElement).value;

// It's recommended to call getTypeAsync and pass its returned value to the options.coercionType parameter of the prependAsync call.
Office.context.mailbox.item.body.getTypeAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log("Action failed with error: " + asyncResult.error.message);
    return;
  }

  const bodyFormat = asyncResult.value;
  Office.context.mailbox.item.body.setSelectedDataAsync(text, { coercionType: bodyFormat }, (asyncResult) => {
    if (asyncResult.status === Office.AsyncResultStatus.Failed) {
      console.log("Action failed with error: " + asyncResult.error.message);
      return;
    }

    console.log(`Replaced selected text with "${text}".`);
  });
});

setSelectedDataAsync(data, callback)

将正文中的所选内容更换为指定文本。

setSelectedDataAsync 方法将指定的字符串插入项目正文中的光标位置,或者,如果在编辑器中选定了文本,它就会替换所选文本。 如果光标从未出现在项目正文中,或者如果该项目的正文不关注 UI,该字符串将插入到正文内容的顶部。 插入后,光标放置在插入内容的末尾。

setSelectedDataAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

参数

data

string

将替换现有正文的字符串。 字符串限制为 1,000,000 个字符。

callback

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

可选。 当该方法完成时, callback 将使用类型 Office.AsyncResult为 . asyncResult.error 属性中将提供遇到的所有错误。

返回

void

注解

API 集:邮箱 1.1

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

适用的 Outlook 模式:Compose

建议:调用 getTypeAsync ,然后将返回的值传递给 options.coercionType 参数。

重要说明:

  • 在 HTML 标记中包含链接时,可以通过将定位点 () >< 上的属性设置为id“LPNoLP”来禁用联机链接预览。 例如, '<a id="LPNoLP" href="http://www.contoso.com">Click here!</a>'.

  • 不支持 SVG 文件。 请改用 JPG 或 PNG 文件。

  • 该 setSelectedDataAsync 方法不支持内联 CSS。 请改用内部或外部 CSS。

  • 当前使用该loadItemByIdAsync方法加载的消息不支持此setSelectedDataAsync方法。 有关详细信息,请参阅 在多封邮件上激活 Outlook 加载项。

错误:

  • DataExceedsMaximumSize :参数 data 超过 1,000,000 个字符。

  • InvalidFormatError : options.coercionType 参数设置为 Office.CoercionType.Html ,并且邮件正文为纯文本。

setSignatureAsync(data, options, callback)

如果项正文没有现有签名,则向其添加签名。 如果正文中已有签名,则替换该签名。

setSignatureAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

参数

data

string

表示要在邮件正文中设置的签名的字符串。 此字符串限制为 30,000 个字符。

options

Office.AsyncContextOptions & Office.CoercionTypeOptions

包含以下一个或多个属性的对象文本:- asyncContext:开发人员可以在回调函数中提供他们希望访问的任何对象。 coercionType :签名应设置为的格式。 如果为 Text,则该方法将签名设置为纯文本,删除存在的任何 HTML 标记。 如果为 Html,则该方法会将签名设置为 HTML。

callback

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

可选。 当该方法完成时, callback 将使用类型 Office.AsyncResult为 .

返回

void

注解

API 集:邮箱 1.10

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

适用的 Outlook 模式:Compose

重要说明:

  • 在 Outlook 网页版和新版 Outlook on Windows 中,setSignatureAsync仅适用于邮件。

  • 从 4.2352.0 版开始,Android 上的 Outlook 和 iOS 上的 Message Compose 支持此方法。 有关示例方案,请参阅在 Outlook 移动加载项中实现基于事件的激活。若要详细了解 Outlook 移动版支持的 API,请参阅移动设备上的 Outlook 支持的 Outlook JavaScript API。

  • 如果在清单中使用 LaunchEvent 实现基于事件的激活功能的加载项的事件处理程序中调用它,则行为setSignatureAsync会有所不同。 当用户撰写新项 (包括回复或转发) 时,签名会设置,但不会修改表单。 这意味着,如果用户关闭表单而没有进行其他编辑,则不会提示他们保存更改。

  • 邮件签名不支持 SVG 文件。 请改用 JPG 或 PNG 文件。

  • 该 setSignatureAsync 方法不支持内联 CSS。 请改用内部或外部 CSS。

  • 当前使用该loadItemByIdAsync方法加载的消息不支持此setSignatureAsync方法。 有关详细信息,请参阅 在多封邮件上激活 Outlook 加载项。

错误:

  • DataExceedsMaximumSize :参数 data 超过 30,000 个字符。

  • InvalidFormatError : options.coercionType 参数设置为 Office.CoercionType.Html ,并且邮件正文为纯文本。

示例

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

// Set the signature for the current item with inline image.
const modIcon1Base64 = "iVBORw0KGgoAAAANSUhEUgAAABwAAAAcCAYAAAByDd+UAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAA2ZpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMC1jMDYxIDY0LjE0MDk0OSwgMjAxMC8xMi8wNy0xMDo1NzowMSAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wTU09Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9tbS8iIHhtbG5zOnN0UmVmPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvc1R5cGUvUmVzb3VyY2VSZWYjIiB4bWxuczp4bXA9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC8iIHhtcE1NOk9yaWdpbmFsRG9jdW1lbnRJRD0ieG1wLmRpZDpDRDMxMDg1MjBCNDZFMTExODE2MkM1RUI2M0M4MDYxRCIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDpFMTUxQjgyRjQ2MEQxMUUxODlFMkQwNTYzQ0YwMTUxMiIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDpFMTUxQjgyRTQ2MEQxMUUxODlFMkQwNTYzQ0YwMTUxMiIgeG1wOkNyZWF0b3JUb29sPSJBZG9iZSBQaG90b3Nob3AgQ1M1LjEgV2luZG93cyI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOkQxMzEwODUyMEI0NkUxMTE4MTYyQzVFQjYzQzgwNjFEIiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZGlkOkNEMzEwODUyMEI0NkUxMTE4MTYyQzVFQjYzQzgwNjFEIi8+IDwvcmRmOkRlc2NyaXB0aW9uPiA8L3JkZjpSREY+IDwveDp4bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8+uC/WfAAAAehJREFUeNpilCzfwEAEkAbiECA2A2J1IOaHin8E4ptAfBaIVwLxU0IGMRKw0B6IW4DYhoE4cASIK6E0VsCEQ1wUiNcB8QESLGOAqj0MxBuhZhBloS4QnwHiQAbygR/UDF1CFupCXSjHQDmQg5qli8tCUBBsQUoQ1AD8UDNFsVk4n0o+w+bT+egWglKjNymmeGhLkqLcG2oHAwtUoIuQDj5OVgZPLUmwRe5aEmAxqYqNpFgKssOcCeplM0KqdST5GfpDDRm0JfkYrj3/SE7QguyQY4ImYYLgCtAS10kHGMw6dzNsv/qC7OwCClJXYlR++v6b4er3j5QmIFcmaNlIL6AOslCIjhYKMTHQGTBBqxh6gXcgC6/R0cKbIAv30dHCfaAKGJTxHxJSqS3Fz9DkowNmywpyMcgA8fF7b8D8VWcfM6w8+4gYC+VB+RCk8hSh0gaUD4/dewvlvUWRe/z+GzGWgex4BGtiOAHxXhoHpzMoSGHZAhSPW2lo2VZYWkHOh4nEtLrIAE+hZmNUwK+B2BOIv1PRsu9QM1/jatNcBtVZ0IREKXgENesyoVYbzNIdFFi2A5tl+NqlL6BB4QBNzsSCU1A9nlAzMAALAQMOQl0qB23qWwKxIlIrDBQ394H4OBCvISYqAAIMACVibHDqsO7zAAAAAElFTkSuQmCC";
Office.context.mailbox.item.addFileAttachmentFromBase64Async(
  modIcon1Base64,
  "myImage.png",
  { isInline: true },
  function(result) {
    if (result.status == Office.AsyncResultStatus.Succeeded) {
      const signature = (document.getElementById("signature") as HTMLInputElement).value + "<img src='cid:myImage.png'>";
      console.log(`Setting signature to "${signature}".`);
      Office.context.mailbox.item.body.setSignatureAsync(
        signature,
        { coercionType: "html" },
        function(asyncResult) {
          console.log(`setSignatureAsync: ${asyncResult.status}`);
        }
      );
    } else {
      console.error(`addFileAttachmentFromBase64Async: ${result.error}`);
    }
  }
);

...

// Set the signature for the current item.
const signature = (document.getElementById("signature") as HTMLInputElement).value;
console.log(`Setting signature to "${signature}".`);
Office.context.mailbox.item.body.setSignatureAsync(signature, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("setSignatureAsync succeeded");
  } else {
    console.error(asyncResult.error);
  }
});

setSignatureAsync(data, callback)

如果项正文没有现有签名,则向其添加签名。 如果正文中已有签名,则替换该签名。

setSignatureAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

参数

data

string

表示要在邮件正文中设置的签名的字符串。 此字符串限制为 30,000 个字符。

callback

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

可选。 当该方法完成时, callback 将使用类型 Office.AsyncResult为 .

返回

void

注解

API 集:邮箱 1.10

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

适用的 Outlook 模式:Compose

重要说明:

  • 在 Outlook 网页版和新版 Outlook on Windows 中,setSignatureAsync仅适用于邮件。

  • 从 4.2352.0 版开始,Android 上的 Outlook 和 iOS 上的 Message Compose 支持此方法。 有关示例方案,请参阅在 Outlook 移动加载项中实现基于事件的激活。若要详细了解 Outlook 移动版支持的 API,请参阅移动设备上的 Outlook 支持的 Outlook JavaScript API。

  • 如果在清单中使用 LaunchEvent 实现基于事件的激活功能的加载项的事件处理程序中调用它,则行为setSignatureAsync会有所不同。 当用户撰写新项 (包括回复或转发) 时,签名会设置,但不会修改表单。 这意味着,如果用户关闭表单而没有进行其他编辑,则不会提示他们保存更改。

  • 邮件签名不支持 SVG 文件。 请改用 JPG 或 PNG 文件。

  • 该 setSignatureAsync 方法不支持内联 CSS。 请改用内部或外部 CSS。

  • 当前使用该loadItemByIdAsync方法加载的消息不支持此setSignatureAsync方法。 有关详细信息,请参阅 在多封邮件上激活 Outlook 加载项。

错误:

  • DataExceedsMaximumSize :参数 data 超过 30,000 个字符。

  • InvalidFormatError : options.coercionType 参数设置为 Office.CoercionType.Html ,并且邮件正文为纯文本。