Edit

Office.MailboxEnums.EntityType enum

  • Reference
Package:
outlook

Specifies an entity's type.

Remarks

Applicable Outlook mode: Compose or Read

Important: Entity-based contextual Outlook add-ins will be retired in Q2 of 2024. The work to retire this feature will start in May and continue until the end of June. After June, contextual add-ins will no longer be able to detect entities in mail items to perform tasks on them. The following APIs will also be retired.

  • Office.context.mailbox.item.getEntities - Office.context.mailbox.item.getEntitiesByType - Office.context.mailbox.item.getFilteredEntitiesByName - Office.context.mailbox.item.getSelectedEntities

To help minimize potential disruptions, the following will still be supported after entity-based contextual add-ins are retired.

  • An alternative implementation of the Join Meeting button, which is activated by online meeting add-ins, is being developed. Once support for entity-based contextual add-ins ends, online meeting add-ins will automatically transition to the alternative implementation to activate the Join Meeting button.

  • Regular expression rules will continue to be supported after entity-based contextual add-ins are retired. 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 Use regular expression activation rules to show an Outlook add-in.

For more information, see Retirement of entity-based contextual Outlook add-ins.

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/75-entities-and-regex-matches/basic-entities.yaml

console.log(Office.context.mailbox.item.getEntitiesByType(Office.MailboxEnums.EntityType.Address));

Fields

MeetingSuggestion = "meetingSuggestion"

Specifies that the entity is a meeting suggestion.
TaskSuggestion = "taskSuggestion"

Specifies that the entity is a task suggestion.
Address = "address"

Specifies that the entity is a postal address.
EmailAddress = "emailAddress"

Specifies that the entity is an SMTP email address.
Url = "url"

Specifies that the entity is an Internet URL.
PhoneNumber = "phoneNumber"

Specifies that the entity is a US phone number.
Contact = "contact"

Specifies that the entity is a contact.