Office.MailboxEvent interface
Объект MailboxEvent передается в качестве аргумента обработчику событий надстройки, реализующей активацию на основе событий, включая интеллектуальные оповещения, встроенную функцию сообщений о спаме или расшифровку. Она позволяет надстройке сообщать клиенту Outlook, что она завершила обработку события.
Комментарии
Минимальный уровень разрешений: restricted
Применимый режим Outlook: Compose или чтение
Важно!
Поддержка встроенной функции сообщений о спаме была добавлена в Mailbox 1.14.
Поддержка функции расшифровки появилась в почтовом ящике 1.16.
Сведения об объекте события, используемом командной кнопкой функции, надстройкой для отправки, надстройкой поставщика собраний по сети и мобильной надстройкой для ведения заметок, см. в статье Office.AddinCommands.Event.
Методы
| completed(options) | Указывает, что надстройка для создания отчетов о нежелательной почте или расшифровки на основе событий завершила обработку события. |
Сведения о методе
completed(options)
Указывает, что надстройка для создания отчетов о нежелательной почте или расшифровки на основе событий завершила обработку события.
completed(options?: SmartAlertsEventCompletedOptions | SpamReportingEventCompletedOptions | MessageDecryptEventCompletedOptions): void;Параметры
- options
-
Office.SmartAlertsEventCompletedOptions | Office.SpamReportingEventCompletedOptions | Office.MessageDecryptEventCompletedOptions
Необязательный параметр. Объект, который определяет поведение надстройки для создания отчетов о спаме или расшифровки на основе событий по завершении обработки события.
Возвращаемое значение
void
Комментарии
Минимальный уровень разрешений: restricted
Применимый режим Outlook: Compose или чтение
Важно!
Поддержка встроенной функции сообщений о спаме была добавлена в Mailbox 1.14.
Поддержка назначения
SmartAlertsEventCompletedOptionsобъекта параметруoptionsбыла введена в Mailbox 1.12.Поддержка функции расшифровки появилась в почтовом ящике 1.16.
Примеры
// 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();
}
);
}