Office.RecipientsChangedEventArgs interface

Package:

outlook

Provides change status of recipients fields when the Office.EventType.RecipientsChanged event is raised.

Remarks

[ API set: Mailbox 1.7 ]

Examples

// Handles the OnMessageRecipientsChanged event.
function onMessageRecipientsChangedHandler(event) {
    console.log(`Event: ${event.type}`);
    const recipientFields = event.changedRecipientFields;
    console.log(getChangedRecipientFields(recipientFields));
}

// Gets the recipient fields that have changed.
function getChangedRecipientFields(recipientFields) {
    return Object.keys(recipientFields).filter((key) => recipientFields[key] === true);
}

Properties

changedRecipientFields	Gets an object that indicates change state of recipients fields.
type	Gets the type of the event. For details, refer to Office.EventType.

Property Details

changedRecipientFields

Gets an object that indicates change state of recipients fields.

changedRecipientFields: RecipientsChangedFields;

Property Value

Office.RecipientsChangedFields

Remarks

[ API set: Mailbox 1.7 ]

type

Gets the type of the event. For details, refer to Office.EventType.

type: "olkRecipientsChanged";

Property Value

"olkRecipientsChanged"

Remarks

[ API set: Mailbox 1.7 ]