Office.context.mailbox.item
item 用于访问当前选定的邮件、会议请求或约会。 可以使用 属性确定项 itemType 的类型。
要求
| 要求 | 值 |
|---|---|
| 最低版本的邮箱要求集 | 1.1 |
| 最低权限级别 | 限制 |
| 适用的 Outlook 模式 | 约会组织者、约会与会者、 消息Compose或已读消息 |
重要
Android 和 iOS：加载项何时激活以及哪些 API 可用存在限制。 若要了解详细信息，请参阅 将移动支持添加到 Outlook 加载项。
属性
方法
| 方法 | 最小值 权限级别 |
按模式排序的详细信息 | 最小值 要求集 |
|---|---|---|---|
| addFileAttachmentAsync(uri, attachmentName, [options], [callback]) | 读/写项 | 约会组织者 |
1.1 (经典 Windows、Mac) 1.8 (Web，新的 Windows) |
| 邮件撰写 |
1.1 (经典 Windows、Mac) 1.8 (Web，新的 Windows) |
||
| addFileAttachmentFromBase64Async (base64File， attachmentName， [options]， [callback]) | 读/写项 | 约会组织者 | 1.8 |
| 邮件撰写 | 1.8 | ||
| addHandlerAsync(eventType, handler, [options], [callback]) | 读取项 | 约会组织者 | 1.7 |
| 约会与会者 | 1.7 | ||
| 邮件撰写 | 1.7 | ||
| 邮件阅读 | 1.7 | ||
| addItemAttachmentAsync(itemId, attachmentName, [options], [callback]) | 读/写项 | 约会组织者 | 1.1 |
| 邮件撰写 | 1.1 | ||
| close() | 限制 | 约会组织者 | 1.3 |
| 邮件撰写 | 1.3 | ||
| closeAsync ([options]， [callback]) | 读/写项 | 邮件撰写 | 1.14 |
| disableClientSignatureAsync ([options]， [callback]) | 读/写项 | 约会组织者 | 1.10 |
| 邮件撰写 | 1.10 | ||
| displayReplyAllForm(formData) | 读取项 | 约会与会者 | 1.1 |
| 邮件阅读 | 1.1 | ||
| displayReplyAllFormAsync (formData、[options]、[callback]) | 读取项 | 约会与会者 | 1.9 |
| 邮件阅读 | 1.9 | ||
| displayReplyForm(formData) | 读取项 | 约会与会者 | 1.1 |
| 邮件阅读 | 1.1 | ||
| displayReplyFormAsync (formData， [options]， [callback]) | 读取项 | 约会与会者 | 1.9 |
| 邮件阅读 | 1.9 | ||
| getAllInternetHeadersAsync ([options]， [callback]) | 读取项 | 邮件阅读 | 1.8 |
| getAsFileAsync ([options]， 回调) | 读取项 | 邮件阅读 | 1.14 |
| getAttachmentContentAsync (attachmentId， [options]， [callback]) | 读取项 | 约会组织者 | 1.8 |
| 约会与会者 | 1.8 | ||
| 邮件撰写 | 1.8 | ||
| 邮件阅读 | 1.8 | ||
| getAttachmentsAsync ([options]， [callback]) | 读取项 | 约会组织者 | 1.8 |
| 邮件撰写 | 1.8 | ||
| getComposeTypeAsync ([options]， callback) | 读取项 | 邮件撰写 | 1.10 |
| getConversationIndexAsync ([options]， callback) | 读取项 | 邮件撰写 | 1.14 |
| getEntities () (已弃用) | 读取项 | 约会与会者 | 1.1 |
| 邮件阅读 | 1.1 | ||
| getEntitiesByType (entityType) (弃用) | 限制 | 约会与会者 | 1.1 |
| 邮件阅读 | 1.1 | ||
| getFilteredEntitiesByName (name) (已弃用) | 读取项 | 约会与会者 | 1.1 |
| 邮件阅读 | 1.1 | ||
| getInitializationContextAsync ([options]， [callback]) | 读取项 | 约会组织者 | 1.8 |
| 约会与会者 | 1.8 | ||
| 邮件撰写 | 1.8 | ||
| 邮件阅读 | 1.8 | ||
| getItemClassAsync ([options]， callback) | 读取项 | 邮件撰写 | 1.14 |
| getItemIdAsync ([options]， callback) | 读取项 | 约会组织者 | 1.8 |
| 邮件撰写 | 1.8 | ||
| getRegExMatches () | 读取项 | 约会与会者 | 1.1 |
| 邮件阅读 | 1.1 | ||
| getRegExMatchesByName (name) | 读取项 | 约会与会者 | 1.1 |
| 邮件阅读 | 1.1 | ||
| getSelectedDataAsync (coercionType， [options]， 回调) | 读取项 | 约会组织者 | 1.2 |
| 邮件撰写 | 1.2 | ||
| getSelectedEntities () (已弃用) | 读取项 | 约会与会者 | 1.6 |
| 邮件阅读 | 1.6 | ||
| getSelectedRegExMatches () | 读取项 | 约会与会者 | 1.6 |
| 邮件阅读 | 1.6 | ||
| getSharedPropertiesAsync ([options]， callback) | 读取项 | 约会组织者 |
1.8 (共享文件夹支持) 1.13 (共享邮箱支持) |
| 约会与会者 |
1.8 (共享文件夹支持) 1.13 (共享邮箱支持) |
||
| 邮件撰写 |
1.8 (共享文件夹支持) 1.13 (共享邮箱支持) |
||
| 邮件阅读 |
1.8 (共享文件夹支持) 1.13 (共享邮箱支持) |
||
| isClientSignatureEnabledAsync ([options]， callback) | 读取项 | 约会组织者 | 1.10 |
| 邮件撰写 | 1.10 | ||
| loadCustomPropertiesAsync(callback, [userContext]) | 读取项 | 约会组织者 | 1.1 |
| 约会与会者 | 1.1 | ||
| 邮件撰写 | 1.1 | ||
| 邮件阅读 | 1.1 | ||
| removeAttachmentAsync(attachmentId, [options], [callback]) | 读/写项 | 约会组织者 | 1.1 |
| 邮件撰写 | 1.1 | ||
| removeHandlerAsync(eventType, [options], [callback]) | 读取项 | 约会组织者 | 1.7 |
| 约会与会者 | 1.7 | ||
| 邮件撰写 | 1.7 | ||
| 邮件阅读 | 1.7 | ||
| saveAsync([options], callback) | 读/写项 | 约会组织者 | 1.3 |
| 邮件撰写 | 1.3 | ||
| sendAsync ([options]， [callback]) | 读/写邮箱 | 约会组织者 | 1.15 |
| 邮件撰写 | 1.15 | ||
| setSelectedDataAsync(data, [options], callback) | 读/写项 | 约会组织者 | 1.2 |
| 邮件撰写 | 1.2 |
事件
可以分别使用 addHandlerAsync 和 removeHandlerAsync 订阅和 取消订阅以下事件。
| "事件" | 说明 | 最小值 要求集 |
|---|---|---|
AppointmentTimeChanged |
所选的约会或系列的日期或时间已更改。 仅适用于任务窗格实现。 | 1.7 |
AttachmentsChanged |
已将附件添加到项目或已从项目删除附件。 仅适用于任务窗格实现。 | 1.8 |
EnhancedLocationsChanged |
所选约会的位置已更改。 仅适用于任务窗格实现。 | 1.8 |
InfobarClicked |
已从通知消息中选择了一个作。 仅适用于任务窗格实现。 | 1.10 |
InitializationContextChanged |
加载项的任务窗格已从可作邮件、通知、 InsightMessage 智能警报对话框或集成的垃圾邮件报告对话框打开。 仅适用于任务窗格实现。 |
1.15 |
RecipientsChanged |
选定项目或约会位置的收件人列表已更改。 仅适用于任务窗格实现。 | 1.7 |
RecurrenceChanged |
选定系列的定期模式已更改。 仅适用于任务窗格实现。 | 1.7 |
SensitivityLabelChanged |
撰写模式下的邮件或约会的敏感度标签已更改。 仅适用于任务窗格实现。 | 1.13 |
SpamReporting |
Outlook 中报告了未经请求的邮件。 仅适用于函数命令。 | 1.14 |
示例
以下 JavaScript 代码示例显示了如何访问 Outlook 中当前项目的 subject 属性。
// The initialize function is required for all apps.
Office.initialize = function () {
// Checks for the DOM to load using the jQuery ready method.
$(document).ready(function () {
// After the DOM is loaded, app-specific code can run.
const item = Office.context.mailbox.item;
const subject = item.subject;
// Continue with processing the subject of the current item,
// which can be a message or appointment.
});
};