Edit

Share via

Office.RecipientsChangedFields interface

  • Reference
Package:
outlook

Represents RecipientsChangedEventArgs.changedRecipientFields object.

Remarks

[ API set: Mailbox 1.7 ]

Examples

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

    if (changedFields.includes("to")) {
        // Perform operations based on the updated recipients in the To field.
    }
}

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

Properties

bcc

Gets if recipients in the bcc field were changed.
cc

Gets if recipients in the cc field were changed.
optionalAttendees

Gets if optional attendees were changed.
requiredAttendees

Gets if required attendees were changed.
resources

Gets if resources were changed.
to

Gets if recipients in the to field were changed.

Property Details

bcc

Gets if recipients in the bcc field were changed.

bcc: boolean

Property Value

boolean

Remarks

[ API set: Mailbox 1.7 ]

cc

Gets if recipients in the cc field were changed.

cc: boolean;

Property Value

boolean

Remarks

[ API set: Mailbox 1.7 ]

optionalAttendees

Gets if optional attendees were changed.

optionalAttendees: boolean;

Property Value

boolean

Remarks

[ API set: Mailbox 1.7 ]

requiredAttendees

Gets if required attendees were changed.

requiredAttendees: boolean;

Property Value

boolean

Remarks

[ API set: Mailbox 1.7 ]

resources

Gets if resources were changed.

resources: boolean;

Property Value

boolean

Remarks

[ API set: Mailbox 1.7 ]

to

Gets if recipients in the to field were changed.

to: boolean;

Property Value

boolean

Remarks

[ API set: Mailbox 1.7 ]