Office.From interface
提供获取 Outlook 加载项中邮件的发件人值的方法。
注解
最低权限级别: 读取项目
适用的 Outlook 模式:Compose
重要提示: Android 版和 iOS 版 Outlook 支持此界面。 有关示例方案,请参阅 在 Outlook 移动加载项中实现基于事件的激活。
使用方
方法
| get |
获取消息的发件人值。 该 项目的“发件人”值在属性中 |
| get |
获取消息的发件人值。 该 项目的“发件人”值在属性中 |
方法详细信息
getAsync(options, callback)
获取消息的发件人值。
该 getAsync 方法开始对 Exchange 服务器进行异步调用,以获取邮件的发件人值。
项目的“发件人”值在属性中asyncResult.value作为 EmailAddressDetails 提供。
getAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<EmailAddressDetails>) => void): void;
参数
- options
- Office.AsyncContextOptions
包含以下一个或多个属性的对象文本:- asyncContext:开发人员可以在回调函数中提供他们希望访问的任何对象。
- callback
-
(asyncResult: Office.AsyncResult<Office.EmailAddressDetails>) => void
可选。 当该方法完成时,将使用单个参数(一个对象)asyncResultOffice.AsyncResult调用传入参数的callback函数。
value结果的属性是项的 from 值作为EmailAddressDetails对象。
返回
void
注解
最低权限级别: 读取项目
适用的 Outlook 模式:Compose
重要说明:
Android 版和 iOS 版 Outlook 支持此方法。 有关示例方案,请参阅在 Outlook 移动加载项中实现基于事件的激活。若要详细了解 Outlook 移动版支持的 API,请参阅移动设备上的 Outlook 支持的 Outlook JavaScript API。
recipientType方法不返回getAsync属性值。 电子邮件发件人始终是电子邮件地址在 Exchange 服务器上的用户。
示例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-from-message-compose.yaml
Office.context.mailbox.item.from.getAsync(function(asyncResult) {
if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
const msgFrom = asyncResult.value;
console.log("Message from: " + msgFrom.displayName + " (" + msgFrom.emailAddress + ")");
} else {
console.error(asyncResult.error);
}
});
getAsync(callback)
获取消息的发件人值。
该 getAsync 方法开始对 Exchange 服务器进行异步调用,以获取邮件的发件人值。
项目的“发件人”值在属性中asyncResult.value作为 EmailAddressDetails 提供。
getAsync(callback?: (asyncResult: Office.AsyncResult<EmailAddressDetails>) => void): void;
参数
- callback
-
(asyncResult: Office.AsyncResult<Office.EmailAddressDetails>) => void
可选。 当该方法完成时,将使用单个参数(一个对象)asyncResultOffice.AsyncResult调用传入参数的callback函数。
value结果的属性是项的 from 值作为EmailAddressDetails对象。
返回
void
注解
最低权限级别: 读取项目
适用的 Outlook 模式:Compose
重要说明:
Android 版和 iOS 版 Outlook 支持此方法。 有关示例方案,请参阅在 Outlook 移动加载项中实现基于事件的激活。若要详细了解 Outlook 移动版支持的 API,请参阅移动设备上的 Outlook 支持的 Outlook JavaScript API。
recipientType方法不返回getAsync属性值。 电子邮件发件人始终是电子邮件地址在 Exchange 服务器上的用户。