Office.MailboxEvent interface
The MailboxEvent object is passed as an argument to the event handler of an add-in that implements event-based activation, including Smart Alerts, the integrated spam-reporting feature, or decryption. It allows the add-in to signify to the Outlook client that it has completed processing an event.
Remarks
[Api set: Mailbox 1.10]
Minimum permission level: restricted
Applicable Outlook mode: Compose or Read
Important:
Support for the integrated spam-reporting feature was introduced in Mailbox 1.14.
Support for the decryption feature was introduced in Mailbox 1.16.
For information about the Event object used by the function command button, on-send add-in, online-meeting provider add-in, and note-logging mobile add-in, see Office.AddinCommands.Event.
Methods
| completed(options) | Indicates that the event-based, spam-reporting, or decryption add-in has completed processing an event. |
Method Details
completed(options)
Indicates that the event-based, spam-reporting, or decryption add-in has completed processing an event.
completed(options?: SmartAlertsEventCompletedOptions | SpamReportingEventCompletedOptions | MessageDecryptEventCompletedOptions): void;Parameters
- options
-
Office.SmartAlertsEventCompletedOptions | Office.SpamReportingEventCompletedOptions | Office.MessageDecryptEventCompletedOptions
Optional. An object that specifies the behavior of an event-based, spam-reporting, or decryption add-in when it completes processing an event.
Returns
void
Remarks
[Api set: Mailbox 1.10]
Minimum permission level: restricted
Applicable Outlook mode: Compose or Read
Important:
Support for the integrated spam-reporting feature was introduced in Mailbox 1.14.
Support to assign a
SmartAlertsEventCompletedOptionsobject to theoptionsparameter was introduced in Mailbox 1.12.Support for the decryption feature was introduced in Mailbox 1.16.