通过

Office.Ews interface

包:
outlook

注意

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

提供用于确定组织中是否支持 Exchange Web Services (EWS) 回调令牌的方法。

注解

[ API 集：邮箱预览 ]

最低权限级别： 读取项

适用的 Outlook 模式：Compose或读取

重要提示：旧版Exchange Online用户标识令牌和回调令牌不再受支持，所有Microsoft 365 个租户均处于关闭状态。 如果 Outlook 外接程序需要委派的用户访问或用户标识，我们建议使用 MSAL (Microsoft 身份验证库) 和嵌套应用身份验证 (NAA) 。 本地 Exchange 仍支持 Exchange 用户标识令牌。 有关详细信息，请参阅 嵌套应用身份验证常见问题解答。

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/99-preview-apis/get-token-status.yaml

Office.context.mailbox.diagnostics.ews.getTokenStatusAsync({ isRest: false }, (result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.log(result.error.message);
    return;
  }
  const status = result.value;
  switch (status) {
    case Office.MailboxEnums.TokenStatus.Enabled:
      console.log("EWS callback tokens are enabled.");
      break;
    case Office.MailboxEnums.TokenStatus.Disabled:
      console.log("EWS callback tokens are disabled.");
      break;
    case Office.MailboxEnums.TokenStatus.Removed:
      console.log(
        "The organization has an Exchange Online environment. Legacy Exchange tokens are no longer supported.",
      );
      break;
  }
});

方法

getTokenStatusAsync(options, callback)

获取组织中 EWS 回调令牌的状态。
getTokenStatusAsync(callback)

获取组织中 EWS 回调令牌的状态。

方法详细信息

getTokenStatusAsync(options, callback)

注意

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

获取组织中 EWS 回调令牌的状态。

getTokenStatusAsync(options: Office.AsyncContextOptions & { isRest?: boolean }, callback: (asyncResult: Office.AsyncResult<MailboxEnums.TokenStatus>) => void): void;

参数

options

Office.AsyncContextOptions & { isRest?: boolean }

包含一个或多个以下属性的对象文本。 asyncContext ：要在回调函数中访问的任何数据。 isRest ：标识所需的令牌是用于 EWS 还是 Outlook REST API。 默认情况下， isRest 属性设置为 false。

callback

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

方法完成后，使用 Office.AsyncResult 类型的单个参数调用在 参数中 callback 传递的函数。 属性asyncResult.value返回令牌状态，可以是Office.MailboxEnums.TokenStatus.Enabled 、 Office.MailboxEnums.TokenStatus.Disabled或 Office.MailboxEnums.TokenStatus.Removed。 状态Office.MailboxEnums.TokenStatus.Removed指示邮箱托管在Exchange Online环境中，旧 Exchange 令牌已关闭且不再受支持。

返回

void

注解

[ API 集：邮箱预览 ]

最低权限级别： 读取项

适用的 Outlook 模式：Compose或读取

重要说明：

  • 方法getTokenStatusAsync在 Outlook 网页版 和 Windows (新的和经典 (版本 2510、内部版本 19328.20000 及更高版本) ) 中提供预览版。

  • getTokenStatusAsync如果在 Outlook.com 或 Gmail 邮箱中加载加载项，则不支持此方法。

  • getTokenStatusAsync在撰写模式下调用 方法需要保存项目。 方法 saveAsync 需要 读/写项的最低权限级别。

getTokenStatusAsync(callback)

注意

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

获取组织中 EWS 回调令牌的状态。

getTokenStatusAsync(callback: (asyncResult: Office.AsyncResult<MailboxEnums.TokenStatus>) => void): void;

参数

callback

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

方法完成后，使用 Office.AsyncResult 类型的单个参数调用在 参数中 callback 传递的函数。 属性asyncResult.value返回令牌状态，可以是Office.MailboxEnums.TokenStatus.Enabled 、 Office.MailboxEnums.TokenStatus.Disabled或 Office.MailboxEnums.TokenStatus.Removed。 状态Office.MailboxEnums.TokenStatus.Removed指示邮箱托管在Exchange Online环境中，旧 Exchange 令牌已关闭且不再受支持。

返回

void

注解

[ API 集：邮箱预览 ]

最低权限级别： 读取项

适用的 Outlook 模式：Compose或读取

重要说明：

  • 方法getTokenStatusAsync在 Outlook 网页版 和 Windows (新的和经典 (版本 2510、内部版本 19328.20000 及更高版本) ) 中提供预览版。

  • getTokenStatusAsync如果在 Outlook.com 或 Gmail 邮箱中加载加载项，则不支持此方法。

  • getTokenStatusAsync在撰写模式下调用 方法需要保存项目。 方法 saveAsync 需要 读/写项的最低权限级别。