Office.MessageDecryptEventCompletedOptions interface

Package:

outlook

Specifies the behavior of an encryption add-in after it completes processing an OnMessageDecrypt event.

Remarks

[Api set: Mailbox 1.16]

Minimum permission level: read/write item

Applicable Outlook mode: Message Read

Properties

allowEvent	When you use the completed method to signal completion of an event handler, this value indicates if the OnMessageDecrypt event should continue to run or be canceled. If the allowEvent property is set to true, the decrypted contents of the message is displayed.
attachments	When you use the completed method to signal completion of an event handler and set its allowEvent property to true, this property sets the decrypted attachments of the message.
contextData	When you use the completed method to signal completion of an event handler and set its allowEvent property to true, this property specifies any JSON data passed to the add-in for processing.
emailBody	When you use the completed method to signal completion of an event handler and set its allowEvent property to true, this property sets the decrypted contents of the body of the message.

Property Details

allowEvent

When you use the completed method to signal completion of an event handler, this value indicates if the OnMessageDecrypt event should continue to run or be canceled. If the allowEvent property is set to true, the decrypted contents of the message is displayed.

allowEvent: boolean;

Property Value

boolean

Remarks

[Api set: Mailbox 1.16]

Minimum permission level: read/write item

Applicable Outlook mode: Message Read

attachments

When you use the completed method to signal completion of an event handler and set its allowEvent property to true, this property sets the decrypted attachments of the message.

attachments?: DecryptedMessageAttachment[];

Property Value

Office.DecryptedMessageAttachment[]

Remarks

[Api set: Mailbox 1.16]

Minimum permission level: read/write item

Applicable Outlook mode: Message Read

contextData

When you use the completed method to signal completion of an event handler and set its allowEvent property to true, this property specifies any JSON data passed to the add-in for processing.

contextData?: any;

Property Value

any

Remarks

[Api set: Mailbox 1.16]

Minimum permission level: read/write item

Applicable Outlook mode: Message Read

Important:

• To retrieve the value of the contextData property, you must call Office.context.mailbox.item.getInitializationContextAsync. If you create a JSON string using JSON.stringify() and assign it to the contextData property, you must parse the string using JSON.parse() once you retrieve it.

• You can use the contextData property to store custom internet headers to decrypt messages in reply and forward scenarios.

emailBody

When you use the completed method to signal completion of an event handler and set its allowEvent property to true, this property sets the decrypted contents of the body of the message.

emailBody?: DecryptedMessageBody;

Property Value

Office.DecryptedMessageBody

Remarks

[Api set: Mailbox 1.16]

Minimum permission level: read/write item

Applicable Outlook mode: Message Read

Important: If the emailBody property isn't specified, an empty body is returned.