Office.From interface
提供一种从 Outlook 外接程序中邮件的值获取 的方法。
注解
最低权限级别: 读取项
重要提示:Android 版和 iOS 版 Outlook 支持此接口。 有关示例方案,请参阅 在 Outlook 移动加载项中实现基于事件的激活。
方法
get |
获取消息的 from 值。 方法 项的 from 值在 属性中 |
get |
获取消息的 from 值。 方法 项的 from 值在 属性中 |
方法详细信息
getAsync(options, callback)
获取消息的 from 值。
方法 getAsync
启动对 Exchange 服务器的异步调用,以从消息的值获取 。
项的 from 值在 属性中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
可选。 方法完成后,使用单个参数 asyncResult
(即 Office.AsyncResult
对象)调用在 参数中callback
传递的函数。 结果 value
的 属性是项的 ,作为 对象 EmailAddressDetails
。
返回
void
注解
最低权限级别: 读取项
重要说明:
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)
获取消息的 from 值。
方法 getAsync
启动对 Exchange 服务器的异步调用,以从消息的值获取 。
项的 from 值在 属性中asyncResult.value
作为 EmailAddressDetails 提供。
getAsync(callback?: (asyncResult: Office.AsyncResult<EmailAddressDetails>) => void): void;
参数
- callback
-
(asyncResult: Office.AsyncResult<Office.EmailAddressDetails>) => void
可选。 方法完成后,使用单个参数 asyncResult
(即 Office.AsyncResult
对象)调用在 参数中callback
传递的函数。 结果 value
的 属性是项的 ,作为 对象 EmailAddressDetails
。
返回
void
注解
最低权限级别: 读取项
重要说明:
Android 版和 iOS 版 Outlook 支持此方法。 有关示例方案,请参阅在 Outlook 移动加载项中实现基于事件的激活。若要详细了解 Outlook 移动版支持的 API,请参阅移动设备上 Outlook 支持的 Outlook JavaScript API。
recipientType
方法不返回getAsync
属性值。 电子邮件发件人始终是电子邮件地址位于 Exchange 服务器上的用户。