outlook package
Office. |
The subclass of 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 Child interfaces: |
Office. |
The appointment organizer mode of Office.context.mailbox.item. Important: This is an internal Outlook object, not directly exposed through existing interfaces. You should treat this as a mode of Parent interfaces: |
Office. |
The |
Office. |
The appointment attendee mode of Office.context.mailbox.item. Important: This is an internal Outlook object, not directly exposed through existing interfaces. You should treat this as a mode of Parent interfaces: |
Office. |
Provides the current dates and times of the appointment that raised the |
Office. |
Represents the content of an attachment on a message or appointment item. |
Office. |
Represents an attachment on an item from the server. Read mode only. An array of |
Office. |
Represents an attachment on an item. Compose mode only. An array of |
Office. |
Provides information about the attachment on a mail item that raised the |
Office. |
The body object provides methods for adding and updating the content of the message or appointment. It is returned in the body property of the selected item. |
Office. |
Represents the categories on an item. In Outlook, a user can tag 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. Important: In Outlook on the web and new Outlook on Windows, you can't use the API to manage categories applied to a message in Compose mode. |
Office. |
Represents a category's details like name and associated color. |
Office. |
Provides an option for the data format. |
Office. |
Represents the details about a contact (similar to what's on a physical contact or business card) extracted from the item's body. Read mode only. The list of contacts extracted from the body of an email message or appointment is returned in the Warning: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported. We recommend updating your contextual add-in to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see Contextual Outlook add-ins. |
Office. |
The To learn more about |
Office. |
The |
Office. |
Provides diagnostic information to an Outlook add-in. |
Office. |
Provides properties to temporarily set the content displayed in the body or subject of a message in read mode. |
Office. |
Provides a method to temporarily set the content displayed in the body of a message in read mode. |
Office. |
Provides a method to temporarily set the content displayed in the subject of a message in read mode. |
Office. |
Provides the email properties of the sender or specified recipients of an email message or appointment. |
Office. |
Represents an email account on an Exchange Server. |
Office. |
Represents the set of locations on an appointment. |
Office. |
Provides the current enhanced locations when the |
Office. |
Represents a collection of entities found in an email message or appointment. Read mode only. The If no entities of the type specified in the property are present in the item, the property associated with that entity is null. For example, if a message contains a street address and a phone number, the addresses property and phoneNumbers property would contain information, and the other properties would be null. To be recognized as an address, the string must contain a United States postal address that has at least a subset of the elements of a street number, street name, city, state, and zip code. To be recognized as a phone number, the string must contain a North American phone number format. Entity recognition relies on natural language recognition that is based on machine learning of large amounts of data. The recognition of an entity is non-deterministic and success sometimes relies on the particular context in the item. When the property arrays are returned by the Warning: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported. We recommend updating your contextual add-in to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see Contextual Outlook add-ins. |
Office. |
Provides a method to get the from value of a message in an Outlook add-in. |
Office. |
Provides basic details about the notification message that raised the |
Office. |
Provides additional details about the notification message that raised the |
Office. |
The Internet headers are stored as string 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. To learn more, see Get and set internet headers on a message in an Outlook add-in. |
Office. |
Provides methods to get and set the all-day event status of a meeting in an Outlook add-in. |
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 To see the full member list, refer to the Object Model page. If you want to see IntelliSense for only a specific type or mode, cast this item to one of the following: |
Office. |
The compose mode of Office.context.mailbox.item. Important: This is an internal Outlook object, not directly exposed through existing interfaces. You should treat this as a mode of Child interfaces: |
Office. |
The read mode of Office.context.mailbox.item. Important: This is an internal Outlook object, not directly exposed through existing interfaces. You should treat this as a mode of Child interfaces: |
Office. |
Represents a message in compose mode that's currently loaded. A |
Office. |
Represents a message in read mode that's currently loaded. A |
Office. |
Represents a date and time in the local client's time zone. Read mode only. |
Office. |
Provides methods to get and set the location of a meeting in an Outlook add-in. |
Office. |
Represents a location. Read-only. |
Office. |
Represents the ID of a location. |
Office. |
Provides access to the Microsoft Outlook add-in object model. Key properties:
|
Office. |
The |
Office. |
Represents the categories master list on the mailbox. In Outlook, a user can tag 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. Important: In delegate or shared scenarios, the delegate can get the categories in the master list but can't add or remove categories. |
Office. |
Represents a suggested meeting found in an item. Read mode only. The list of meetings suggested in an email message is returned in the The start and end values are string representations of a Warning: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported. We recommend updating your contextual add-in to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see Contextual Outlook add-ins. |
Office. |
A subclass of Item for messages. Important: This is an internal Outlook object, not directly exposed through existing interfaces. You should treat this as a mode of Child interfaces: |
Office. |
The message compose mode of Office.context.mailbox.item. Important:
Parent interfaces: |
Office. |
The message read mode of Office.context.mailbox.item. Important:
Parent interfaces: |
Office. |
The definition of the action for a notification message. |
Office. |
An array of |
Office. |
The |
Office. |
Provides the updated Office theme that raised the |
Office. |
Represents the appointment organizer, even if an alias or a delegate was used to create the appointment. This object provides a method to get the organizer value of an appointment in an Outlook add-in. |
Office. |
Represents a phone number identified in an item. Read mode only. An array of Warning: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported. We recommend updating your contextual add-in to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see Contextual Outlook add-ins. |
Office. |
Represents recipients of an item. Compose mode only. |
Office. |
Provides change status of recipients fields when the |
Office. |
Represents |
Office. |
The |
Office. |
Provides updated recurrence object that raised the |
Office. |
Represents the properties of the recurrence. |
Office. |
Represents the time zone of the recurrence. |
Office. |
A file or item attachment. Used when displaying a reply form. |
Office. |
A ReplyFormData object that contains body or attachment data and a callback function. Used when displaying a reply form. |
Office. |
The settings created by using the methods of the While the Outlook add-in API limits access to these settings to only the add-in that created them, these settings shouldn't be considered secure storage. They can be accessed by Exchange Web Services or Extended MAPI. They shouldn't be used to store sensitive information, such as user credentials or security tokens. The name of a setting is a String, while the value can be a String, Number, Boolean, null, Object, or Array. The To learn more about |
Office. |
Represents the properties of a message that's currently selected in Outlook. |
Office. |
Provides methods to get and set the sensitivity level of an appointment. To learn more about sensitivity levels, see Mark your email as Normal, Personal, Private, or Confidential. |
Office. |
Provides methods to get or set the sensitivity label of a message or appointment. For more information on sensitivity labels, see Learn about sensitivity labels. |
Office. |
Provides the change status of the sensitivity label applied to a message or appointment in compose mode. This information is provided when the |
Office. |
Represents the properties of available sensitivity labels in Outlook. |
Office. |
Provides methods to check the status of the catalog of sensitivity labels in Outlook and retrieve all available sensitivity labels if the catalog is enabled. |
Office. |
The |
Office. |
Provides methods to manage an item's session data. Important: The entire SessionData object is limited to 50,000 characters per add-in. |
Office. |
Represents the properties of an appointment or message in a shared folder or shared mailbox. For more information on how this object is used, see Enable shared folders and shared mailbox scenarios in an Outlook add-in. |
Office. |
Specifies the behavior of a Smart Alerts add-in when it completes processing an |
Office. |
Provides information about the |
Office. |
Specifies the behavior of an integrated spam-reporting add-in after it completes processing a SpamReporting event. |
Office. |
Provides methods to get and set the subject of an appointment or message in an Outlook add-in. |
Office. |
Represents a suggested task identified in an item. Read mode only. The list of tasks suggested in an email message is returned in the Warning: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported. We recommend updating your contextual add-in to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see Contextual Outlook add-ins. |
Office. |
The |
Office. |
Information about the user associated with the mailbox. This includes their account type, display name, email address, and time zone. |
Office. |
Specifies the type of custom action in a notification message. |
Office. |
Specifies the sensitivity level of an appointment. |
Office. |
Specifies the formatting that applies to an attachment's content. |
Office. |
Specifies whether an attachment was added to or removed from an item. |
Office. |
Specifies the attachment's type. |
Office. |
Specifies the category color. |
Office. |
Specifies a message's compose type. |
Office. |
Specifies the day of week or type of day. |
Office. |
This bitmask represents a delegate's permissions on a shared folder, or a user's permissions on a shared mailbox. |
Office. |
Specifies an entity's type. Warning: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported. We recommend updating your contextual add-in to use regular expression rules as an alternative solution. For guidance on how to implement these rules, see Contextual Outlook add-ins. |
Office. |
Action types supported by Office.EventType.InfobarClicked. |
Office. |
Type of notification allowed by Office.EventType.InfobarClicked. |
Office. |
Specifies the notification message type for an appointment or message. |
Office. |
Specifies an item's type. |
Office. |
Specifies an appointment location's type. |
Office. |
Specifies the month. |
Office. |
Specifies the folder to which a reported spam or phishing message is moved once it's processed by a spam-reporting add-in. To learn more about the integrated spam-reporting feature, see Implement an integrated spam-reporting add-in. |
Office. |
Specifies the location from which an add-in wants to access data. |
Office. |
Represents the current view of Outlook on the web. |
Office. |
Specifies the type of recipient of a message or appointment. |
Office. |
Specifies the time zone applied to the recurrence. |
Office. |
Specifies the type of recurrence. |
Office. |
Specifies the type of response to a meeting invitation. |
Office. |
Specifies the version of the REST API that corresponds to a REST-formatted item ID. |
Office. |
Specifies the location in which an add-in wants to save data. |
Office. |
Specifies the send mode option that overrides the option set in the manifest at runtime. For information on how to implement a Smart Alerts add-in, see Handle OnMessageSend and OnAppointmentSend events in your Outlook add-in with Smart Alerts. |
Office. |
Specifies the source of the selected data in an item (see |
Office. |
Specifies the week of the month. |
Office Add-ins feedback
Office Add-ins is an open source project. Select a link to provide feedback: