From d58af468c064cab69f044ffbca53655f65aa52a6 Mon Sep 17 00:00:00 2001 From: Elizabeth Samuel Date: Fri, 1 Nov 2019 07:45:51 -0700 Subject: [PATCH] [office-js] [office-js-preview] (Outlook) Mailbox 1.8 (#39984) * [office-js] [office-js-preview] (Outlook) Mailbox 1.8 * Link to Item subclasses * Update event.completed * Update link * Updates based on feedback * Update handler comments --- types/office-js-preview/index.d.ts | 511 +++----- types/office-js/index.d.ts | 1807 ++++++++++++++++++++++++++-- 2 files changed, 1887 insertions(+), 431 deletions(-) diff --git a/types/office-js-preview/index.d.ts b/types/office-js-preview/index.d.ts index 12cb1b74a3..7d7bb98d56 100644 --- a/types/office-js-preview/index.d.ts +++ b/types/office-js-preview/index.d.ts @@ -709,7 +709,7 @@ declare namespace Office { * * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read * - * Mailbox 1.3 does not have the `options` parameter while Mailbox Preview does have support for `options` parameter. + * The `options` parameter was introduced in Mailbox 1.8. * * @param options Optional. An object that specifies behavior options for when the event is completed. */ @@ -1727,9 +1727,7 @@ declare namespace Office { * * The event handler receives an argument of type `Office.AttachmentsChangedEventArgs`. * - * [Api set: Mailbox Preview] - * - * @beta + * [Api set: Mailbox 1.8] */ AttachmentsChanged, /** @@ -1772,9 +1770,7 @@ declare namespace Office { * * The event handler receives an argument of type `Office.EnhancedLocationsChangedEventArgs`. * - * [Api set: Mailbox Preview] - * - * @beta + * [Api set: Mailbox 1.8] */ EnhancedLocationsChanged, /** @@ -7711,13 +7707,11 @@ declare namespace Office { /** * Specifies the formatting that applies to an attachment's content. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read - * - * @beta */ enum AttachmentContentFormat { /** @@ -7743,13 +7737,11 @@ declare namespace Office { /** * Specifies whether an attachment was added to or removed from an item. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read - * - * @beta */ enum AttachmentStatus { /** @@ -7791,13 +7783,11 @@ declare namespace Office { * **Note**: The actual color depends on how the Outlook client renders it. * In this case, the colors noted on each preset are for the Outlook desktop client. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read - * - * @beta */ enum CategoryColor { /** @@ -7959,13 +7949,11 @@ declare namespace Office { /** * This bit mask represents a delegate's permissions on a shared folder. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read - * - * @beta */ enum DelegatePermissions { /** @@ -8077,13 +8065,11 @@ declare namespace Office { /** * Specifies an appointment location's type. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read - * - * @beta */ enum LocationType { /** @@ -8885,7 +8871,7 @@ declare namespace Office { Subject } /** - * The subclass of {@link Office.Item} dealing with appointments. + * The subclass of {@link Office.Item | Item} dealing with appointments. * * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces. * You should treat this as a mode of Office.context.mailbox.item. Refer to the @@ -8916,21 +8902,19 @@ declare namespace Office { /** * Gets an object that provides methods for managing the item's categories. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem * * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer - * - * @beta */ categories: Categories; /** * Gets or sets the date and time that the appointment is to end. * - * The end property is an {@link Office.Time} object expressed as a Coordinated Universal Time (UTC) date and time value. + * The end property is a {@link Office.Time | Time} object expressed as a Coordinated Universal Time (UTC) date and time value. * You can use the convertToLocalClientTime method to convert the end property value to the client's local date and time. * * When you use the Time.setAsync method to set the end time, you should use the convertToUtcClientTime method to convert the local time on @@ -8946,18 +8930,16 @@ declare namespace Office { */ end: Time; /** - * Gets or sets the locations of the appointment. The `enhancedLocation` property returns an {@link Office.EnhancedLocation} object that - * provides methods to get, remove, or add locations on an item. + * Gets or sets the locations of the appointment. The `enhancedLocation` property returns an {@link Office.EnhancedLocation | EnhancedLocation} + * object that provides methods to get, remove, or add locations on an item. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem * * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer - * - * @beta */ enhancedLocation: EnhancedLocation; /** @@ -8975,7 +8957,7 @@ declare namespace Office { */ itemType: MailboxEnums.ItemType | string; /** - * Gets or sets the {@link Office.Location} of an appointment. The location property returns a Location object that provides methods that are + * Gets or sets the location of an appointment. The location property returns a {@link Office.Location | Location} object that provides methods that are * used to get and set the location of the appointment. * * [Api set: Mailbox 1.0] @@ -9002,7 +8984,7 @@ declare namespace Office { /** * Provides access to the optional attendees of an event. The type of object and level of access depends on the mode of the current item. * - * The optionalAttendees property returns an {@link Office.Recipients} object that provides methods to get or update the optional attendees + * The optionalAttendees property returns a {@link Office.Recipients | Recipients} object that provides methods to get or update the optional attendees * for a meeting. By default, the collection is limited to a maximum of 100 members. However, on Windows and Mac, the following limits apply. * * - Get 500 members maximum. @@ -9055,7 +9037,7 @@ declare namespace Office { /** * Provides access to the required attendees of an event. The type of object and level of access depends on the mode of the current item. * - * The requiredAttendees property returns an {@link Office.Recipients} object that provides methods to get or update the required attendees + * The requiredAttendees property returns a {@link Office.Recipients | Recipients} object that provides methods to get or update the required attendees * for a meeting. By default, the collection is limited to a maximum of 100 members. However, on Windows and Mac, the following limits apply. * * - Get 500 members maximum. @@ -9097,7 +9079,7 @@ declare namespace Office { /** * Gets or sets the date and time that the appointment is to begin. * - * The start property is an {@link Office.Time} object expressed as a Coordinated Universal Time (UTC) date and time value. + * The start property is a {@link Office.Time | Time} object expressed as a Coordinated Universal Time (UTC) date and time value. * You can use the convertToLocalClientTime method to convert the value to the client's local date and time. * * When you use the Time.setAsync method to set the start time, you should use the convertToUtcClientTime method to convert the local time on @@ -9203,7 +9185,7 @@ declare namespace Office { * **Note**: If you're using a data URL API (e.g., readAsDataURL), you need to strip out the data URL prefix then send the rest of the string to this API. * For example, if the full string is represented by `data:image/svg+xml;base64,`, remove `data:image/svg+xml;base64,`. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * @@ -9227,8 +9209,6 @@ declare namespace Office { * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type Office.AsyncResult. * On success, the attachment identifier will be provided in the asyncResult.value property. * If uploading the attachment fails, the asyncResult object will contain an Error object that provides a description of the error. - * - * @beta */ addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, options?: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -9242,7 +9222,7 @@ declare namespace Office { * **Note**: If you're using a data URL API (e.g., readAsDataURL), you need to strip out the data URL prefix then send the rest of the string to this API. * For example, if the full string is represented by `data:image/svg+xml;base64,`, remove `data:image/svg+xml;base64,`. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * @@ -9263,16 +9243,12 @@ declare namespace Office { * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type Office.AsyncResult. * On success, the attachment identifier will be provided in the asyncResult.value property. * If uploading the attachment fails, the asyncResult object will contain an Error object that provides a description of the error. - * - * @beta */ addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Adds an event handler for a supported event. **Note**: Events are available only with task pane. * - * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and - * `Office.EventType.RecurrenceChanged`. - * In Preview, `Office.EventType.AttachmentsChanged` and `Office.EventType.EnhancedLocationsChanged` are also supported. + * To see which event types are supported, see `Office.EventType` for details. * * [Api set: Mailbox 1.7] * @@ -9294,9 +9270,7 @@ declare namespace Office { /** * Adds an event handler for a supported event. **Note**: Events are available only with task pane. * - * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and - * `Office.EventType.RecurrenceChanged`. - * In Preview, `Office.EventType.AttachmentsChanged` and `Office.EventType.EnhancedLocationsChanged` are also supported. + * To see which event types are supported, see `Office.EventType` for details. * * [Api set: Mailbox 1.7] * @@ -9402,7 +9376,7 @@ declare namespace Office { /** * Gets the item's attachments as an array. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * @@ -9415,14 +9389,12 @@ declare namespace Office { * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. If the call fails, the asyncResult.error property will contain and error code with the reason for * the failure. - * - * @beta */ getAttachmentsAsync(options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Gets the item's attachments as an array. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * @@ -9433,8 +9405,6 @@ declare namespace Office { * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. If the call fails, the asyncResult.error property will contain and error code with the reason for * the failure. - * - * @beta */ getAttachmentsAsync(callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -9492,7 +9462,7 @@ declare namespace Office { * be aware that when Outlook is in cached mode, it may take some time before the item is synced to the server. * Until the item is synced, the `itemId` is not recognized and using it returns an error. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * @@ -9507,8 +9477,6 @@ declare namespace Office { * @param options - 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 method. * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of type Office.AsyncResult. - * - * @beta */ getItemIdAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void): void; /** @@ -9520,7 +9488,7 @@ declare namespace Office { * be aware that when Outlook is in cached mode, it may take some time before the item is synced to the server. * Until the item is synced, the `itemId` is not recognized and using it returns an error. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * @@ -9533,8 +9501,6 @@ declare namespace Office { * - `ItemNotSaved`: The id can't be retrieved until the item is saved. * * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of type Office.AsyncResult. - * - * @beta */ getItemIdAsync(callback: (asyncResult: Office.AsyncResult) => void): void; /** @@ -9674,9 +9640,7 @@ declare namespace Office { /** * Removes the event handlers for a supported event type. **Note**: Events are available only with task pane. * - * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and - * `Office.EventType.RecurrenceChanged`. - * In Preview, `Office.EventType.AttachmentsChanged` and `Office.EventType.EnhancedLocationsChanged` are also supported. + * To see which event types are supported, see `Office.EventType` for details. * * [Api set: Mailbox 1.7] * @@ -9696,9 +9660,7 @@ declare namespace Office { /** * Removes the event handlers for a supported event type. **Note**: Events are available only with task pane. * - * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and - * `Office.EventType.RecurrenceChanged`. - * In Preview, `Office.EventType.AttachmentsChanged` and `Office.EventType.EnhancedLocationsChanged` are also supported. + * To see which event types are supported, see `Office.EventType` for details. * * [Api set: Mailbox 1.7] * @@ -10070,15 +10032,13 @@ declare namespace Office { /** * Gets an object that provides methods for managing the item's categories. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem * * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee - * - * @beta */ categories: Categories; /** @@ -10128,18 +10088,16 @@ declare namespace Office { /** * Gets the locations of an appointment. * - * The enhancedLocation property returns an {@link Office.EnhancedLocation} object that allows you to get the set of locations (each represented by - * an {@link Office.LocationDetails} object) associated with the appointment. + * The enhancedLocation property returns an {@link Office.EnhancedLocation | EnhancedLocation} object that allows you to get the set of locations + * (each represented by a {@link Office.LocationDetails | LocationDetails} object) associated with the appointment. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem * * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee - * - * @beta */ enhancedLocation: EnhancedLocation; /** @@ -10257,7 +10215,7 @@ declare namespace Office { /** * Provides access to the optional attendees of an event. The type of object and level of access depends on the mode of the current item. * - * The optionalAttendees property returns an array that contains an {@link Office.EmailAddressDetails} object for each optional attendee to + * The optionalAttendees property returns an array that contains an {@link Office.EmailAddressDetails | EmailAddressDetails} object for each optional attendee to * the meeting. By default, the collection is limited to a maximum of 100 members. However, on Windows and Mac, you can get 500 members maximum. * * [Api set: Mailbox 1.0] @@ -10304,7 +10262,7 @@ declare namespace Office { /** * Provides access to the required attendees of an event. The type of object and level of access depends on the mode of the current item. * - * The requiredAttendees property returns an array that contains an {@link Office.EmailAddressDetails} object for each required attendee to + * The requiredAttendees property returns an array that contains an {@link Office.EmailAddressDetails | EmailAddressDetails} object for each required attendee to * the meeting. By default, the collection is limited to a maximum of 100 members. However, on Windows and Mac, you can get 500 members maximum. * * [Api set: Mailbox 1.0] @@ -10374,9 +10332,7 @@ declare namespace Office { /** * Adds an event handler for a supported event. **Note**: Events are available only with task pane. * - * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and - * `Office.EventType.RecurrenceChanged`. - * In Preview, `Office.EventType.AttachmentsChanged` and `Office.EventType.EnhancedLocationsChanged` are also supported. + * To see which event types are supported, see `Office.EventType` for details. * * [Api set: Mailbox 1.7] * @@ -10398,9 +10354,7 @@ declare namespace Office { /** * Adds an event handler for a supported event. **Note**: Events are available only with task pane. * - * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and - * `Office.EventType.RecurrenceChanged`. - * In Preview, `Office.EventType.AttachmentsChanged` and `Office.EventType.EnhancedLocationsChanged` are also supported. + * To see which event types are supported, see `Office.EventType` for details. * * [Api set: Mailbox 1.7] * @@ -10440,7 +10394,7 @@ declare namespace Office { * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee * * @param formData - A string that contains text and HTML and that represents the body of the reply form. The string is limited to 32 KB - * OR an {@link Office.ReplyFormData} object that contains body or attachment data and a callback function. + * OR a {@link Office.ReplyFormData | ReplyFormData} object that contains body or attachment data and a callback function. * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, * asyncResult, which is an Office.AsyncResult object. */ @@ -10467,7 +10421,7 @@ declare namespace Office { * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee * * @param formData - A string that contains text and HTML and that represents the body of the reply form. The string is limited to 32 KB - * OR an {@link Office.ReplyFormData} object that contains body or attachment data and a callback function. + * OR a {@link Office.ReplyFormData | ReplyFormData} object that contains body or attachment data and a callback function. * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, * asyncResult, which is an Office.AsyncResult object. */ @@ -10751,9 +10705,7 @@ declare namespace Office { /** * Removes the event handlers for a supported event type. **Note**: Events are available only with task pane. * - * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and - * `Office.EventType.RecurrenceChanged`. - * In Preview, `Office.EventType.AttachmentsChanged` and `Office.EventType.EnhancedLocationsChanged` are also supported. + * To see which event types are supported, see `Office.EventType` for details. * * [Api set: Mailbox 1.7] * @@ -10773,9 +10725,7 @@ declare namespace Office { /** * Removes the event handlers for a supported event type. **Note**: Events are available only with task pane. * - * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and - * `Office.EventType.RecurrenceChanged`. - * In Preview, `Office.EventType.AttachmentsChanged` and `Office.EventType.EnhancedLocationsChanged` are also supported. + * To see which event types are supported, see `Office.EventType` for details. * * [Api set: Mailbox 1.7] * @@ -10819,15 +10769,13 @@ declare namespace Office { /** * Represents the content of an attachment on a message or appointment item. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem * * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read - * - * @beta */ interface AttachmentContent { /** @@ -10888,37 +10836,33 @@ declare namespace Office { /** * Gets the url of the attachment if its type is `MailboxEnums.AttachmentType.Cloud`. * - * [Api set: Mailbox Preview] - * - * @beta + * [Api set: Mailbox 1.8] */ url: string; } /** * Provides information about the attachments that raised the `Office.EventType.AttachmentsChanged` event. * - * [Api set: Mailbox Preview] - * - * @beta + * [Api set: Mailbox 1.8] */ export interface AttachmentsChangedEventArgs { /** * Represents the set of attachments that were added or removed. * For each such attachment, gets a subset of {@link Office.AttachmentDetails | AttachmentDetails} properties: `id`, `name`, `size`, and `attachmentType`. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] */ attachmentDetails: object[]; /** * Gets whether the attachments were added or removed. See {@link Office.MailboxEnums.AttachmentStatus | MailboxEnums.AttachmentStatus} for details. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] */ attachmentStatus: MailboxEnums.AttachmentStatus | string; /** * Gets the type of the event. See `Office.EventType` for details. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] */ type: "olkAttachmentsChanged"; } @@ -11198,15 +11142,13 @@ declare namespace Office { * The user defines {@link Office.MasterCategories | categories in a master list} on their mailbox. * They can then apply one or more categories to an item. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem * * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read - * - * @beta */ interface Categories { /** @@ -11219,7 +11161,7 @@ declare namespace Office { * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * @@ -11230,8 +11172,6 @@ declare namespace Office { * **Errors**: * * - InvalidCategory: Invalid categories were provided. - * - * @beta */ addAsync(categories: string[], options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -11242,7 +11182,7 @@ declare namespace Office { * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. If adding categories fails, the asyncResult.error property will contain an error code. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * @@ -11253,8 +11193,6 @@ declare namespace Office { * **Errors**: * * - InvalidCategory: Invalid categories were provided. - * - * @beta */ addAsync(categories: string[], callback: (asyncResult: Office.AsyncResult) => void): void; /** @@ -11265,15 +11203,13 @@ declare namespace Office { * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. If adding categories fails, the asyncResult.error property will contain an error code. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem * * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read - * - * @beta */ getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void): void; /** @@ -11282,15 +11218,13 @@ declare namespace Office { * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem * * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read - * - * @beta */ getAsync(callback: (asyncResult: Office.AsyncResult) => void): void; /** @@ -11302,15 +11236,13 @@ declare namespace Office { * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. If removing categories fails, the asyncResult.error property will contain an error code. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem * * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read - * - * @beta */ removeAsync(categories: string[], options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -11320,30 +11252,26 @@ declare namespace Office { * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. If removing categories fails, the asyncResult.error property will contain an error code. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem * * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read - * - * @beta */ removeAsync(categories: string[], callback: (asyncResult: Office.AsyncResult) => void): void; } /** * Represents a category's details like name and associated color. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem * * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read - * - * @beta */ interface CategoryDetails { /** @@ -11358,7 +11286,7 @@ declare namespace Office { /** * Represents a contact stored on the server. Read mode only. * - * The list of contacts associated with an email message or appointment is returned in the contacts property of the {@link Office.Entities} object + * The list of contacts associated with an email message or appointment is returned in the contacts property of the {@link Office.Entities | Entities} object * that is returned by the getEntities or getEntitiesByType method of the active item. * * [Api set: Mailbox 1.0] @@ -11613,21 +11541,19 @@ declare namespace Office { /** * Represents the set of locations on an appointment. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem * * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read - * - * @beta */ export interface EnhancedLocation { /** * Adds to the set of locations associated with the appointment. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * @@ -11644,14 +11570,12 @@ declare namespace Office { * asyncContext: Developers can provide any object they wish to access in the callback method. * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, * asyncResult, which is an Office.AsyncResult object. Check the `status` property of asyncResult to determine if the call succeeded. - * - * @beta */ addAsync(locationIdentifiers: LocationIdentifier[], options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResultStatus) => void): void; /** * Adds to the set of locations associated with the appointment. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * @@ -11666,14 +11590,12 @@ declare namespace Office { * @param locationIdentifiers The locations to be added to the current list of locations. * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, * asyncResult, which is an Office.AsyncResult object. Check the `status` property of asyncResult to determine if the call succeeded. - * - * @beta */ addAsync(locationIdentifiers: LocationIdentifier[], callback?: (asyncResult: Office.AsyncResultStatus) => void): void; /** * Gets the set of locations associated with the appointment. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * @@ -11685,14 +11607,12 @@ declare namespace Office { * asyncContext: Developers can provide any object they wish to access in the callback method. * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, * asyncResult, which is an Office.AsyncResult object. - * - * @beta */ getAsync(options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Gets the set of locations associated with the appointment. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * @@ -11702,8 +11622,6 @@ declare namespace Office { * * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, * asyncResult, which is an Office.AsyncResult object. - * - * @beta */ getAsync(callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -11711,7 +11629,7 @@ declare namespace Office { * * If there are multiple locations with the same name, all matching locations will be removed even if only one was specified in locationIdentifiers. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * @@ -11724,8 +11642,6 @@ declare namespace Office { * asyncContext: Developers can provide any object they wish to access in the callback method. * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, * asyncResult, which is an Office.AsyncResult object. Check the `status` property of asyncResult to determine if the call succeeded. - * - * @beta */ removeAsync(locationIdentifiers: LocationIdentifier[], options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResultStatus) => void): void; /** @@ -11733,7 +11649,7 @@ declare namespace Office { * * If there are multiple locations with the same name, all matching locations will be removed even if only one was specified in locationIdentifiers. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * @@ -11744,29 +11660,25 @@ declare namespace Office { * @param locationIdentifiers The locations to be removed from the current list of locations. * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, * asyncResult, which is an Office.AsyncResult object. Check the `status` property of asyncResult to determine if the call succeeded. - * - * @beta */ removeAsync(locationIdentifiers: LocationIdentifier[], callback?: (asyncResult: Office.AsyncResultStatus) => void): void; } /** * Provides the current enhanced locations when the `Office.EventType.EnhancedLocationsChanged` event is raised. * - * [Api set: Mailbox Preview] - * - * @beta + * [Api set: Mailbox 1.8] */ export interface EnhancedLocationsChangedEventArgs { /** * Gets the set of enhanced locations. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] */ enhancedLocations: LocationDetails[]; /** * Gets the type of the event. See `Office.EventType` for details. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] */ type: "olkEnhancedLocationsChanged"; } @@ -11848,7 +11760,7 @@ declare namespace Office { * * The getAsync method starts an asynchronous call to the Exchange server to get the from value of a message. * - * The from value of the item is provided as an {@link Office.EmailAddressDetails} in the asyncResult.value property. + * The from value of the item is provided as an {@link Office.EmailAddressDetails | EmailAddressDetails} in the asyncResult.value property. * * [Api set: Mailbox 1.7] * @@ -11870,7 +11782,7 @@ declare namespace Office { * * The getAsync method starts an asynchronous call to the Exchange server to get the from value of a message. * - * The from value of the item is provided as an {@link Office.EmailAddressDetails} in the asyncResult.value property. + * The from value of the item is provided as an {@link Office.EmailAddressDetails | EmailAddressDetails} in the asyncResult.value property. * * [Api set: Mailbox 1.7] * @@ -11894,15 +11806,13 @@ declare namespace Office { * * **Note**: This object is intended for you to set and get your custom headers on a message item. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem * * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose - * - * @beta */ interface InternetHeaders { /** @@ -11911,7 +11821,7 @@ declare namespace Office { * * **Note**: This method is intended to return the values of the custom headers you set using the `setAsync` method. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * @@ -11924,8 +11834,6 @@ declare namespace Office { * asyncContext: Developers can provide any object they wish to access in the callback method. * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, * asyncResult, which is an Office.AsyncResult object. - * - * @beta */ getAsync(names: string[], options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -11934,7 +11842,7 @@ declare namespace Office { * * **Note**: This method is intended to return the values of the custom headers you set using the `setAsync` method. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * @@ -11945,8 +11853,6 @@ declare namespace Office { * @param names - The names of the internet headers to be returned. * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, * asyncResult, which is an Office.AsyncResult object. - * - * @beta */ getAsync(names: string[], callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -11954,7 +11860,7 @@ declare namespace Office { * * **Note**: This method is intended to remove the custom headers you set using the `setAsync` method. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * @@ -11967,8 +11873,6 @@ declare namespace Office { * asyncContext: Developers can provide any object they wish to access in the callback method. * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, * asyncResult, which is an Office.AsyncResult object. - * - * @beta */ removeAsync(names: string[], options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -11976,7 +11880,7 @@ declare namespace Office { * * **Note**: This method is intended to remove your custom headers you set using the `setAsync` method. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * @@ -11987,8 +11891,6 @@ declare namespace Office { * @param names - The names of the internet headers to be removed. * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, * asyncResult, which is an Office.AsyncResult object. - * - * @beta */ removeAsync(names: string[], callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -11999,7 +11901,7 @@ declare namespace Office { * * **Note**: This method is intended to set the values of your custom headers. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * @@ -12013,8 +11915,6 @@ declare namespace Office { * asyncContext: Developers can provide any object they wish to access in the callback method. * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type Office.AsyncResult. * Any errors encountered will be provided in the asyncResult.error property. - * - * @beta */ setAsync(headers: Object, options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -12025,7 +11925,7 @@ declare namespace Office { * * **Note**: This method is intended to set the values of your custom headers. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * @@ -12037,8 +11937,6 @@ declare namespace Office { * internet headers and values being the values of the internet headers. * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type Office.AsyncResult. * Any errors encountered will be provided in the asyncResult.error property. - * - * @beta */ setAsync(headers: Object, callback?: (asyncResult: Office.AsyncResult) => void): void; } @@ -12046,6 +11944,12 @@ declare namespace Office { * The item namespace is used to access the currently selected message, meeting request, or appointment. * You can determine the type of the item by using the `itemType` property. * + * If you want to see IntelliSense for only a specific type, cast this item to one of the following: + * + * {@link Office.ItemCompose | ItemCompose}, {@link Office.ItemRead | ItemRead}, + * {@link Office.MessageCompose | MessageCompose}, {@link Office.MessageRead | MessageRead}, + * {@link Office.AppointmentCompose | AppointmentCompose}, {@link Office.AppointmentRead | AppointmentRead} + * * [Api set: Mailbox 1.0] * * @remarks @@ -12070,15 +11974,13 @@ declare namespace Office { /** * Gets an object that provides methods for managing the item's categories. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem * * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read - * - * @beta */ categories: Categories; /** @@ -12135,9 +12037,7 @@ declare namespace Office { /** * Adds an event handler for a supported event. **Note**: Events are available only with task pane. * - * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and - * `Office.EventType.RecurrenceChanged`. - * In Preview, `Office.EventType.AttachmentsChanged` and `Office.EventType.EnhancedLocationsChanged` are also supported. + * To see which event types are supported, see `Office.EventType` for details. * * [Api set: Mailbox 1.7] * @@ -12159,9 +12059,7 @@ declare namespace Office { /** * Adds an event handler for a supported event. **Note**: Events are available only with task pane. * - * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and - * `Office.EventType.RecurrenceChanged`. - * In Preview, `Office.EventType.AttachmentsChanged` and `Office.EventType.EnhancedLocationsChanged` are also supported. + * To see which event types are supported, see `Office.EventType` for details. * * [Api set: Mailbox 1.7] * @@ -12187,7 +12085,7 @@ declare namespace Office { * A session is over when the user closes the app, or if the user starts composing an inline form then subsequently pops out the form to * continue in a separate window. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * @@ -12205,8 +12103,6 @@ declare namespace Office { * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, * asyncResult, which is an Office.AsyncResult object. If the call fails, the asyncResult.error property will contain and error code * with the reason for the failure. - * - * @beta */ getAttachmentContentAsync(attachmentId: string, options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -12218,7 +12114,7 @@ declare namespace Office { * A session is over when the user closes the app, or if the user starts composing an inline form then subsequently pops out the form to * continue in a separate window. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * @@ -12234,8 +12130,6 @@ declare namespace Office { * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, * asyncResult, which is an Office.AsyncResult object. If the call fails, the asyncResult.error property will contain and error code * with the reason for the failure. - * - * @beta */ getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -12289,7 +12183,7 @@ declare namespace Office { /** * Gets the properties of an appointment or message in a shared folder, calendar, or mailbox. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * @@ -12302,14 +12196,12 @@ declare namespace Office { * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. * The `value` property of the result is the properties of the shared item. - * - * @beta */ getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void): void; /** * Gets the properties of an appointment or message in a shared folder, calendar, or mailbox. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * @@ -12320,8 +12212,6 @@ declare namespace Office { * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. * The `value` property of the result is the properties of the shared item. - * - * @beta */ getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void): void; /** @@ -12352,9 +12242,7 @@ declare namespace Office { /** * Removes the event handlers for a supported event type. **Note**: Events are available only with task pane. * - * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and - * `Office.EventType.RecurrenceChanged`. - * In Preview, `Office.EventType.AttachmentsChanged` and `Office.EventType.EnhancedLocationsChanged` are also supported. + * To see which event types are supported, see `Office.EventType` for details. * * [Api set: Mailbox 1.7] * @@ -12374,9 +12262,7 @@ declare namespace Office { /** * Removes the event handlers for a supported event type. **Note**: Events are available only with task pane. * - * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and - * `Office.EventType.RecurrenceChanged`. - * In Preview, `Office.EventType.AttachmentsChanged` and `Office.EventType.EnhancedLocationsChanged` are also supported. + * To see which event types are supported, see `Office.EventType` for details. * * [Api set: Mailbox 1.7] * @@ -12494,7 +12380,7 @@ declare namespace Office { * **Note**: If you're using a data URL API (e.g., readAsDataURL), you need to strip out the data URL prefix then send the rest of the string to this API. * For example, if the full string is represented by `data:image/svg+xml;base64,`, remove `data:image/svg+xml;base64,`. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * @@ -12518,8 +12404,6 @@ declare namespace Office { * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type Office.AsyncResult. * On success, the attachment identifier will be provided in the asyncResult.value property. * If uploading the attachment fails, the asyncResult object will contain an Error object that provides a description of the error. - * - * @beta */ addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, options?: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -12533,7 +12417,7 @@ declare namespace Office { * **Note**: If you're using a data URL API (e.g., readAsDataURL), you need to strip out the data URL prefix then send the rest of the string to this API. * For example, if the full string is represented by `data:image/svg+xml;base64,`, remove `data:image/svg+xml;base64,`. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * @@ -12554,8 +12438,6 @@ declare namespace Office { * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type Office.AsyncResult. * On success, the attachment identifier will be provided in the asyncResult.value property. * If uploading the attachment fails, the asyncResult object will contain an Error object that provides a description of the error. - * - * @beta */ addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -12649,7 +12531,7 @@ declare namespace Office { /** * Gets the item's attachments as an array. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * @@ -12662,14 +12544,12 @@ declare namespace Office { * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. If the call fails, the asyncResult.error property will contain and error code with the reason for * the failure. - * - * @beta */ getAttachmentsAsync(options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Gets the item's attachments as an array. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * @@ -12680,8 +12560,6 @@ declare namespace Office { * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. If the call fails, the asyncResult.error property will contain and error code with the reason for * the failure. - * - * @beta */ getAttachmentsAsync(callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -13123,7 +13001,7 @@ declare namespace Office { * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Read * * @param formData - A string that contains text and HTML and that represents the body of the reply form. The string is limited to 32 KB - * OR an {@link Office.ReplyFormData} object that contains body or attachment data and a callback function. + * OR a {@link Office.ReplyFormData | ReplyFormData} object that contains body or attachment data and a callback function. * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, * asyncResult, which is an Office.AsyncResult object. */ @@ -13150,7 +13028,7 @@ declare namespace Office { * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Read * * @param formData - A string that contains text and HTML and that represents the body of the reply form. The string is limited to 32 KB - * OR an {@link Office.ReplyFormData} object that contains body or attachment data and a callback function. + * OR a {@link Office.ReplyFormData | ReplyFormData} object that contains body or attachment data and a callback function. * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, * asyncResult, which is an Office.AsyncResult object. */ @@ -13554,15 +13432,13 @@ declare namespace Office { /** * Represents a location. Read only. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem * * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read - * - * @beta */ export interface LocationDetails { /** @@ -13581,15 +13457,13 @@ declare namespace Office { /** * Represents the id of a location. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem * * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read - * - * @beta */ interface LocationIdentifier { /** @@ -13678,23 +13552,24 @@ declare namespace Office { */ ewsUrl: string; /** - * The mailbox item. Depending on the context in which the add-in opened, the item may be of any number of types. - * If you want to see IntelliSense for only a specific type, you should cast this item to one of the following: - * `ItemCompose`, `ItemRead`, `MessageCompose`, `MessageRead`, `AppointmentCompose`, `AppointmentRead` + * The mailbox item. Depending on the context in which the add-in opened, the item may be of any number of types. + * If you want to see IntelliSense for only a specific type, cast this item to one of the following: + * + * {@link Office.ItemCompose | ItemCompose}, {@link Office.ItemRead | ItemRead}, + * {@link Office.MessageCompose | MessageCompose}, {@link Office.MessageRead | MessageRead}, + * {@link Office.AppointmentCompose | AppointmentCompose}, {@link Office.AppointmentRead | AppointmentRead} */ item: Item & ItemCompose & ItemRead & MessageRead & MessageCompose & AppointmentRead & AppointmentCompose; /** * Gets an object that provides methods to manage the categories master list associated with a mailbox. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteMailbox * * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read - * - * @beta */ masterCategories: MasterCategories; /** @@ -13726,8 +13601,7 @@ declare namespace Office { /** * Adds an event handler for a supported event. **Note**: Events are available only with task pane. * - * Currently, the only supported event type is `Office.EventType.ItemChanged`. - * In Preview, `Office.EventType.OfficeThemeChanged` is also supported. + * To see which event types are supported, see `Office.EventType` for details. * * [Api set: Mailbox 1.5] * @@ -13748,8 +13622,7 @@ declare namespace Office { /** * Adds an event handler for a supported event. **Note**: Events are available only with task pane. * - * Currently, the only supported event type is `Office.EventType.ItemChanged`. - * In Preview, `Office.EventType.OfficeThemeChanged` is also supported. + * To see which event types are supported, see `Office.EventType` for details. * * [Api set: Mailbox 1.5] * @@ -13950,13 +13823,13 @@ declare namespace Office { * * @param parameters - A dictionary containing all values to be filled in for the user in the new form. All parameters are optional. * - * toRecipients: An array of strings containing the email addresses or an array containing an {@link Office.EmailAddressDetails} object + * toRecipients: An array of strings containing the email addresses or an array containing an {@link Office.EmailAddressDetails | EmailAddressDetails} object * for each of the recipients on the To line. The array is limited to a maximum of 100 entries. * - * ccRecipients: An array of strings containing the email addresses or an array containing an {@link Office.EmailAddressDetails} object + * ccRecipients: An array of strings containing the email addresses or an array containing an {@link Office.EmailAddressDetails | EmailAddressDetails} object * for each of the recipients on the Cc line. The array is limited to a maximum of 100 entries. * - * bccRecipients: An array of strings containing the email addresses or an array containing an {@link Office.EmailAddressDetails} object + * bccRecipients: An array of strings containing the email addresses or an array containing an {@link Office.EmailAddressDetails | EmailAddressDetails} object * for each of the recipients on the Bcc line. The array is limited to a maximum of 100 entries. * * subject: A string containing the subject of the message. The string is limited to a maximum of 255 characters. @@ -14170,8 +14043,7 @@ declare namespace Office { /** * Removes the event handlers for a supported event type. **Note**: Events are available only with task pane. * - * Currently, the only supported event type is `Office.EventType.ItemChanged`. - * In Preview, `Office.EventType.OfficeThemeChanged` is also supported. + * To see which event types are supported, see `Office.EventType` for details. * * [Api set: Mailbox 1.5] * @@ -14190,8 +14062,7 @@ declare namespace Office { /** * Removes the event handlers for a supported event type. **Note**: Events are available only with task pane. * - * Currently, the only supported event type is `Office.EventType.ItemChanged`. - * In Preview, `Office.EventType.OfficeThemeChanged` is also supported. + * To see which event types are supported, see `Office.EventType` for details. * * [Api set: Mailbox 1.5] * @@ -14213,15 +14084,13 @@ declare namespace Office { * In Outlook, a user can group messages and appointments by using a category to color-code them. * The user defines categories in a master list on their mailbox. They can then apply one or more categories to an item. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadMailbox * * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read - * - * @beta */ interface MasterCategories { /** @@ -14233,7 +14102,7 @@ declare namespace Office { * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * @@ -14246,8 +14115,6 @@ declare namespace Office { * - DuplicateCategory: One of the categories provided is already in the master category list. * * - PermissionDenied: The user does not have permission to perform this action. - * - * @beta */ addAsync(categories: CategoryDetails[], options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -14257,7 +14124,7 @@ declare namespace Office { * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. If adding categories fails, the asyncResult.error property will contain an error code. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * @@ -14270,8 +14137,6 @@ declare namespace Office { * - DuplicateCategory: One of the categories provided is already in the master category list. * * - PermissionDenied: The user does not have permission to perform this action. - * - * @beta */ addAsync(categories: CategoryDetails[], callback: (asyncResult: Office.AsyncResult) => void): void; /** @@ -14282,15 +14147,13 @@ declare namespace Office { * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. If adding categories fails, the asyncResult.error property will contain an error code. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadMailbox * * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read - * - * @beta */ getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void): void; /** @@ -14299,15 +14162,13 @@ declare namespace Office { * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadMailbox * * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read - * - * @beta */ getAsync(callback: (asyncResult: Office.AsyncResult) => void): void; /** @@ -14319,7 +14180,7 @@ declare namespace Office { * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. If removing categories fails, the asyncResult.error property will contain an error code. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * @@ -14330,8 +14191,6 @@ declare namespace Office { * **Errors**: * * - PermissionDenied: The user does not have permission to perform this action. - * - * @beta */ removeAsync(categories: string[], options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -14341,7 +14200,7 @@ declare namespace Office { * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. If removing categories fails, the asyncResult.error property will contain an error code. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * @@ -14352,8 +14211,6 @@ declare namespace Office { * **Errors**: * * - PermissionDenied: The user does not have permission to perform this action. - * - * @beta */ removeAsync(categories: string[], callback: (asyncResult: Office.AsyncResult) => void): void; } @@ -14402,7 +14259,7 @@ declare namespace Office { subject: string; } /** - * A subclass of {@link Office.Item} for messages. + * A subclass of {@link Office.Item | Item} for messages. * * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces. * You should treat this as a mode of Office.context.mailbox.item. Refer to the @@ -14470,22 +14327,20 @@ declare namespace Office { /** * Gets an object that provides methods for managing the item's categories. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem * * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose - * - * @beta */ categories: Categories; /** * Provides access to the Cc (carbon copy) recipients of a message. The type of object and level of access depends on the mode of the * current item. * - * The cc property returns an {@link Office.Recipients} object that provides methods to get or update the recipients on the Cc line of + * The cc property returns a {@link Office.Recipients | Recipients} object that provides methods to get or update the recipients on the Cc line of * the message. By default, the collection is limited to a maximum of 100 members. However, on Windows and Mac, the following limits apply. * * - Get 500 members maximum. @@ -14542,15 +14397,13 @@ declare namespace Office { * * The internetHeaders property returns an InternetHeaders object that provides methods to manage the internet headers on the message. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem * * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose - * - * @beta */ internetHeaders: InternetHeaders; /** @@ -14717,7 +14570,7 @@ declare namespace Office { * **Note**: If you're using a data URL API (e.g., readAsDataURL), you need to strip out the data URL prefix then send the rest of the string to this API. * For example, if the full string is represented by `data:image/svg+xml;base64,`, remove `data:image/svg+xml;base64,`. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * @@ -14741,8 +14594,6 @@ declare namespace Office { * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type Office.AsyncResult. * On success, the attachment identifier will be provided in the asyncResult.value property. * If uploading the attachment fails, the asyncResult object will contain an Error object that provides a description of the error. - * - * @beta */ addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, options?: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -14756,7 +14607,7 @@ declare namespace Office { * **Note**: If you're using a data URL API (e.g., readAsDataURL), you need to strip out the data URL prefix then send the rest of the string to this API. * For example, if the full string is represented by `data:image/svg+xml;base64,`, remove `data:image/svg+xml;base64,`. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * @@ -14777,16 +14628,12 @@ declare namespace Office { * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type Office.AsyncResult. * On success, the attachment identifier will be provided in the asyncResult.value property. * If uploading the attachment fails, the asyncResult object will contain an Error object that provides a description of the error. - * - * @beta */ addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Adds an event handler for a supported event. **Note**: Events are available only with task pane. * - * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and - * `Office.EventType.RecurrenceChanged`. - * In Preview, `Office.EventType.AttachmentsChanged` and `Office.EventType.EnhancedLocationsChanged` are also supported. + * To see which event types are supported, see `Office.EventType` for details. * * [Api set: Mailbox 1.7] * @@ -14808,9 +14655,7 @@ declare namespace Office { /** * Adds an event handler for a supported event. **Note**: Events are available only with task pane. * - * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and - * `Office.EventType.RecurrenceChanged`. - * In Preview, `Office.EventType.AttachmentsChanged` and `Office.EventType.EnhancedLocationsChanged` are also supported. + * To see which event types are supported, see `Office.EventType` for details. * * [Api set: Mailbox 1.7] * @@ -14918,7 +14763,7 @@ declare namespace Office { /** * Gets the item's attachments as an array. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * @@ -14931,14 +14776,12 @@ declare namespace Office { * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. If the call fails, the asyncResult.error property will contain and error code with the reason for * the failure. - * - * @beta */ getAttachmentsAsync(options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Gets the item's attachments as an array. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * @@ -14949,8 +14792,6 @@ declare namespace Office { * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of * type Office.AsyncResult. If the call fails, the asyncResult.error property will contain and error code with the reason for * the failure. - * - * @beta */ getAttachmentsAsync(callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -15042,7 +14883,7 @@ declare namespace Office { * be aware that when Outlook is in cached mode, it may take some time before the item is synced to the server. * Until the item is synced, the `itemId` is not recognized and using it returns an error. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * @@ -15057,8 +14898,6 @@ declare namespace Office { * @param options - 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 method. * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of type Office.AsyncResult. - * - * @beta */ getItemIdAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void): void; /** @@ -15070,7 +14909,7 @@ declare namespace Office { * be aware that when Outlook is in cached mode, it may take some time before the item is synced to the server. * Until the item is synced, the `itemId` is not recognized and using it returns an error. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * @@ -15083,8 +14922,6 @@ declare namespace Office { * - `ItemNotSaved`: The id can't be retrieved until the item is saved. * * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of type Office.AsyncResult. - * - * @beta */ getItemIdAsync(callback: (asyncResult: Office.AsyncResult) => void): void; /** @@ -15197,9 +15034,7 @@ declare namespace Office { /** * Removes the event handlers for a supported event type. **Note**: Events are available only with task pane. * - * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and - * `Office.EventType.RecurrenceChanged`. - * In Preview, `Office.EventType.AttachmentsChanged` and `Office.EventType.EnhancedLocationsChanged` are also supported. + * To see which event types are supported, see `Office.EventType` for details. * * [Api set: Mailbox 1.7] * @@ -15219,9 +15054,7 @@ declare namespace Office { /** * Removes the event handlers for a supported event type. **Note**: Events are available only with task pane. * - * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and - * `Office.EventType.RecurrenceChanged`. - * In Preview, `Office.EventType.AttachmentsChanged` and `Office.EventType.EnhancedLocationsChanged` are also supported. + * To see which event types are supported, see `Office.EventType` for details. * * [Api set: Mailbox 1.7] * @@ -15413,15 +15246,13 @@ declare namespace Office { /** * Gets an object that provides methods for managing the item's categories. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem * * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read - * - * @beta */ categories: Categories; /** @@ -15715,9 +15546,7 @@ declare namespace Office { /** * Adds an event handler for a supported event. **Note**: Events are available only with task pane. * - * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and - * `Office.EventType.RecurrenceChanged`. - * In Preview, `Office.EventType.AttachmentsChanged` and `Office.EventType.EnhancedLocationsChanged` are also supported. + * To see which event types are supported, see `Office.EventType` for details. * * [Api set: Mailbox 1.7] * @@ -15739,9 +15568,7 @@ declare namespace Office { /** * Adds an event handler for a supported event. **Note**: Events are available only with task pane. * - * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and - * `Office.EventType.RecurrenceChanged`. - * In Preview, `Office.EventType.AttachmentsChanged` and `Office.EventType.EnhancedLocationsChanged` are also supported. + * To see which event types are supported, see `Office.EventType` for details. * * [Api set: Mailbox 1.7] * @@ -15781,7 +15608,7 @@ declare namespace Office { * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read * * @param formData - A string that contains text and HTML and that represents the body of the reply form. The string is limited to 32 KB - * OR an {@link Office.ReplyFormData} object that contains body or attachment data and a callback function. + * OR a {@link Office.ReplyFormData | ReplyFormData} object that contains body or attachment data and a callback function. * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, * asyncResult, which is an Office.AsyncResult object. */ @@ -15808,7 +15635,7 @@ declare namespace Office { * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read * * @param formData - A string that contains text and HTML and that represents the body of the reply form. The string is limited to 32 KB - * OR an {@link Office.ReplyFormData} object that contains body or attachment data and a callback function. + * OR a {@link Office.ReplyFormData | ReplyFormData} object that contains body or attachment data and a callback function. * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, * asyncResult, which is an Office.AsyncResult object. */ @@ -15816,7 +15643,7 @@ declare namespace Office { /** * Gets all the internet headers for the message as a string. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * @@ -15831,10 +15658,26 @@ declare namespace Office { * On success, the internet headers data is provided in the asyncResult.value property as a string. * Refer to {@link https://tools.ietf.org/html/rfc2183 | RFC 2183} for the formatting information of the returned string value. * If the call fails, the asyncResult.error property will contain an error code with the reason for the failure. - * - * @beta */ getAllInternetHeadersAsync(options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; + /** + * Gets all the internet headers for the message as a string. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, + * asyncResult, which is an Office.AsyncResult object. + * On success, the internet headers data is provided in the asyncResult.value property as a string. + * Refer to {@link https://tools.ietf.org/html/rfc2183 | RFC 2183} for the formatting information of the returned string value. + * If the call fails, the asyncResult.error property will contain an error code with the reason for the failure. + */ + getAllInternetHeadersAsync(callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Gets initialization data passed when the add-in is * {@link https://docs.microsoft.com/outlook/actionable-messages/invoke-add-in-from-actionable-message | activated by an actionable message}. @@ -16118,9 +15961,7 @@ declare namespace Office { /** * Removes the event handlers for a supported event type. **Note**: Events are available only with task pane. * - * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and - * `Office.EventType.RecurrenceChanged`. - * In Preview, `Office.EventType.AttachmentsChanged` and `Office.EventType.EnhancedLocationsChanged` are also supported. + * To see which event types are supported, see `Office.EventType` for details. * * [Api set: Mailbox 1.7] * @@ -16140,9 +15981,7 @@ declare namespace Office { /** * Removes the event handlers for a supported event type. **Note**: Events are available only with task pane. * - * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and - * `Office.EventType.RecurrenceChanged`. - * In Preview, `Office.EventType.AttachmentsChanged` and `Office.EventType.EnhancedLocationsChanged` are also supported. + * To see which event types are supported, see `Office.EventType` for details. * * [Api set: Mailbox 1.7] * @@ -16401,7 +16240,7 @@ declare namespace Office { */ interface Organizer { /** - * Gets the organizer value of an appointment as an {@link Office.EmailAddressDetails} in the asyncResult.value property. + * Gets the organizer value of an appointment as an {@link Office.EmailAddressDetails | EmailAddressDetails} object in the asyncResult.value property. * * [Api set: Mailbox 1.7] * @@ -16418,7 +16257,7 @@ declare namespace Office { */ getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void): void; /** - * Gets the organizer value of an appointment as an {@link Office.EmailAddressDetails} in the asyncResult.value property. + * Gets the organizer value of an appointment as an {@link Office.EmailAddressDetails | EmailAddressDetails} object in the asyncResult.value property. * * [Api set: Mailbox 1.7] * @@ -16508,9 +16347,9 @@ declare namespace Office { * * - Strings containing SMTP email addresses * - * - {@link Office.EmailUser} objects + * - {@link Office.EmailUser | EmailUser} objects * - * - {@link Office.EmailAddressDetails} objects + * - {@link Office.EmailAddressDetails | EmailAddressDetails} objects * * [Api set: Mailbox 1.1] * @@ -16532,7 +16371,7 @@ declare namespace Office { /** * Gets a recipient list for an appointment or message. * - * When the call completes, the asyncResult.value property will contain an array of {@link Office.EmailAddressDetails} objects. + * When the call completes, the asyncResult.value property will contain an array of {@link Office.EmailAddressDetails | EmailAddressDetails} objects. * * [Api set: Mailbox 1.1] * @@ -16552,7 +16391,7 @@ declare namespace Office { /** * Gets a recipient list for an appointment or message. * - * When the call completes, the asyncResult.value property will contain an array of {@link Office.EmailAddressDetails} objects. + * When the call completes, the asyncResult.value property will contain an array of {@link Office.EmailAddressDetails | EmailAddressDetails} objects. * * [Api set: Mailbox 1.1] * @@ -16576,9 +16415,9 @@ declare namespace Office { * * - Strings containing SMTP email addresses * - * - {@link Office.EmailUser} objects + * - {@link Office.EmailUser | EmailUser} objects * - * - {@link Office.EmailAddressDetails} objects + * - {@link Office.EmailAddressDetails | EmailAddressDetails} objects * * [Api set: Mailbox 1.1] * @@ -16610,9 +16449,9 @@ declare namespace Office { * * - Strings containing SMTP email addresses * - * - {@link Office.EmailUser} objects + * - {@link Office.EmailUser | EmailUser} objects * - * - {@link Office.EmailAddressDetails} objects + * - {@link Office.EmailAddressDetails | EmailAddressDetails} objects * * [Api set: Mailbox 1.1] * @@ -16769,7 +16608,7 @@ declare namespace Office { */ recurrenceType: MailboxEnums.RecurrenceType | string; /** - * The {@link Office.SeriesTime} object enables you to manage the start and end dates of the recurring appointment series and the usual start + * The {@link Office.SeriesTime | SeriesTime} object enables you to manage the start and end dates of the recurring appointment series and the usual start * and end times of instances. **This object is not in UTC time.** * Instead, it is set in the time zone specified by the recurrenceTimeZone value or defaulted to the item's time zone. * @@ -16986,7 +16825,7 @@ declare namespace Office { */ htmlBody?: string; /** - * An array of {@link Office.ReplyFormAttachment} that are either file or item attachments. + * An array of {@link Office.ReplyFormAttachment | ReplyFormAttachment} that are either file or item attachments. */ attachments?: ReplyFormAttachment[]; /** @@ -17278,15 +17117,13 @@ declare namespace Office { /** * Represents the properties of an appointment or message in a shared folder, mailbox, or calendar. * - * [Api set: Mailbox Preview] + * [Api set: Mailbox 1.8] * * @remarks * * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem * * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read - * - * @beta */ interface SharedProperties { /** @@ -17298,18 +17135,12 @@ declare namespace Office { * Use with targetMailbox to construct REST operation's URL. * * Example usage: `targetRestUrl + "/{api_version}/users/" + targetMailbox + "/{REST_operation}"` - * - * **Note**: This property name is being transitioned from `restUrl` to `targetRestUrl`. - * For Outlook on the web, use `targetRestUrl`. For Windows and Mac, use `restUrl`. */ targetRestUrl: string; /** * The target/owner's mailbox. Use with targetRestUrl to construct REST operation's URL. * * Example usage: `targetRestUrl + "/{api_version}/users/" + targetMailbox + "/{REST_operation}"` - * - * **Note**: The URL property name is being transitioned from `restUrl` to `targetRestUrl`. - * For Outlook on the web, use `targetRestUrl`. For Windows and Mac, use `restUrl`. */ targetMailbox: string; /** diff --git a/types/office-js/index.d.ts b/types/office-js/index.d.ts index 20d31580cb..2ef493c106 100644 --- a/types/office-js/index.d.ts +++ b/types/office-js/index.d.ts @@ -703,7 +703,7 @@ declare namespace Office { * * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read * - * Mailbox 1.3 does not have the `options` parameter while Mailbox Preview does have support for `options` parameter. + * The `options` parameter was introduced in Mailbox 1.8. * * @param options Optional. An object that specifies behavior options for when the event is completed. */ @@ -1637,6 +1637,14 @@ declare namespace Office { * [Api set: Mailbox 1.7] */ AppointmentTimeChanged, + /** + * Triggers when an attachment is added to or removed from an item. Supported with task pane only. + * + * The event handler receives an argument of type `Office.AttachmentsChangedEventArgs`. + * + * [Api set: Mailbox 1.8] + */ + AttachmentsChanged, /** * Occurs when data within the binding is changed. * To add an event handler for the BindingDataChanged event of a binding, use the addHandlerAsync method of the Binding object. @@ -1672,6 +1680,14 @@ declare namespace Office { * **Hosts**: Excel, Word */ DocumentSelectionChanged, + /** + * Triggers when the appointment location is changed in Outlook. Supported with task pane only. + * + * The event handler receives an argument of type `Office.EnhancedLocationsChangedEventArgs`. + * + * [Api set: Mailbox 1.8] + */ + EnhancedLocationsChanged, /** * Triggers when a different Outlook item is selected for viewing while the task pane is pinned. Supported with task pane only. * @@ -7592,6 +7608,56 @@ declare namespace Office { declare namespace Office { namespace MailboxEnums { + /** + * Specifies the formatting that applies to an attachment's content. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + */ + enum AttachmentContentFormat { + /** + * The content of the attachment is returned as a base64-encoded string. + */ + Base64 = "base64", + + /** + * The content of the attachment is returned as a string representing a URL. + */ + Url = "url", + + /** + * The content of the attachment is returned as a string representing an .eml formatted file. + */ + Eml = "eml", + + /** + * The content of the attachment is returned as a string representing an .icalendar formatted file. + */ + ICalendar = "iCalendar" + } + /** + * Specifies whether an attachment was added to or removed from an item. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + */ + enum AttachmentStatus { + /** + * An attachment was added to the item. + */ + Added = "added", + + /** + * An attachment was removed from the item. + */ + Removed = "removed" + } /** * Specifies an attachment's type. * @@ -7615,6 +7681,124 @@ declare namespace Office { */ Cloud = "cloud" } + /** + * Specifies the category color. + * + * **Note**: The actual color depends on how the Outlook client renders it. + * In this case, the colors noted on each preset are for the Outlook desktop client. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + */ + enum CategoryColor { + /** + * Default color or no color mapped + */ + None, + /** + * Red + */ + Preset0, + /** + * Orange + */ + Preset1, + /** + * Brown + */ + Preset2, + /** + * Yellow + */ + Preset3, + /** + * Green + */ + Preset4, + /** + * Teal + */ + Preset5, + /** + * Olive + */ + Preset6, + /** + * Blue + */ + Preset7, + /** + * Purple + */ + Preset8, + /** + * Cranberry + */ + Preset9, + /** + * Steel + */ + Preset10, + /** + * DarkSteel + */ + Preset11, + /** + * Gray + */ + Preset12, + /** + * DarkGray + */ + Preset13, + /** + * Black + */ + Preset14, + /** + * DarkRed + */ + Preset15, + /** + * DarkOrange + */ + Preset16, + /** + * DarkBrown + */ + Preset17, + /** + * DarkYellow + */ + Preset18, + /** + * DarkGreen + */ + Preset19, + /** + * DarkTeal + */ + Preset20, + /** + * DarkOlive + */ + Preset21, + /** + * DarkBlue + */ + Preset22, + /** + * DarkPurple + */ + Preset23, + /** + * DarkCranberry + */ + Preset24 + } /** * Specifies the day of week or type of day. * @@ -7666,6 +7850,41 @@ declare namespace Office { */ Day = "day" } + /** + * This bit mask represents a delegate's permissions on a shared folder. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + */ + enum DelegatePermissions { + /** + * Delegate has permission to read items. + */ + Read = 1, + /** + * Delegate has permission to create and write items. + */ + Write = 2, + /** + * Delegate has permission to delete only the items they created. + */ + DeleteOwn = 4, + /** + * Delegate has permission to delete any items. + */ + DeleteAll = 8, + /** + * Delegate has permission to edit only they items they created. + */ + EditOwn = 16, + /** + * Delegate has permission to edit any items. + */ + EditAll = 32 + } /** * Specifies an entity's type. * @@ -7747,6 +7966,25 @@ declare namespace Office { */ Appointment = "appointment" } + /** + * Specifies an appointment location's type. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + */ + enum LocationType { + /** + * A custom location. + */ + Custom = "custom", + /** + * A conference room or similar resource. + */ + Room = "room" + } /** * Specifies the month. * @@ -8537,11 +8775,11 @@ declare namespace Office { Subject } /** - * The subclass of {@link Office.Item} dealing with appointments. + * The subclass of {@link Office.Item | Item} dealing with appointments. * * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces. * You should treat this as a mode of Office.context.mailbox.item. Refer to the - * {@link https://docs.microsoft.com/office/dev/add-ins/reference/objectmodel/requirement-set-1.7/office.context.mailbox.item | Object Model} page for more information. + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/objectmodel/requirement-set-1.8/office.context.mailbox.item | Object Model} page for more information. */ interface Appointment extends Item { } @@ -8550,7 +8788,7 @@ declare namespace Office { * * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces. * You should treat this as a mode of Office.context.mailbox.item. Refer to the - * {@link https://docs.microsoft.com/office/dev/add-ins/reference/objectmodel/requirement-set-1.7/office.context.mailbox.item | Object Model} page for more information. + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/objectmodel/requirement-set-1.8/office.context.mailbox.item | Object Model} page for more information. */ interface AppointmentCompose extends Appointment, ItemCompose { /** @@ -8565,10 +8803,22 @@ declare namespace Office { * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer */ body: Body; + /** + * Gets an object that provides methods for managing the item's categories. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + */ + categories: Categories; /** * Gets or sets the date and time that the appointment is to end. * - * The end property is an {@link Office.Time} object expressed as a Coordinated Universal Time (UTC) date and time value. + * The end property is a {@link Office.Time | Time} object expressed as a Coordinated Universal Time (UTC) date and time value. * You can use the convertToLocalClientTime method to convert the end property value to the client's local date and time. * * When you use the Time.setAsync method to set the end time, you should use the convertToUtcClientTime method to convert the local time on @@ -8583,6 +8833,19 @@ declare namespace Office { * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer */ end: Time; + /** + * Gets or sets the locations of the appointment. The `enhancedLocation` property returns an {@link Office.EnhancedLocation | EnhancedLocation} + * object that provides methods to get, remove, or add locations on an item. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + */ + enhancedLocation: EnhancedLocation; /** * Gets the type of item that an instance represents. * @@ -8598,7 +8861,7 @@ declare namespace Office { */ itemType: MailboxEnums.ItemType | string; /** - * Gets or sets the {@link Office.Location} of an appointment. The location property returns a Location object that provides methods that are + * Gets or sets the location of an appointment. The location property returns a {@link Office.Location | Location} object that provides methods that are * used to get and set the location of the appointment. * * [Api set: Mailbox 1.0] @@ -8623,8 +8886,9 @@ declare namespace Office { */ notificationMessages: NotificationMessages; /** - * Provides access to the optional attendees of an event. The type of object and level of access depends on the mode of the current item. - * The optionalAttendees property returns an {@link Office.Recipients} object that provides methods to get or update the optional attendees + * Provides access to the optional attendees of an event. The type of object and level of access depends on the mode of the current item. + * + * The optionalAttendees property returns a {@link Office.Recipients | Recipients} object that provides methods to get or update the optional attendees * for a meeting. By default, the collection is limited to a maximum of 100 members. However, on Windows and Mac, the following limits apply. * * - Get 500 members maximum. @@ -8677,7 +8941,7 @@ declare namespace Office { /** * Provides access to the required attendees of an event. The type of object and level of access depends on the mode of the current item. * - * The requiredAttendees property returns an {@link Office.Recipients} object that provides methods to get or update the required attendees + * The requiredAttendees property returns a {@link Office.Recipients | Recipients} object that provides methods to get or update the required attendees * for a meeting. By default, the collection is limited to a maximum of 100 members. However, on Windows and Mac, the following limits apply. * * - Get 500 members maximum. @@ -8719,7 +8983,7 @@ declare namespace Office { /** * Gets or sets the date and time that the appointment is to begin. * - * The start property is an {@link Office.Time} object expressed as a Coordinated Universal Time (UTC) date and time value. + * The start property is a {@link Office.Time | Time} object expressed as a Coordinated Universal Time (UTC) date and time value. * You can use the convertToLocalClientTime method to convert the value to the client's local date and time. * * When you use the Time.setAsync method to set the start time, you should use the convertToUtcClientTime method to convert the local time on @@ -8814,11 +9078,81 @@ declare namespace Office { * If uploading the attachment fails, the asyncResult object will contain an Error object that provides a description of the error. */ addFileAttachmentAsync(uri: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult) => void): void; + /** + * Adds a file to a message or appointment as an attachment. + * + * The addFileAttachmentFromBase64Async method uploads the file from the base64 encoding and attaches it to the item in the compose form. + * This method returns the attachment identifier in the asyncResult.value object. + * + * You can subsequently use the identifier with the removeAttachmentAsync method to remove the attachment in the same session. + * + * **Note**: If you're using a data URL API (e.g., readAsDataURL), you need to strip out the data URL prefix then send the rest of the string to this API. + * For example, if the full string is represented by `data:image/svg+xml;base64,`, remove `data:image/svg+xml;base64,`. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * + * **Errors**: + * + * - AttachmentSizeExceeded: The attachment is larger than allowed. + * + * - FileTypeNotSupported: The attachment has an extension that is not allowed. + * + * - NumberOfAttachmentsExceeded: The message or appointment has too many attachments. + * + * @param base64File - The base64 encoded content of an image or file to be added to an email or event. + * @param attachmentName - The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters. + * @param options - Optional. 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 method. + * isInline: If true, indicates that the attachment will be shown inline in the message body and should not be displayed in the attachment list. + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type Office.AsyncResult. + * On success, the attachment identifier will be provided in the asyncResult.value property. + * If uploading the attachment fails, the asyncResult object will contain an Error object that provides a description of the error. + */ + addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, options?: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult) => void): void; + /** + * Adds a file to a message or appointment as an attachment. + * + * The addFileAttachmentFromBase64Async method uploads the file from the base64 encoding and attaches it to the item in the compose form. + * This method returns the attachment identifier in the asyncResult.value object. + * + * You can subsequently use the identifier with the removeAttachmentAsync method to remove the attachment in the same session. + * + * **Note**: If you're using a data URL API (e.g., readAsDataURL), you need to strip out the data URL prefix then send the rest of the string to this API. + * For example, if the full string is represented by `data:image/svg+xml;base64,`, remove `data:image/svg+xml;base64,`. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * + * **Errors**: + * + * - AttachmentSizeExceeded: The attachment is larger than allowed. + * + * - FileTypeNotSupported: The attachment has an extension that is not allowed. + * + * - NumberOfAttachmentsExceeded: The message or appointment has too many attachments. + * + * @param base64File - The base64 encoded content of an image or file to be added to an email or event. + * @param attachmentName - The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters. + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type Office.AsyncResult. + * On success, the attachment identifier will be provided in the asyncResult.value property. + * If uploading the attachment fails, the asyncResult object will contain an Error object that provides a description of the error. + */ + addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Adds an event handler for a supported event. **Note**: Events are available only with task pane. * - * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and - * `Office.EventType.RecurrenceChanged`. + * To see which event types are supported, see `Office.EventType` for details. * * [Api set: Mailbox 1.7] * @@ -8840,8 +9174,7 @@ declare namespace Office { /** * Adds an event handler for a supported event. **Note**: Events are available only with task pane. * - * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and - * `Office.EventType.RecurrenceChanged`. + * To see which event types are supported, see `Office.EventType` for details. * * [Api set: Mailbox 1.7] * @@ -8944,6 +9277,90 @@ declare namespace Office { * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer */ close(): void; + /** + * Gets the item's attachments as an array. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * + * @param options - Optional. 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 method. + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of + * type Office.AsyncResult. If the call fails, the asyncResult.error property will contain and error code with the reason for + * the failure. + */ + getAttachmentsAsync(options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; + /** + * Gets the item's attachments as an array. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of + * type Office.AsyncResult. If the call fails, the asyncResult.error property will contain and error code with the reason for + * the failure. + */ + getAttachmentsAsync(callback?: (asyncResult: Office.AsyncResult) => void): void; + /** + * Asynchronously gets the ID of a saved item. + * + * When invoked, this method returns the item ID via the callback method. + * + * **Note**: If your add-in calls `getItemIdAsync` on an item in compose mode (e.g., to get an `itemId` to use with EWS or the REST API), + * be aware that when Outlook is in cached mode, it may take some time before the item is synced to the server. + * Until the item is synced, the `itemId` is not recognized and using it returns an error. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * + * **Errors**: + * + * - `ItemNotSaved`: The id can't be retrieved until the item is saved. + * + * @param options - 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 method. + * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of type Office.AsyncResult. + */ + getItemIdAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void): void; + /** + * Asynchronously gets the ID of a saved item. + * + * When invoked, this method returns the item ID via the callback method. + * + * **Note**: If your add-in calls `getItemIdAsync` on an item in compose mode (e.g., to get an `itemId` to use with EWS or the REST API), + * be aware that when Outlook is in cached mode, it may take some time before the item is synced to the server. + * Until the item is synced, the `itemId` is not recognized and using it returns an error. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Organizer + * + * **Errors**: + * + * - `ItemNotSaved`: The id can't be retrieved until the item is saved. + * + * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of type Office.AsyncResult. + */ + getItemIdAsync(callback: (asyncResult: Office.AsyncResult) => void): void; /** * Asynchronously returns selected data from the subject or body of a message. * @@ -9081,8 +9498,7 @@ declare namespace Office { /** * Removes the event handlers for a supported event type. **Note**: Events are available only with task pane. * - * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and - * `Office.EventType.RecurrenceChanged`. + * To see which event types are supported, see `Office.EventType` for details. * * [Api set: Mailbox 1.7] * @@ -9102,8 +9518,7 @@ declare namespace Office { /** * Removes the event handlers for a supported event type. **Note**: Events are available only with task pane. * - * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and - * `Office.EventType.RecurrenceChanged`. + * To see which event types are supported, see `Office.EventType` for details. * * [Api set: Mailbox 1.7] * @@ -9441,7 +9856,7 @@ declare namespace Office { * * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces. * You should treat this as a mode of Office.context.mailbox.item. Refer to the - * {@link https://docs.microsoft.com/office/dev/add-ins/reference/objectmodel/requirement-set-1.7/office.context.mailbox.item | Object Model} page for more information. + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/objectmodel/requirement-set-1.8/office.context.mailbox.item | Object Model} page for more information. */ interface AppointmentRead extends Appointment, ItemRead { /** @@ -9472,6 +9887,18 @@ declare namespace Office { * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee */ body: Body; + /** + * Gets an object that provides methods for managing the item's categories. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + */ + categories: Categories; /** * Gets the date and time that an item was created. * @@ -9516,6 +9943,21 @@ declare namespace Office { * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee */ end: Date; + /** + * Gets the locations of an appointment. + * + * The enhancedLocation property returns an {@link Office.EnhancedLocation | EnhancedLocation} object that allows you to get the set of locations + * (each represented by a {@link Office.LocationDetails | LocationDetails} object) associated with the appointment. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee + */ + enhancedLocation: EnhancedLocation; /** * Gets the Exchange Web Services item class of the selected item. * @@ -9631,7 +10073,7 @@ declare namespace Office { /** * Provides access to the optional attendees of an event. The type of object and level of access depends on the mode of the current item. * - * The optionalAttendees property returns an array that contains an {@link Office.EmailAddressDetails} object for each optional attendee to + * The optionalAttendees property returns an array that contains an {@link Office.EmailAddressDetails | EmailAddressDetails} object for each optional attendee to * the meeting. By default, the collection is limited to a maximum of 100 members. However, on Windows and Mac, you can get 500 members maximum. * * [Api set: Mailbox 1.0] @@ -9678,7 +10120,7 @@ declare namespace Office { /** * Provides access to the required attendees of an event. The type of object and level of access depends on the mode of the current item. * - * The requiredAttendees property returns an array that contains an {@link Office.EmailAddressDetails} object for each required attendee to + * The requiredAttendees property returns an array that contains an {@link Office.EmailAddressDetails | EmailAddressDetails} object for each required attendee to * the meeting. By default, the collection is limited to a maximum of 100 members. However, on Windows and Mac, you can get 500 members maximum. * * [Api set: Mailbox 1.0] @@ -9748,8 +10190,7 @@ declare namespace Office { /** * Adds an event handler for a supported event. **Note**: Events are available only with task pane. * - * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and - * `Office.EventType.RecurrenceChanged`. + * To see which event types are supported, see `Office.EventType` for details. * * [Api set: Mailbox 1.7] * @@ -9771,8 +10212,7 @@ declare namespace Office { /** * Adds an event handler for a supported event. **Note**: Events are available only with task pane. * - * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and - * `Office.EventType.RecurrenceChanged`. + * To see which event types are supported, see `Office.EventType` for details. * * [Api set: Mailbox 1.7] * @@ -9812,7 +10252,7 @@ declare namespace Office { * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee * * @param formData - A string that contains text and HTML and that represents the body of the reply form. The string is limited to 32 KB - * OR an {@link Office.ReplyFormData} object that contains body or attachment data and a callback function. + * OR a {@link Office.ReplyFormData | ReplyFormData} object that contains body or attachment data and a callback function. * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, * asyncResult, which is an Office.AsyncResult object. */ @@ -9839,7 +10279,7 @@ declare namespace Office { * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Appointment Attendee * * @param formData - A string that contains text and HTML and that represents the body of the reply form. The string is limited to 32 KB - * OR an {@link Office.ReplyFormData} object that contains body or attachment data and a callback function. + * OR a {@link Office.ReplyFormData | ReplyFormData} object that contains body or attachment data and a callback function. * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, * asyncResult, which is an Office.AsyncResult object. */ @@ -10076,8 +10516,7 @@ declare namespace Office { /** * Removes the event handlers for a supported event type. **Note**: Events are available only with task pane. * - * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and - * `Office.EventType.RecurrenceChanged`. + * To see which event types are supported, see `Office.EventType` for details. * * [Api set: Mailbox 1.7] * @@ -10097,8 +10536,7 @@ declare namespace Office { /** * Removes the event handlers for a supported event type. **Note**: Events are available only with task pane. * - * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and - * `Office.EventType.RecurrenceChanged`. + * To see which event types are supported, see `Office.EventType` for details. * * [Api set: Mailbox 1.7] * @@ -10114,6 +10552,60 @@ declare namespace Office { */ removeHandlerAsync(eventType: Office.EventType | string, callback?: (asyncResult: Office.AsyncResult) => void): void; } + /** + * Provides the current dates and times of the appointment that raised the `Office.EventType.AppointmentTimeChanged` event. + * + * [Api set: Mailbox 1.7] + */ + export interface AppointmentTimeChangedEventArgs { + /** + * Gets the appointment end date and time. + * + * [Api set: Mailbox 1.7] + */ + end: Date; + /** + * Gets the appointment start date and time. + * + * [Api set: Mailbox 1.7] + */ + start: Date; + /** + * Gets the type of the event. See `Office.EventType` for details. + * + * [Api set: Mailbox 1.7] + */ + type: "olkAppointmentTimeChanged"; + } + /** + * Represents the content of an attachment on a message or appointment item. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + */ + interface AttachmentContent { + /** + * The content of an attachment as a string. + */ + content: string; + /** + * The string format to use for an attachment's content. + * + * For file attachments, the formatting is a base64-encoded string. + * + * For item attachments that represent messages, the formatting is a string representing an .eml formatted file. + * + * For item attachments that represent calendar items, the formatting is a string representing an .icalendar file. + * + * For cloud attachments, the formatting is a URL string. + */ + format: MailboxEnums.AttachmentContentFormat | string; + } /** * Represents an attachment on an item from the server. Read mode only. * @@ -10152,6 +10644,38 @@ declare namespace Office { * Gets the size of the attachment in bytes. */ size: number; + /** + * Gets the url of the attachment if its type is `MailboxEnums.AttachmentType.Cloud`. + * + * [Api set: Mailbox 1.8] + */ + url: string; + } + /** + * Provides information about the attachments that raised the `Office.EventType.AttachmentsChanged` event. + * + * [Api set: Mailbox 1.8] + */ + export interface AttachmentsChangedEventArgs { + /** + * Represents the set of attachments that were added or removed. + * For each such attachment, gets a subset of {@link Office.AttachmentDetails | AttachmentDetails} properties: `id`, `name`, `size`, and `attachmentType`. + * + * [Api set: Mailbox 1.8] + */ + attachmentDetails: object[]; + /** + * Gets whether the attachments were added or removed. See {@link Office.MailboxEnums.AttachmentStatus | MailboxEnums.AttachmentStatus} for details. + * + * [Api set: Mailbox 1.8] + */ + attachmentStatus: MailboxEnums.AttachmentStatus | string; + /** + * Gets the type of the event. See `Office.EventType` for details. + * + * [Api set: Mailbox 1.8] + */ + type: "olkAttachmentsChanged"; } /** * The body object provides methods for adding and updating the content of the message or appointment. @@ -10422,10 +10946,158 @@ declare namespace Office { */ setSelectedDataAsync(data: string, callback?: (asyncResult: Office.AsyncResult) => void): void; } + /** + * Represents the categories on an item. + * + * In Outlook, a user can group messages and appointments by using a category to color-code them. + * The user defines {@link Office.MasterCategories | categories in a master list} on their mailbox. + * They can then apply one or more categories to an item. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + */ + interface Categories { + /** + * Adds categories to an item. Each category must be in the categories master list on that mailbox and so must have a unique name + * but multiple categories can use the same color. + * + * @param categories - The categories to be added to the item. + * @param options - Optional. 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 method. + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of + * type Office.AsyncResult. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * + * **Errors**: + * + * - InvalidCategory: Invalid categories were provided. + */ + addAsync(categories: string[], options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; + /** + * Adds categories to an item. Each category must be in the categories master list on that mailbox and so must have a unique name + * but multiple categories can use the same color. + * + * @param categories - The categories to be added to the item. + * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of + * type Office.AsyncResult. If adding categories fails, the asyncResult.error property will contain an error code. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * + * **Errors**: + * + * - InvalidCategory: Invalid categories were provided. + */ + addAsync(categories: string[], callback: (asyncResult: Office.AsyncResult) => void): void; + /** + * Gets an item's categories. + * + * @param options - 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 method. + * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of + * type Office.AsyncResult. If adding categories fails, the asyncResult.error property will contain an error code. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + */ + getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void): void; + /** + * Gets an item's categories. + * + * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of + * type Office.AsyncResult. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + */ + getAsync(callback: (asyncResult: Office.AsyncResult) => void): void; + /** + * Removes categories from an item. + * + * @param categories - The categories to be removed from the item. + * @param options - Optional. 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 method. + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of + * type Office.AsyncResult. If removing categories fails, the asyncResult.error property will contain an error code. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + */ + removeAsync(categories: string[], options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; + /** + * Removes categories from an item. + * + * @param categories - The categories to be removed from the item. + * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of + * type Office.AsyncResult. If removing categories fails, the asyncResult.error property will contain an error code. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + */ + removeAsync(categories: string[], callback: (asyncResult: Office.AsyncResult) => void): void; + } + /** + * Represents a category's details like name and associated color. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + */ + interface CategoryDetails { + /** + * The name of the category. Maximum length is 255 characters. + */ + displayName: string; + /** + * The color of the category. + */ + color: MailboxEnums.CategoryColor | string; + } /** * Represents a contact stored on the server. Read mode only. * - * The list of contacts associated with an email message or appointment is returned in the contacts property of the {@link Office.Entities} object + * The list of contacts associated with an email message or appointment is returned in the contacts property of the {@link Office.Entities | Entities} object * that is returned by the getEntities or getEntitiesByType method of the active item. * * [Api set: Mailbox 1.0] @@ -10677,6 +11349,150 @@ declare namespace Office { */ emailAddress: string; } + /** + * Represents the set of locations on an appointment. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + */ + export interface EnhancedLocation { + /** + * Adds to the set of locations associated with the appointment. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * + * **Errors**: + * + * - InvalidFormatError: The format of the specified data object is not valid. + * + * @param locationIdentifiers The locations to be added to the current list of locations. + * @param options Optional. 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 method. + * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, + * asyncResult, which is an Office.AsyncResult object. Check the `status` property of asyncResult to determine if the call succeeded. + */ + addAsync(locationIdentifiers: LocationIdentifier[], options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResultStatus) => void): void; + /** + * Adds to the set of locations associated with the appointment. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * + * **Errors**: + * + * - InvalidFormatError: The format of the specified data object is not valid. + * + * @param locationIdentifiers The locations to be added to the current list of locations. + * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, + * asyncResult, which is an Office.AsyncResult object. Check the `status` property of asyncResult to determine if the call succeeded. + */ + addAsync(locationIdentifiers: LocationIdentifier[], callback?: (asyncResult: Office.AsyncResultStatus) => void): void; + /** + * Gets the set of locations associated with the appointment. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * + * @param options Optional. 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 method. + * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, + * asyncResult, which is an Office.AsyncResult object. + */ + getAsync(options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; + /** + * Gets the set of locations associated with the appointment. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * + * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, + * asyncResult, which is an Office.AsyncResult object. + */ + getAsync(callback?: (asyncResult: Office.AsyncResult) => void): void; + /** + * Removes the set of locations associated with the appointment. + * + * If there are multiple locations with the same name, all matching locations will be removed even if only one was specified in locationIdentifiers. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * + * @param locationIdentifiers The locations to be removed from the current list of locations. + * @param options Optional. 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 method. + * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, + * asyncResult, which is an Office.AsyncResult object. Check the `status` property of asyncResult to determine if the call succeeded. + */ + removeAsync(locationIdentifiers: LocationIdentifier[], options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResultStatus) => void): void; + /** + * Removes the set of locations associated with the appointment. + * + * If there are multiple locations with the same name, all matching locations will be removed even if only one was specified in locationIdentifiers. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * + * @param locationIdentifiers The locations to be removed from the current list of locations. + * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, + * asyncResult, which is an Office.AsyncResult object. Check the `status` property of asyncResult to determine if the call succeeded. + */ + removeAsync(locationIdentifiers: LocationIdentifier[], callback?: (asyncResult: Office.AsyncResultStatus) => void): void; + } + /** + * Provides the current enhanced locations when the `Office.EventType.EnhancedLocationsChanged` event is raised. + * + * [Api set: Mailbox 1.8] + */ + export interface EnhancedLocationsChangedEventArgs { + /** + * Gets the set of enhanced locations. + * + * [Api set: Mailbox 1.8] + */ + enhancedLocations: LocationDetails[]; + /** + * Gets the type of the event. See `Office.EventType` for details. + * + * [Api set: Mailbox 1.8] + */ + type: "olkEnhancedLocationsChanged"; + } /** * Represents a collection of entities found in an email message or appointment. Read mode only. * @@ -10755,7 +11571,7 @@ declare namespace Office { * * The getAsync method starts an asynchronous call to the Exchange server to get the from value of a message. * - * The from value of the item is provided as an {@link Office.EmailAddressDetails} in the asyncResult.value property. + * The from value of the item is provided as an {@link Office.EmailAddressDetails | EmailAddressDetails} in the asyncResult.value property. * * [Api set: Mailbox 1.7] * @@ -10777,7 +11593,7 @@ declare namespace Office { * * The getAsync method starts an asynchronous call to the Exchange server to get the from value of a message. * - * The from value of the item is provided as an {@link Office.EmailAddressDetails} in the asyncResult.value property. + * The from value of the item is provided as an {@link Office.EmailAddressDetails | EmailAddressDetails} in the asyncResult.value property. * * [Api set: Mailbox 1.7] * @@ -10793,10 +11609,158 @@ declare namespace Office { */ getAsync(callback?: (asyncResult: Office.AsyncResult) => void): void; } + /** + * The InternetHeaders object represents custom internet headers that are preserved after the message item leaves Exchange and is converted to a MIME message. + * These headers are stored as x-headers in the MIME message. + * + * InternetHeaders are stored as key/value pairs on a per-item basis. + * + * **Note**: This object is intended for you to set and get your custom headers on a message item. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + */ + interface InternetHeaders { + /** + * Given an array of internet header names, this method returns a dictionary containing those internet headers and their values. + * If the add-in requests an x-header that is not available, that x-header will not be returned in the results. + * + * **Note**: This method is intended to return the values of the custom headers you set using the `setAsync` method. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * + * @param names - The names of the internet headers to be returned. + * @param options - Optional. 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 method. + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, + * asyncResult, which is an Office.AsyncResult object. + */ + getAsync(names: string[], options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; + /** + * Given an array of internet header names, this method returns a dictionary containing those internet headers and their values. + * If the add-in requests an x-header that is not available, that x-header will not be returned in the results. + * + * **Note**: This method is intended to return the values of the custom headers you set using the `setAsync` method. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * + * @param names - The names of the internet headers to be returned. + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, + * asyncResult, which is an Office.AsyncResult object. + */ + getAsync(names: string[], callback?: (asyncResult: Office.AsyncResult) => void): void; + /** + * Given an array of internet header names, this method removes the specified headers from the internet header collection. + * + * **Note**: This method is intended to remove the custom headers you set using the `setAsync` method. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * + * @param names - The names of the internet headers to be removed. + * @param options - Optional. 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 method. + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, + * asyncResult, which is an Office.AsyncResult object. + */ + removeAsync(names: string[], options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; + /** + * Given an array of internet header names, this method removes the specified headers from the internet header collection. + * + * **Note**: This method is intended to remove your custom headers you set using the `setAsync` method. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * + * @param names - The names of the internet headers to be removed. + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, + * asyncResult, which is an Office.AsyncResult object. + */ + removeAsync(names: string[], callback?: (asyncResult: Office.AsyncResult) => void): void; + /** + * Sets the specified internet headers to the specified values. + * + * The setAsync method creates a new header if the specified header doesn't already exist; otherwise, the existing value is replaced with + * the new value. + * + * **Note**: This method is intended to set the values of your custom headers. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * + * @param headers - The names and corresponding values of the headers to be set. Should be a dictionary object with keys being the names of the + * internet headers and values being the values of the internet headers. + * @param options - Optional. 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 method. + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type Office.AsyncResult. + * Any errors encountered will be provided in the asyncResult.error property. + */ + setAsync(headers: Object, options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; + /** + * Sets the specified internet headers to the specified values. + * + * The setAsync method creates a new header if the specified header doesn't already exist; otherwise, the existing value is replaced with + * the new value. + * + * **Note**: This method is intended to set the values of your custom headers. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * + * @param headers - The names and corresponding values of the headers to be set. Should be a dictionary object with keys being the names of the + * internet headers and values being the values of the internet headers. + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type Office.AsyncResult. + * Any errors encountered will be provided in the asyncResult.error property. + */ + setAsync(headers: Object, callback?: (asyncResult: Office.AsyncResult) => void): void; + } /** * The item namespace is used to access the currently selected message, meeting request, or appointment. * You can determine the type of the item by using the `itemType` property. * + * If you want to see IntelliSense for only a specific type, cast this item to one of the following: + * + * {@link Office.ItemCompose | ItemCompose}, {@link Office.ItemRead | ItemRead}, + * {@link Office.MessageCompose | MessageCompose}, {@link Office.MessageRead | MessageRead}, + * {@link Office.AppointmentCompose | AppointmentCompose}, {@link Office.AppointmentRead | AppointmentRead} + * * [Api set: Mailbox 1.0] * * @remarks @@ -10818,6 +11782,18 @@ declare namespace Office { * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read */ body: Body; + /** + * Gets an object that provides methods for managing the item's categories. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + */ + categories: Categories; /** * Gets the type of item that an instance represents. * @@ -10872,8 +11848,7 @@ declare namespace Office { /** * Adds an event handler for a supported event. **Note**: Events are available only with task pane. * - * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and - * `Office.EventType.RecurrenceChanged`. + * To see which event types are supported, see `Office.EventType` for details. * * [Api set: Mailbox 1.7] * @@ -10895,8 +11870,7 @@ declare namespace Office { /** * Adds an event handler for a supported event. **Note**: Events are available only with task pane. * - * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and - * `Office.EventType.RecurrenceChanged`. + * To see which event types are supported, see `Office.EventType` for details. * * [Api set: Mailbox 1.7] * @@ -10913,6 +11887,96 @@ declare namespace Office { * asyncResult, which is an Office.AsyncResult object. */ addHandlerAsync(eventType: Office.EventType | string, handler: any, callback?: (asyncResult: Office.AsyncResult) => void): void; + /** + * Gets an attachment from a message or appointment and returns it as an **AttachmentContent** object. + * + * The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should use + * the identifier to retrieve an attachment in the same session that the attachmentIds were retrieved with the `getAttachmentsAsync` or + * `item.attachments` call. In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session. + * A session is over when the user closes the app, or if the user starts composing an inline form then subsequently pops out the form to + * continue in a separate window. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * + * **Errors**: + * + * - InvalidAttachmentId: The attachment identifier does not exist. + * + * @param attachmentId - The identifier of the attachment you want to get. + * @param options - Optional. 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 method. + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, + * asyncResult, which is an Office.AsyncResult object. If the call fails, the asyncResult.error property will contain and error code + * with the reason for the failure. + */ + getAttachmentContentAsync(attachmentId: string, options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; + /** + * Gets an attachment from a message or appointment and returns it as an **AttachmentContent** object. + * + * The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should use + * the identifier to retrieve an attachment in the same session that the attachmentIds were retrieved with the `getAttachmentsAsync` or + * `item.attachments` call. In Outlook on the web and mobile devices, the attachment identifier is valid only within the same session. + * A session is over when the user closes the app, or if the user starts composing an inline form then subsequently pops out the form to + * continue in a separate window. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * + * **Errors**: + * + * - InvalidAttachmentId: The attachment identifier does not exist. + * + * @param attachmentId - The identifier of the attachment you want to get. + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, + * asyncResult, which is an Office.AsyncResult object. If the call fails, the asyncResult.error property will contain and error code + * with the reason for the failure. + */ + getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult) => void): void; + /** + * Gets the properties of an appointment or message in a shared folder, calendar, or mailbox. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * + * @param options - 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 method. + * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of + * type Office.AsyncResult. + * The `value` property of the result is the properties of the shared item. + */ + getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void): void; + /** + * Gets the properties of an appointment or message in a shared folder, calendar, or mailbox. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * + * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of + * type Office.AsyncResult. + * The `value` property of the result is the properties of the shared item. + */ + getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void): void; /** * Asynchronously loads custom properties for this add-in on the selected item. * @@ -10941,8 +12005,7 @@ declare namespace Office { /** * Removes the event handlers for a supported event type. **Note**: Events are available only with task pane. * - * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and - * `Office.EventType.RecurrenceChanged`. + * To see which event types are supported, see `Office.EventType` for details. * * [Api set: Mailbox 1.7] * @@ -10962,8 +12025,7 @@ declare namespace Office { /** * Removes the event handlers for a supported event type. **Note**: Events are available only with task pane. * - * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and - * `Office.EventType.RecurrenceChanged`. + * To see which event types are supported, see `Office.EventType` for details. * * [Api set: Mailbox 1.7] * @@ -10984,7 +12046,7 @@ declare namespace Office { * * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces. * You should treat this as a mode of Office.context.mailbox.item. Refer to the - * {@link https://docs.microsoft.com/office/dev/add-ins/reference/objectmodel/requirement-set-1.7/office.context.mailbox.item | Object Model} page for more information. + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/objectmodel/requirement-set-1.8/office.context.mailbox.item | Object Model} page for more information. */ interface ItemCompose extends Item { /** @@ -11070,6 +12132,77 @@ declare namespace Office { * the error. */ addFileAttachmentAsync(uri: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult) => void): void; + /** + * Adds a file to a message or appointment as an attachment. + * + * The addFileAttachmentFromBase64Async method uploads the file from the base64 encoding and attaches it to the item in the compose form. + * This method returns the attachment identifier in the asyncResult.value object. + * + * You can subsequently use the identifier with the removeAttachmentAsync method to remove the attachment in the same session. + * + * **Note**: If you're using a data URL API (e.g., readAsDataURL), you need to strip out the data URL prefix then send the rest of the string to this API. + * For example, if the full string is represented by `data:image/svg+xml;base64,`, remove `data:image/svg+xml;base64,`. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * + * **Errors**: + * + * - AttachmentSizeExceeded: The attachment is larger than allowed. + * + * - FileTypeNotSupported: The attachment has an extension that is not allowed. + * + * - NumberOfAttachmentsExceeded: The message or appointment has too many attachments. + * + * @param base64File - The base64 encoded content of an image or file to be added to an email or event. + * @param attachmentName - The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters. + * @param options - Optional. 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 method. + * isInline: If true, indicates that the attachment will be shown inline in the message body and should not be displayed in the attachment list. + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type Office.AsyncResult. + * On success, the attachment identifier will be provided in the asyncResult.value property. + * If uploading the attachment fails, the asyncResult object will contain an Error object that provides a description of the error. + */ + addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, options?: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult) => void): void; + /** + * Adds a file to a message or appointment as an attachment. + * + * The addFileAttachmentFromBase64Async method uploads the file from the base64 encoding and attaches it to the item in the compose form. + * This method returns the attachment identifier in the asyncResult.value object. + * + * You can subsequently use the identifier with the removeAttachmentAsync method to remove the attachment in the same session. + * + * **Note**: If you're using a data URL API (e.g., readAsDataURL), you need to strip out the data URL prefix then send the rest of the string to this API. + * For example, if the full string is represented by `data:image/svg+xml;base64,`, remove `data:image/svg+xml;base64,`. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * + * **Errors**: + * + * - AttachmentSizeExceeded: The attachment is larger than allowed. + * + * - FileTypeNotSupported: The attachment has an extension that is not allowed. + * + * - NumberOfAttachmentsExceeded: The message or appointment has too many attachments. + * + * @param base64File - The base64 encoded content of an image or file to be added to an email or event. + * @param attachmentName - The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters. + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type Office.AsyncResult. + * On success, the attachment identifier will be provided in the asyncResult.value property. + * If uploading the attachment fails, the asyncResult object will contain an Error object that provides a description of the error. + */ + addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Adds an Exchange item, such as a message, as an attachment to the message or appointment. * @@ -11158,6 +12291,40 @@ declare namespace Office { * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose */ close(): void; + /** + * Gets the item's attachments as an array. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * + * @param options - Optional. 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 method. + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of + * type Office.AsyncResult. If the call fails, the asyncResult.error property will contain and error code with the reason for + * the failure. + */ + getAttachmentsAsync(options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; + /** + * Gets the item's attachments as an array. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose + * + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of + * type Office.AsyncResult. If the call fails, the asyncResult.error property will contain and error code with the reason for + * the failure. + */ + getAttachmentsAsync(callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Asynchronously returns selected data from the subject or body of a message. * @@ -11413,7 +12580,7 @@ declare namespace Office { * * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces. * You should treat this as a mode of Office.context.mailbox.item. Refer to the - * {@link https://docs.microsoft.com/office/dev/add-ins/reference/objectmodel/requirement-set-1.7/office.context.mailbox.item | Object Model} page for more information. + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/objectmodel/requirement-set-1.8/office.context.mailbox.item | Object Model} page for more information. */ interface ItemRead extends Item { /** @@ -11546,7 +12713,7 @@ declare namespace Office { * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Read * * @param formData - A string that contains text and HTML and that represents the body of the reply form. The string is limited to 32 KB - * OR an {@link Office.ReplyFormData} object that contains body or attachment data and a callback function. + * OR a {@link Office.ReplyFormData | ReplyFormData} object that contains body or attachment data and a callback function. * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, * asyncResult, which is an Office.AsyncResult object. */ @@ -11573,7 +12740,7 @@ declare namespace Office { * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Read * * @param formData - A string that contains text and HTML and that represents the body of the reply form. The string is limited to 32 KB - * OR an {@link Office.ReplyFormData} object that contains body or attachment data and a callback function. + * OR a {@link Office.ReplyFormData | ReplyFormData} object that contains body or attachment data and a callback function. * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, * asyncResult, which is an Office.AsyncResult object. */ @@ -11926,6 +13093,56 @@ declare namespace Office { */ setAsync(location: string, callback?: (asyncResult: Office.AsyncResult) => void): void; } + /** + * Represents a location. Read only. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + */ + export interface LocationDetails { + /** + * The LocationIdentifier of the location. + */ + locationIdentifier: LocationIdentifier; + /** + * The location's display name. + */ + displayName: string; + /** + * The email address associated with the location. + */ + emailAddress: string; + } + /** + * Represents the id of a location. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + */ + interface LocationIdentifier { + /** + * The location's unique id. + * + * For **Room** type, it's the room's email address. + * + * For **Custom** type, it's the displayName. + */ + id: string; + /** + * The location's type. + */ + type: MailboxEnums.LocationType | string; + } /** * Provides access to the Outlook Add-in object model for Microsoft Outlook and Microsoft Outlook on the web. * @@ -11999,11 +13216,26 @@ declare namespace Office { */ ewsUrl: string; /** - * The mailbox item. Depending on the context in which the add-in opened, the item may be of any number of types. - * If you want to see IntelliSense for only a specific type, you should cast this item to one of the following: - * `ItemCompose`, `ItemRead`, `MessageCompose`, `MessageRead`, `AppointmentCompose`, `AppointmentRead` + * The mailbox item. Depending on the context in which the add-in opened, the item may be of any number of types. + * If you want to see IntelliSense for only a specific type, cast this item to one of the following: + * + * {@link Office.ItemCompose | ItemCompose}, {@link Office.ItemRead | ItemRead}, + * {@link Office.MessageCompose | MessageCompose}, {@link Office.MessageRead | MessageRead}, + * {@link Office.AppointmentCompose | AppointmentCompose}, {@link Office.AppointmentRead | AppointmentRead} */ item: Item & ItemCompose & ItemRead & MessageRead & MessageCompose & AppointmentRead & AppointmentCompose; + /** + * Gets an object that provides methods to manage the categories master list associated with a mailbox. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteMailbox + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + */ + masterCategories: MasterCategories; /** * Gets the URL of the REST endpoint for this email account. * @@ -12033,7 +13265,7 @@ declare namespace Office { /** * Adds an event handler for a supported event. **Note**: Events are available only with task pane. * - * Currently, the only supported event type is `Office.EventType.ItemChanged`. + * To see which event types are supported, see `Office.EventType` for details. * * [Api set: Mailbox 1.5] * @@ -12054,7 +13286,7 @@ declare namespace Office { /** * Adds an event handler for a supported event. **Note**: Events are available only with task pane. * - * Currently, the only supported event type is `Office.EventType.ItemChanged`. + * To see which event types are supported, see `Office.EventType` for details. * * [Api set: Mailbox 1.5] * @@ -12255,13 +13487,13 @@ declare namespace Office { * * @param parameters - A dictionary containing all values to be filled in for the user in the new form. All parameters are optional. * - * toRecipients: An array of strings containing the email addresses or an array containing an {@link Office.EmailAddressDetails} object + * toRecipients: An array of strings containing the email addresses or an array containing an {@link Office.EmailAddressDetails | EmailAddressDetails} object * for each of the recipients on the To line. The array is limited to a maximum of 100 entries. * - * ccRecipients: An array of strings containing the email addresses or an array containing an {@link Office.EmailAddressDetails} object + * ccRecipients: An array of strings containing the email addresses or an array containing an {@link Office.EmailAddressDetails | EmailAddressDetails} object * for each of the recipients on the Cc line. The array is limited to a maximum of 100 entries. * - * bccRecipients: An array of strings containing the email addresses or an array containing an {@link Office.EmailAddressDetails} object + * bccRecipients: An array of strings containing the email addresses or an array containing an {@link Office.EmailAddressDetails | EmailAddressDetails} object * for each of the recipients on the Bcc line. The array is limited to a maximum of 100 entries. * * subject: A string containing the subject of the message. The string is limited to a maximum of 255 characters. @@ -12475,7 +13707,7 @@ declare namespace Office { /** * Removes the event handlers for a supported event type. **Note**: Events are available only with task pane. * - * Currently, the only supported event type is `Office.EventType.ItemChanged`. + * To see which event types are supported, see `Office.EventType` for details. * * [Api set: Mailbox 1.5] * @@ -12494,7 +13726,7 @@ declare namespace Office { /** * Removes the event handlers for a supported event type. **Note**: Events are available only with task pane. * - * Currently, the only supported event type is `Office.EventType.ItemChanged`. + * To see which event types are supported, see `Office.EventType` for details. * * [Api set: Mailbox 1.5] * @@ -12510,6 +13742,142 @@ declare namespace Office { */ removeHandlerAsync(eventType: Office.EventType | string, callback?: (asyncResult: Office.AsyncResult) => void): void; } + /** + * Represents the categories master list on the mailbox. + * + * In Outlook, a user can group messages and appointments by using a category to color-code them. + * The user defines categories in a master list on their mailbox. They can then apply one or more categories to an item. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadMailbox + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + */ + interface MasterCategories { + /** + * Adds categories to the master list on a mailbox. Each category must have a unique name but multiple categories can use the same color. + * + * @param categories - The categories to be added to the master list on the mailbox. + * @param options - Optional. 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 method. + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of + * type Office.AsyncResult. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteMailbox + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * + * **Errors**: + * + * - DuplicateCategory: One of the categories provided is already in the master category list. + * + * - PermissionDenied: The user does not have permission to perform this action. + */ + addAsync(categories: CategoryDetails[], options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; + /** + * Adds categories to the master list on a mailbox. Each category must have a unique name but multiple categories can use the same color. + * + * @param categories - The categories to be added to the master list on the mailbox. + * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of + * type Office.AsyncResult. If adding categories fails, the asyncResult.error property will contain an error code. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteMailbox + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * + * **Errors**: + * + * - DuplicateCategory: One of the categories provided is already in the master category list. + * + * - PermissionDenied: The user does not have permission to perform this action. + */ + addAsync(categories: CategoryDetails[], callback: (asyncResult: Office.AsyncResult) => void): void; + /** + * Gets the master list of categories on a mailbox. + * + * @param options - 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 method. + * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of + * type Office.AsyncResult. If adding categories fails, the asyncResult.error property will contain an error code. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadMailbox + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + */ + getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void): void; + /** + * Gets the master list of categories on a mailbox. + * + * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of + * type Office.AsyncResult. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadMailbox + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + */ + getAsync(callback: (asyncResult: Office.AsyncResult) => void): void; + /** + * Removes categories from the master list on a mailbox. + * + * @param categories - The categories to be removed from the master list on the mailbox. + * @param options - Optional. 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 method. + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of + * type Office.AsyncResult. If removing categories fails, the asyncResult.error property will contain an error code. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteMailbox + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * + * **Errors**: + * + * - PermissionDenied: The user does not have permission to perform this action. + */ + removeAsync(categories: string[], options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; + /** + * Removes categories from the master list on a mailbox. + * + * @param categories - The categories to be removed from the master list on the mailbox. + * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of + * type Office.AsyncResult. If removing categories fails, the asyncResult.error property will contain an error code. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteMailbox + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + * + * **Errors**: + * + * - PermissionDenied: The user does not have permission to perform this action. + */ + removeAsync(categories: string[], callback: (asyncResult: Office.AsyncResult) => void): void; + } /** * Represents a suggested meeting found in an item. Read mode only. * @@ -12555,11 +13923,11 @@ declare namespace Office { subject: string; } /** - * A subclass of {@link Office.Item} for messages. + * A subclass of {@link Office.Item | Item} for messages. * * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces. * You should treat this as a mode of Office.context.mailbox.item. Refer to the - * {@link https://docs.microsoft.com/office/dev/add-ins/reference/objectmodel/requirement-set-1.7/office.context.mailbox.item | Object Model} page for more information. + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/objectmodel/requirement-set-1.8/office.context.mailbox.item | Object Model} page for more information. */ interface Message extends Item { /** @@ -12587,7 +13955,7 @@ declare namespace Office { * * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces. * You should treat this as a mode of Office.context.mailbox.item. Refer to the - * {@link https://docs.microsoft.com/office/dev/add-ins/reference/objectmodel/requirement-set-1.7/office.context.mailbox.item | Object Model} page for more information. + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/objectmodel/requirement-set-1.8/office.context.mailbox.item | Object Model} page for more information. */ interface MessageCompose extends Message, ItemCompose { /** @@ -12620,11 +13988,23 @@ declare namespace Office { * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose */ body: Body; + /** + * Gets an object that provides methods for managing the item's categories. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + */ + categories: Categories; /** * Provides access to the Cc (carbon copy) recipients of a message. The type of object and level of access depends on the mode of the * current item. * - * The cc property returns an {@link Office.Recipients} object that provides methods to get or update the recipients on the Cc line of + * The cc property returns a {@link Office.Recipients | Recipients} object that provides methods to get or update the recipients on the Cc line of * the message. By default, the collection is limited to a maximum of 100 members. However, on Windows and Mac, the following limits apply. * * - Get 500 members maximum. @@ -12676,6 +14056,20 @@ declare namespace Office { * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose */ from: From; + /** + * Gets or sets the custom internet headers of a message. + * + * The internetHeaders property returns an InternetHeaders object that provides methods to manage the internet headers on the message. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + */ + internetHeaders: InternetHeaders; /** * Gets the type of item that an instance represents. * @@ -12829,11 +14223,81 @@ declare namespace Office { * the error. */ addFileAttachmentAsync(uri: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult) => void): void; + /** + * Adds a file to a message or appointment as an attachment. + * + * The addFileAttachmentFromBase64Async method uploads the file from the base64 encoding and attaches it to the item in the compose form. + * This method returns the attachment identifier in the asyncResult.value object. + * + * You can subsequently use the identifier with the removeAttachmentAsync method to remove the attachment in the same session. + * + * **Note**: If you're using a data URL API (e.g., readAsDataURL), you need to strip out the data URL prefix then send the rest of the string to this API. + * For example, if the full string is represented by `data:image/svg+xml;base64,`, remove `data:image/svg+xml;base64,`. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * + * **Errors**: + * + * - AttachmentSizeExceeded: The attachment is larger than allowed. + * + * - FileTypeNotSupported: The attachment has an extension that is not allowed. + * + * - NumberOfAttachmentsExceeded: The message or appointment has too many attachments. + * + * @param base64File - The base64 encoded content of an image or file to be added to an email or event. + * @param attachmentName - The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters. + * @param options - Optional. 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 method. + * isInline: If true, indicates that the attachment will be shown inline in the message body and should not be displayed in the attachment list. + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type Office.AsyncResult. + * On success, the attachment identifier will be provided in the asyncResult.value property. + * If uploading the attachment fails, the asyncResult object will contain an Error object that provides a description of the error. + */ + addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, options?: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult) => void): void; + /** + * Adds a file to a message or appointment as an attachment. + * + * The addFileAttachmentFromBase64Async method uploads the file from the base64 encoding and attaches it to the item in the compose form. + * This method returns the attachment identifier in the asyncResult.value object. + * + * You can subsequently use the identifier with the removeAttachmentAsync method to remove the attachment in the same session. + * + * **Note**: If you're using a data URL API (e.g., readAsDataURL), you need to strip out the data URL prefix then send the rest of the string to this API. + * For example, if the full string is represented by `data:image/svg+xml;base64,`, remove `data:image/svg+xml;base64,`. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadWriteItem + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * + * **Errors**: + * + * - AttachmentSizeExceeded: The attachment is larger than allowed. + * + * - FileTypeNotSupported: The attachment has an extension that is not allowed. + * + * - NumberOfAttachmentsExceeded: The message or appointment has too many attachments. + * + * @param base64File - The base64 encoded content of an image or file to be added to an email or event. + * @param attachmentName - The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters. + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type Office.AsyncResult. + * On success, the attachment identifier will be provided in the asyncResult.value property. + * If uploading the attachment fails, the asyncResult object will contain an Error object that provides a description of the error. + */ + addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Adds an event handler for a supported event. **Note**: Events are available only with task pane. * - * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and - * `Office.EventType.RecurrenceChanged`. + * To see which event types are supported, see `Office.EventType` for details. * * [Api set: Mailbox 1.7] * @@ -12855,8 +14319,7 @@ declare namespace Office { /** * Adds an event handler for a supported event. **Note**: Events are available only with task pane. * - * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and - * `Office.EventType.RecurrenceChanged`. + * To see which event types are supported, see `Office.EventType` for details. * * [Api set: Mailbox 1.7] * @@ -12961,6 +14424,40 @@ declare namespace Office { * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose */ close(): void; + /** + * Gets the item's attachments as an array. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * + * @param options - Optional. 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 method. + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of + * type Office.AsyncResult. If the call fails, the asyncResult.error property will contain and error code with the reason for + * the failure. + */ + getAttachmentsAsync(options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; + /** + * Gets the item's attachments as an array. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of + * type Office.AsyncResult. If the call fails, the asyncResult.error property will contain and error code with the reason for + * the failure. + */ + getAttachmentsAsync(callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Asynchronously returns selected data from the subject or body of a message. * @@ -13015,6 +14512,56 @@ declare namespace Office { * type Office.AsyncResult. */ getSelectedDataAsync(coercionType: Office.CoercionType | string, callback: (asyncResult: Office.AsyncResult) => void): void; + /** + * Asynchronously gets the ID of a saved item. + * + * When invoked, this method returns the item ID via the callback method. + * + * **Note**: If your add-in calls `getItemIdAsync` on an item in compose mode (e.g., to get an `itemId` to use with EWS or the REST API), + * be aware that when Outlook is in cached mode, it may take some time before the item is synced to the server. + * Until the item is synced, the `itemId` is not recognized and using it returns an error. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * + * **Errors**: + * + * - `ItemNotSaved`: The id can't be retrieved until the item is saved. + * + * @param options - 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 method. + * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of type Office.AsyncResult. + */ + getItemIdAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void): void; + /** + * Asynchronously gets the ID of a saved item. + * + * When invoked, this method returns the item ID via the callback method. + * + * **Note**: If your add-in calls `getItemIdAsync` on an item in compose mode (e.g., to get an `itemId` to use with EWS or the REST API), + * be aware that when Outlook is in cached mode, it may take some time before the item is synced to the server. + * Until the item is synced, the `itemId` is not recognized and using it returns an error. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Compose + * + * **Errors**: + * + * - `ItemNotSaved`: The id can't be retrieved until the item is saved. + * + * @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of type Office.AsyncResult. + */ + getItemIdAsync(callback: (asyncResult: Office.AsyncResult) => void): void; /** * Asynchronously loads custom properties for this add-in on the selected item. * @@ -13099,8 +14646,7 @@ declare namespace Office { /** * Removes the event handlers for a supported event type. **Note**: Events are available only with task pane. * - * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and - * `Office.EventType.RecurrenceChanged`. + * To see which event types are supported, see `Office.EventType` for details. * * [Api set: Mailbox 1.7] * @@ -13120,8 +14666,7 @@ declare namespace Office { /** * Removes the event handlers for a supported event type. **Note**: Events are available only with task pane. * - * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and - * `Office.EventType.RecurrenceChanged`. + * To see which event types are supported, see `Office.EventType` for details. * * [Api set: Mailbox 1.7] * @@ -13278,7 +14823,7 @@ declare namespace Office { * * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces. * You should treat this as a mode of Office.context.mailbox.item. Refer to the - * {@link https://docs.microsoft.com/office/dev/add-ins/reference/objectmodel/requirement-set-1.7/office.context.mailbox.item | Object Model} page for more information. + * {@link https://docs.microsoft.com/office/dev/add-ins/reference/objectmodel/requirement-set-1.8/office.context.mailbox.item | Object Model} page for more information. */ interface MessageRead extends Message, ItemRead { /** @@ -13310,6 +14855,18 @@ declare namespace Office { * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read */ body: Body; + /** + * Gets an object that provides methods for managing the item's categories. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + */ + categories: Categories; /** * Provides access to the Cc (carbon copy) recipients of a message. The type of object and level of access depends on the mode of the * current item. @@ -13601,8 +15158,7 @@ declare namespace Office { /** * Adds an event handler for a supported event. **Note**: Events are available only with task pane. * - * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and - * `Office.EventType.RecurrenceChanged`. + * To see which event types are supported, see `Office.EventType` for details. * * [Api set: Mailbox 1.7] * @@ -13624,8 +15180,7 @@ declare namespace Office { /** * Adds an event handler for a supported event. **Note**: Events are available only with task pane. * - * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and - * `Office.EventType.RecurrenceChanged`. + * To see which event types are supported, see `Office.EventType` for details. * * [Api set: Mailbox 1.7] * @@ -13665,7 +15220,7 @@ declare namespace Office { * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read * * @param formData - A string that contains text and HTML and that represents the body of the reply form. The string is limited to 32 KB - * OR an {@link Office.ReplyFormData} object that contains body or attachment data and a callback function. + * OR a {@link Office.ReplyFormData | ReplyFormData} object that contains body or attachment data and a callback function. * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, * asyncResult, which is an Office.AsyncResult object. */ @@ -13692,11 +15247,49 @@ declare namespace Office { * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read * * @param formData - A string that contains text and HTML and that represents the body of the reply form. The string is limited to 32 KB - * OR an {@link Office.ReplyFormData} object that contains body or attachment data and a callback function. + * OR a {@link Office.ReplyFormData | ReplyFormData} object that contains body or attachment data and a callback function. * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, * asyncResult, which is an Office.AsyncResult object. */ displayReplyForm(formData: string | ReplyFormData, callback?: (asyncResult: Office.AsyncResult) => void): void; + /** + * Gets all the internet headers for the message as a string. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * + * @param options - Optional. 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 method. + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, + * asyncResult, which is an Office.AsyncResult object. + * On success, the internet headers data is provided in the asyncResult.value property as a string. + * Refer to {@link https://tools.ietf.org/html/rfc2183 | RFC 2183} for the formatting information of the returned string value. + * If the call fails, the asyncResult.error property will contain an error code with the reason for the failure. + */ + getAllInternetHeadersAsync(options?: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; + /** + * Gets all the internet headers for the message as a string. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Message Read + * + * @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, + * asyncResult, which is an Office.AsyncResult object. + * On success, the internet headers data is provided in the asyncResult.value property as a string. + * Refer to {@link https://tools.ietf.org/html/rfc2183 | RFC 2183} for the formatting information of the returned string value. + * If the call fails, the asyncResult.error property will contain an error code with the reason for the failure. + */ + getAllInternetHeadersAsync(callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Gets the entities found in the selected item's body. * @@ -13930,8 +15523,7 @@ declare namespace Office { /** * Removes the event handlers for a supported event type. **Note**: Events are available only with task pane. * - * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and - * `Office.EventType.RecurrenceChanged`. + * To see which event types are supported, see `Office.EventType` for details. * * [Api set: Mailbox 1.7] * @@ -13951,8 +15543,7 @@ declare namespace Office { /** * Removes the event handlers for a supported event type. **Note**: Events are available only with task pane. * - * Currently the supported event types are `Office.EventType.AppointmentTimeChanged`, `Office.EventType.RecipientsChanged`, and - * `Office.EventType.RecurrenceChanged`. + * To see which event types are supported, see `Office.EventType` for details. * * [Api set: Mailbox 1.7] * @@ -14190,7 +15781,7 @@ declare namespace Office { */ interface Organizer { /** - * Gets the organizer value of an appointment as an {@link Office.EmailAddressDetails} in the asyncResult.value property. + * Gets the organizer value of an appointment as an {@link Office.EmailAddressDetails | EmailAddressDetails} object in the asyncResult.value property. * * [Api set: Mailbox 1.7] * @@ -14207,7 +15798,7 @@ declare namespace Office { */ getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void): void; /** - * Gets the organizer value of an appointment as an {@link Office.EmailAddressDetails} in the asyncResult.value property. + * Gets the organizer value of an appointment as an {@link Office.EmailAddressDetails | EmailAddressDetails} object in the asyncResult.value property. * * [Api set: Mailbox 1.7] * @@ -14297,9 +15888,9 @@ declare namespace Office { * * - Strings containing SMTP email addresses * - * - {@link Office.EmailUser} objects + * - {@link Office.EmailUser | EmailUser} objects * - * - {@link Office.EmailAddressDetails} objects + * - {@link Office.EmailAddressDetails | EmailAddressDetails} objects * * [Api set: Mailbox 1.1] * @@ -14321,7 +15912,7 @@ declare namespace Office { /** * Gets a recipient list for an appointment or message. * - * When the call completes, the asyncResult.value property will contain an array of {@link Office.EmailAddressDetails} objects. + * When the call completes, the asyncResult.value property will contain an array of {@link Office.EmailAddressDetails | EmailAddressDetails} objects. * * [Api set: Mailbox 1.1] * @@ -14341,7 +15932,7 @@ declare namespace Office { /** * Gets a recipient list for an appointment or message. * - * When the call completes, the asyncResult.value property will contain an array of {@link Office.EmailAddressDetails} objects. + * When the call completes, the asyncResult.value property will contain an array of {@link Office.EmailAddressDetails | EmailAddressDetails} objects. * * [Api set: Mailbox 1.1] * @@ -14365,9 +15956,9 @@ declare namespace Office { * * - Strings containing SMTP email addresses * - * - {@link Office.EmailUser} objects + * - {@link Office.EmailUser | EmailUser} objects * - * - {@link Office.EmailAddressDetails} objects + * - {@link Office.EmailAddressDetails | EmailAddressDetails} objects * * [Api set: Mailbox 1.1] * @@ -14399,9 +15990,9 @@ declare namespace Office { * * - Strings containing SMTP email addresses * - * - {@link Office.EmailUser} objects + * - {@link Office.EmailUser | EmailUser} objects * - * - {@link Office.EmailAddressDetails} objects + * - {@link Office.EmailAddressDetails | EmailAddressDetails} objects * * [Api set: Mailbox 1.1] * @@ -14558,7 +16149,7 @@ declare namespace Office { */ recurrenceType: MailboxEnums.RecurrenceType | string; /** - * The {@link Office.SeriesTime} object enables you to manage the start and end dates of the recurring appointment series and the usual start + * The {@link Office.SeriesTime | SeriesTime} object enables you to manage the start and end dates of the recurring appointment series and the usual start * and end times of instances. **This object is not in UTC time.** * Instead, it is set in the time zone specified by the recurrenceTimeZone value or defaulted to the item's time zone. * @@ -14775,7 +16366,7 @@ declare namespace Office { */ htmlBody?: string; /** - * An array of {@link Office.ReplyFormAttachment} that are either file or item attachments. + * An array of {@link Office.ReplyFormAttachment | ReplyFormAttachment} that are either file or item attachments. */ attachments?: ReplyFormAttachment[]; /** @@ -15064,6 +16655,40 @@ declare namespace Office { */ setStartTime(time: string): void; } + /** + * Represents the properties of an appointment or message in a shared folder, mailbox, or calendar. + * + * [Api set: Mailbox 1.8] + * + * @remarks + * + * **{@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}**: ReadItem + * + * **{@link https://docs.microsoft.com/outlook/add-ins/#extension-points | Applicable Outlook mode}**: Compose or Read + */ + interface SharedProperties { + /** + * The email address of the owner of a shared item. + */ + owner: string; + /** + * The REST API's base URL (currently https://outlook.office.com/api). + * Use with targetMailbox to construct REST operation's URL. + * + * Example usage: `targetRestUrl + "/{api_version}/users/" + targetMailbox + "/{REST_operation}"` + */ + targetRestUrl: string; + /** + * The target/owner's mailbox. Use with targetRestUrl to construct REST operation's URL. + * + * Example usage: `targetRestUrl + "/{api_version}/users/" + targetMailbox + "/{REST_operation}"` + */ + targetMailbox: string; + /** + * The permissions that the delegate has on a shared folder. + */ + delegatePermissions: MailboxEnums.DelegatePermissions; + } /** * Provides methods to get and set the subject of an appointment or message in an Outlook add-in. *