Edit

Share via

Office.Organizer interface

Package:
outlook

Represents the appointment organizer, even if an alias or a delegate was used to create the appointment. This object provides a method to get the organizer value of an appointment in an Outlook add-in.

Remarks

[ API set: Mailbox 1.7 ]

Minimum permission level: read item

Applicable Outlook mode: Compose

Methods

getAsync(options, callback)

Gets the organizer value of an appointment as an EmailAddressDetails object in the asyncResult.value property.
getAsync(callback)

Gets the organizer value of an appointment as an EmailAddressDetails object in the asyncResult.value property.

Method Details

getAsync(options, callback)

Gets the organizer value of an appointment as an EmailAddressDetails object in the asyncResult.value property.

getAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<EmailAddressDetails>) => void): void;

Parameters

options
Office.AsyncContextOptions

An object literal that contains one or more of the following properties:- asyncContext: Developers can provide any object they wish to access in the callback function.

callback

(asyncResult: Office.AsyncResult<Office.EmailAddressDetails>) => void

Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, asyncResult, which is an AsyncResult object. The value property of the result is the appointment's organizer value, as an EmailAddressDetails object.

Returns

void

Remarks

[ API set: Mailbox 1.7 ]

Minimum permission level: read item

Applicable Outlook mode: Compose

Important: A recipientType property value isn't returned by the getAsync method. The appointment organizer is always a user whose email address is on the Exchange server.

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-organizer-appointment-organizer.yaml

Office.context.mailbox.item.organizer.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const apptOrganizer = asyncResult.value;
    console.log("Organizer: " + apptOrganizer.displayName + " (" + apptOrganizer.emailAddress + ")");
  } else {
    console.error(asyncResult.error);
  }
});

getAsync(callback)

Gets the organizer value of an appointment as an EmailAddressDetails object in the asyncResult.value property.

getAsync(callback?: (asyncResult: Office.AsyncResult<EmailAddressDetails>) => void): void;

Parameters

callback

(asyncResult: Office.AsyncResult<Office.EmailAddressDetails>) => void

Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, asyncResult, which is an AsyncResult object. The value property of the result is the appointment's organizer value, as an EmailAddressDetails object.

Returns

void

Remarks

[ API set: Mailbox 1.7 ]

Minimum permission level: read item

Applicable Outlook mode: Compose

Important: A recipientType property value isn't returned by the getAsync method. The appointment organizer is always a user whose email address is on the Exchange server.