Office.MailboxEvent interface

Пакет:

outlook

Объект MailboxEvent передается в качестве аргумента обработчику событий надстройки, которая реализует активацию на основе событий, включая интеллектуальные оповещения или встроенную функцию создания отчетов о нежелательной почте. Это позволяет надстройке означать клиенту Outlook, что она завершила обработку события.

Комментарии

[ Набор API: Почтовый ящик 1.10 ]

Минимальный уровень разрешений: ограниченный

Применимый режим Outlook: Compose или чтение

Важно! В почтовом ящике 1.14 появилась поддержка встроенной функции отчетности о спаме.

Методы

completed(options)

Указывает, что надстройка на основе события или надстройка, сообщающая о спаме, завершила обработку события.

Сведения о методе

completed(options)

Указывает, что надстройка на основе события или надстройка, сообщающая о спаме, завершила обработку события.

completed(options?: SmartAlertsEventCompletedOptions | SpamReportingEventCompletedOptions): void;

Параметры

options

Office.SmartAlertsEventCompletedOptions | Office.SpamReportingEventCompletedOptions

Необязательный параметр. Объект , указывающий поведение надстройки на основе события или надстройки, сообщающей о спаме, после завершения обработки события.

Возвращаемое значение

void

Комментарии

[ Набор API: Почтовый ящик 1.10 ]

Минимальный уровень разрешений: ограниченный

Применимый режим Outlook: Compose или чтение

Важно!

• В почтовом ящике 1.14 появилась поддержка встроенной функции отчетности о спаме.

• Поддержка назначения SmartAlertsEventCompletedOptions объекта параметру options появилась в mailbox 1.12.

Примеры

// The following example sets the subject when a new message is composed.
function onNewMessageComposeHandler(event) {
    const subject = "Set by an event-based add-in!";
    Office.context.mailbox.item.subject.setAsync(
        subject,
        {
            asyncContext: event,
        },
        (asyncResult) => {
            const event = asyncResult.asyncContext;
            if (asyncResult.status === Office.AsyncResultStatus.Failed) {
                console.error("Failed to set subject: " + asyncResult.error.message);
                event.completed();
                return;
            }

            // Signal to the Outlook client that the event has been processed.
            console.log("Successfully set the subject.");
            event.completed();
        }
    );
}