Office.InternetHeaders interface

对象表示在邮件项目离开邮件后保留的自定义 internet InternetHeaders Exchange并转换为 MIME 邮件。 这些邮件头在 MIME 邮件中存储为 x 标头。

Internet 标头按项存储为键/值对。

注意:此对象用于设置和获取邮件项目的自定义邮件头。 若要了解更多信息,请参阅Get and set internet headers on a message in an Outlook add-in.

注解

[API 集:Mailbox 1.8 ]

建议的做法

目前,Internet 邮件头是用户邮箱上的有限资源。 当配额用尽时,你无法在此邮箱上再创建一个 Internet 标头,这可能会导致依赖此功能的客户端发生意外行为。

在外接程序中创建 Internet 标头时,请应用以下准则。

  • 创建所需的最小标头数。

  • 命名标头,以便以后可以重复使用和更新其值。 因此,避免以可变方式命名标头 (,例如,根据用户输入、时间戳等) 。

最低权限级别 ReadItem

适用的Outlook模式 :撰写

方法

getAsync(names, options, callback)

如果给定一组 Internet 标头名称,此方法将返回包含这些 Internet 标头及其值的字典。 如果外接程序请求不可用的 x 标头,将不会在结果中返回该 x 标头。

注意:此方法用于返回使用 方法设置的自定义标头 setAsync 的值。

getAsync(names, callback)

如果给定一组 Internet 标头名称,此方法将返回包含这些 Internet 标头及其值的字典。 如果外接程序请求不可用的 x 标头,将不会在结果中返回该 x 标头。

注意:此方法用于返回使用 方法设置的自定义标头 setAsync 的值。

removeAsync(names, options, callback)

在给定 Internet 标头名称的数组后,此方法从 Internet 标头集合中删除指定的标头。

注意:此方法用于删除使用 方法设置的自定义 setAsync 标头。

removeAsync(names, callback)

在给定 Internet 标头名称的数组后,此方法从 Internet 标头集合中删除指定的标头。

注意:此方法用于删除使用 方法设置的自定义 setAsync 标头。

setAsync(headers, options, callback)

将指定的 Internet 标头设置指定的值。

如果指定的标头不存在,该方法将创建新的标头;否则,现有值将 setAsync 替换为新值。

注意:此方法用于设置自定义标头的值。

setAsync(headers, callback)

将指定的 Internet 标头设置指定的值。

如果指定的标头不存在,该方法将创建新的标头;否则,现有值将 setAsync 替换为新值。

注意:此方法用于设置自定义标头的值。

方法详细信息

getAsync(names, options, callback)

如果给定一组 Internet 标头名称,此方法将返回包含这些 Internet 标头及其值的字典。 如果外接程序请求不可用的 x 标头,将不会在结果中返回该 x 标头。

注意:此方法用于返回使用 方法设置的自定义标头 setAsync 的值。

getAsync(names: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<InternetHeaders>) => void): void;

参数

names

string[]

要返回的 Internet 标头的名称。

options
Office.AsyncContextOptions

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

callback

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

可选。 方法完成后,使用单个参数调用参数中传递 callback 的函数。 asyncResult,这是 Office.AsyncResult 一个对象。

返回

void

注解

[API 集:Mailbox 1.8 ]

最低权限级别 ReadItem

适用的Outlook模式 :撰写

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/70-mime-headers/manage-custom-internet-headers-message-compose.yaml
Office.context.mailbox.item.internetHeaders.getAsync(
  ["x-preferred-fruit", "x-preferred-vegetable", "x-best-vegetable", "x-nonexistent-header"],
  function (asyncResult) {
    if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
      console.log("Selected headers: " + JSON.stringify(asyncResult.value));
    } else {
      console.log("Error getting selected headers: " + JSON.stringify(asyncResult.error));
    }
  }
);

getAsync(names, callback)

如果给定一组 Internet 标头名称,此方法将返回包含这些 Internet 标头及其值的字典。 如果外接程序请求不可用的 x 标头,将不会在结果中返回该 x 标头。

