Office.Subject interface

包:

outlook

提供用于获取和设置 Outlook 外接程序中的约会或邮件的主题的方法。

注解

API 集：邮箱 1.1

最低权限级别： 读取项目

适用的 Outlook 模式：Compose

使用方

• Office.AppointmentCompose： subject
• Office.LoadedMessageCompose： subject
• Office.MessageCompose： subject

方法

getAsync(options, callback)	获取约会或邮件的主题。 getAsync 方法开始对 Exchange 服务器进行异步调用，以获取约会或邮件的主题。
getAsync(callback)	获取约会或邮件的主题。 getAsync 方法开始对 Exchange 服务器进行异步调用，以获取约会或邮件的主题。
setAsync(subject, options, callback)	设置约会或邮件的主题。 setAsync 方法开始对 Exchange 服务器进行异步调用，以设置约会或邮件的主题。 设置主题将覆盖当前主题，但会保留所有前缀，如“Fwd:”或“Re:”。
setAsync(subject, callback)	设置约会或邮件的主题。 setAsync 方法开始对 Exchange 服务器进行异步调用，以设置约会或邮件的主题。 设置主题将覆盖当前主题，但会保留所有前缀，如“Fwd:”或“Re:”。

方法详细信息

getAsync(options, callback)

获取约会或邮件的主题。

getAsync 方法开始对 Exchange 服务器进行异步调用，以获取约会或邮件的主题。

getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;

参数

options

Office.AsyncContextOptions

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

callback

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

当该方法完成时， callback 将使用类型 Office.AsyncResult为 . value结果的属性是项的主题。

返回

void

注解

API 集：邮箱 1.1

最低权限级别： 读取项目

适用的 Outlook 模式：Compose

getAsync(callback)

获取约会或邮件的主题。

getAsync 方法开始对 Exchange 服务器进行异步调用，以获取约会或邮件的主题。

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

参数

callback

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

当该方法完成时， callback 将使用类型 Office.AsyncResult为 . value结果的属性是项的主题。

返回

void

注解

API 集：邮箱 1.1

最低权限级别： 读取项目

适用的 Outlook 模式：Compose

示例

Office.context.mailbox.item.subject.getAsync(callback);

function callback(asyncResult) {
    const subject = asyncResult.value;
}

setAsync(subject, options, callback)

设置约会或邮件的主题。

setAsync 方法开始对 Exchange 服务器进行异步调用，以设置约会或邮件的主题。 设置主题将覆盖当前主题，但会保留所有前缀，如“Fwd:”或“Re:”。

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

参数

subject

string

约会或邮件的主题。 字符串长度限制为 255 个字符。

options

Office.AsyncContextOptions

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

callback

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

可选。 当该方法完成时， callback 将使用类型 Office.AsyncResult为 . 如果设置主题失败，asyncResult.error 属性将包含一个错误代码。

返回

void

注解

API 集：邮箱 1.1

最低权限级别： 读取项目

适用的 Outlook 模式：Compose

重要说明：

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

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

错误：

• DataExceedsMaximumSize ：主题参数超过 255 个字符。

示例

Office.context.mailbox.item.subject.setAsync("New subject!", function (asyncResult) {
    if (asyncResult.status === "failed") {
        console.log("Action failed with error: " + asyncResult.error.message);
    }
});

setAsync(subject, callback)

设置约会或邮件的主题。

setAsync 方法开始对 Exchange 服务器进行异步调用，以设置约会或邮件的主题。 设置主题将覆盖当前主题，但会保留所有前缀，如“Fwd:”或“Re:”。

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

参数

subject

string

约会或邮件的主题。 字符串长度限制为 255 个字符。

callback

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

可选。 当该方法完成时， callback 将使用类型 Office.AsyncResult为 . 如果设置主题失败，asyncResult.error 属性将包含一个错误代码。

返回

void

注解

API 集：邮箱 1.1

最低权限级别： 读取项目

适用的 Outlook 模式：Compose

重要说明：

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

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

错误：

• DataExceedsMaximumSize ：主题参数超过 255 个字符。