Office.AddinCommands.EventCompletedOptions interface

包:

office

指定 Outlook 中 正在发送 的加载项在完成事件处理 ItemSend 时的行为。

注解

[ API set： Mailbox 1.8 ]

最低权限级别： 受限

适用的 Outlook 模式：撰写

属性

allowEvent

使用 completed 方法 指示事件处理程序完成时，此值指示处理的事件应继续执行还是取消。 例如，处理 ItemSend 事件的 on-send 加载项可以设置为 allowEventfalse 以取消发送消息。

属性详细信息

allowEvent

使用 completed 方法 指示事件处理程序完成时，此值指示处理的事件应继续执行还是取消。 例如，处理 ItemSend 事件的 on-send 加载项可以设置为 allowEventfalse 以取消发送消息。

allowEvent?: boolean;

属性值

boolean

注解

[ API set： Mailbox 1.8 ]

Outlook) 的最低权限级别 (：受限

适用的 Outlook 模式：撰写

示例

// In this example, the checkMessage function was registered as an event handler for ItemSend.
function checkMessage(event) {
    // Get the item being sent.
    const outgoingMsg = Office.context.mailbox.item;

    // Check if subject contains "BLOCK".
    outgoingMsg.subject.getAsync(function (result) {
        // Subject is in `result.value`.
        // If search term "BLOCK" is found, don't send the message.
        const notFound = -1;
        const allowEvent = (result.value.indexOf('BLOCK') === notFound);
        event.completed({ allowEvent: allowEvent });
    });
}