注意:此方法用于返回使用 方法设置的自定义标头 setAsync 的值。

getAsync(names: string[], callback?: (asyncResult: Office.AsyncResult<InternetHeaders>) => void): void;

参数

names

string[]

要返回的 Internet 标头的名称。

callback

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

可选。 方法完成后,使用单个参数调用参数中传递 callback 的函数。 asyncResult,这是 Office.AsyncResult 一个对象。

返回

void

注解

[API 集:Mailbox 1.8 ]

最低权限级别 ReadItem

适用的Outlook模式 :撰写

removeAsync(names, options, callback)

在给定 Internet 标头名称的数组后,此方法从 Internet 标头集合中删除指定的标头。

注意:此方法用于删除使用 方法设置的自定义 setAsync 标头。

removeAsync(names: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<InternetHeaders>) => void): void;

参数

names

string[]

要删除的 Internet 标头的名称。

options
Office.AsyncContextOptions

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

callback

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

可选。 方法完成后,使用单个参数调用参数中传递 callback 的函数。 asyncResult,这是 Office.AsyncResult 一个对象。

返回

void

注解

[API 集:Mailbox 1.8 ]

最低权限级别 ReadWriteItem

适用的Outlook模式 :撰写

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/70-mime-headers/manage-custom-internet-headers-message-compose.yaml
Office.context.mailbox.item.internetHeaders.removeAsync(
  ["x-best-vegetable", "x-nonexistent-header"],
  function (asyncResult) {
    if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
      console.log("Successfully removed selected headers");
    } else {
      console.log("Error removing selected headers: " + JSON.stringify(asyncResult.error));
    }
  }
);

removeAsync(names, callback)

在给定 Internet 标头名称的数组后,此方法从 Internet 标头集合中删除指定的标头。

注意:此方法用于删除使用 方法设置的自定义 setAsync 标头。

removeAsync(names: string[], callback?: (asyncResult: Office.AsyncResult<InternetHeaders>) => void): void;

参数

names

string[]

要删除的 Internet 标头的名称。

callback

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

可选。 方法完成后,使用单个参数调用参数中传递 callback 的函数。 asyncResult,这是 Office.AsyncResult 一个对象。

返回

void

注解

[API 集:Mailbox 1.8 ]

最低权限级别 ReadWriteItem

适用的Outlook模式 :撰写

setAsync(headers, options, callback)

将指定的 Internet 标头设置指定的值。

如果指定的标头不存在,该方法将创建新的标头;否则,现有值将 setAsync 替换为新值。

注意:此方法用于设置自定义标头的值。

setAsync(headers: Object, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

参数

headers

Object

要设置的标头的名称和相应值。 应为字典对象,其中键是 Internet 标头的名称,值是 Internet 标头的值。

options
Office.AsyncContextOptions

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

callback

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

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

返回

void

注解

[API 集:Mailbox 1.8 ]

最低权限级别 ReadWriteItem

适用的Outlook模式 :撰写

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/70-mime-headers/manage-custom-internet-headers-message-compose.yaml
Office.context.mailbox.item.internetHeaders.setAsync(
  { "x-preferred-fruit": "orange", "x-preferred-vegetable": "broccoli", "x-best-vegetable": "spinach" },
  function (asyncResult) {
    if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
      console.log("Successfully set headers");
    } else {
      console.log("Error setting headers: " + JSON.stringify(asyncResult.error));
    }
  }

);

setAsync(headers, callback)

将指定的 Internet 标头设置指定的值。

如果指定的标头不存在,该方法将创建新的标头;否则,现有值将 setAsync 替换为新值。

注意:此方法用于设置自定义标头的值。

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

参数

headers

Object

要设置的标头的名称和相应值。 应为字典对象,其中键是 Internet 标头的名称,值是 Internet 标头的值。

callback

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

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

返回

void

注解

[API 集:Mailbox 1.8 ]

最低权限级别 ReadWriteItem

适用的Outlook模式 :撰写