Outlook add-in API requirement set 1.8
The Outlook add-in API subset of the Office JavaScript API includes objects, methods, properties, and events that you can use in an Outlook add-in.
Note
This documentation is for a requirement set other than the latest requirement set.
What's new in 1.8?
Requirement set 1.8 includes all of the features of requirement set 1.7. It added the following features.
- Added new APIs for attachments, categories, delegate access, enhanced location, internet headers, and block on send features.
- Added optional
optionsparameter to Event.completed. - Added support for
AttachmentsChangedandEnhancedLocationsChangedevents.
Change log
- Added AttachmentContent: Adds a new object that represents the content of an attachment.
- Added AttachmentDetailsCompose: Adds a new object that represents the details of an attachment in Compose mode.
- Added Categories: Adds a new object that represents an item's categories.
- Added CategoryDetails: Adds a new object that represents a category's details (its name and associated color).
- Added EnhancedLocation: Adds a new object that represents the set of locations on an appointment.
- Added InternetHeaders: Adds a new object that represents the custom internet headers of a message item. Compose mode only.
- Added LocationDetails: Adds a new object that represents a location. Read-only.
- Added LocationIdentifier: Adds a new object that represents the id of a location.
- Added MasterCategories: Adds a new object that represents the categories master list on a mailbox.
- Added SharedProperties: Adds a new object that represents the properties of an appointment or message item in a shared folder.
- Added SupportsSharedFolders manifest element: Adds a child element to the DesktopFormFactor manifest element. It defines whether the add-in is available in delegate scenarios.
- Added Office.context.mailbox.masterCategories: Adds a new property that represents the categories master list on a mailbox.
- Added Office.context.mailbox.item.categories: Adds a new property that represents the set of categories on an item.
- Added Office.context.mailbox.item.addFileAttachmentFromBase64Async: Adds a new method that allows you to attach a file represented as a base64 encoded string to a message or appointment.
- Added Office.context.mailbox.item.enhancedLocation: Adds a new property that represents the set of locations on an appointment.
- Added Office.context.mailbox.item.getAllInternetHeadersAsync: Adds a new method that gets all the internet headers for a message item. Read mode only.
- Added Office.context.mailbox.item.getAttachmentContentAsync: Adds a new method to get the content of a specific attachment.
- Added Office.context.mailbox.item.getAttachmentsAsync: Adds a new method that gets an item's attachments in compose mode.
- Added Office.context.mailbox.item.getInitializationContextAsync: Adds a new method to get initialization data when an actionable message is activated.
- Added Office.context.mailbox.item.getItemIdAsync: Adds a new method that gets the ID of a saved appointment or message item.
- Added Office.context.mailbox.item.getSharedPropertiesAsync: Adds a new method that gets an object which represents the sharedProperties of an appointment or message item.
- Added Office.context.mailbox.item.internetHeaders: Adds a new property that represents the custom internet headers on a message item. Compose mode only.
- Modified Event.completed: Adds a new optional parameter
options, which is a dictionary with one valid valueallowEvent. This value is used to cancel execution of an event. - Added Office.MailboxEnums.AttachmentContentFormat: Adds a new enum that specifies the formatting that applies to an attachment's content.
- Added Office.MailboxEnums.AttachmentStatus: Adds a new enum that specifies whether an attachment was added to or removed from an item.
- Added Office.MailboxEnums.CategoryColor: Adds a new enum that specifies the colors available to be associated with categories.
- Added Office.MailboxEnums.DelegatePermissions: Adds a new bit flag enum that specifies the delegate permissions.
- Added Office.MailboxEnums.LocationType: Adds a new enum that specifies an appointment location's type.
- Modified Office.EventType: Adds support for
AttachmentsChangedandEnhancedLocationsChangedevents.
See also
Collaborate with us on GitHub
The source for this content can be found on GitHub, where you can also create and review issues and pull requests. For more information, see our contributor guide.
Office Add-ins
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for