/
office.mailboxenums.entitytype.yml
92 lines (72 loc) · 3.69 KB
/
office.mailboxenums.entitytype.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
### YamlMime:TSEnum
name: Office.MailboxEnums.EntityType
uid: 'outlook!Office.MailboxEnums.EntityType:enum'
package: outlook!
fullName: Office.MailboxEnums.EntityType
summary: Specifies an entity's type.
remarks: >-
**[Applicable Outlook
mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!-- -->**:
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](https://learn.microsoft.com/office/dev/add-ins/outlook/use-regular-expressions-to-show-an-outlook-add-in)<!--
-->.
For more information, see [Retirement of entity-based contextual Outlook
add-ins](https://devblogs.microsoft.com/microsoft365dev/retirement-of-entity-based-contextual-outlook-add-ins)<!--
-->.
#### Examples
```TypeScript
// 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));
```
isPreview: false
isDeprecated: false
fields:
- name: MeetingSuggestion
uid: 'outlook!Office.MailboxEnums.EntityType.MeetingSuggestion:member'
package: outlook!
summary: Specifies that the entity is a meeting suggestion.
value: '"meetingSuggestion"'
- name: TaskSuggestion
uid: 'outlook!Office.MailboxEnums.EntityType.TaskSuggestion:member'
package: outlook!
summary: Specifies that the entity is a task suggestion.
value: '"taskSuggestion"'
- name: Address
uid: 'outlook!Office.MailboxEnums.EntityType.Address:member'
package: outlook!
summary: Specifies that the entity is a postal address.
value: '"address"'
- name: EmailAddress
uid: 'outlook!Office.MailboxEnums.EntityType.EmailAddress:member'
package: outlook!
summary: Specifies that the entity is an SMTP email address.
value: '"emailAddress"'
- name: Url
uid: 'outlook!Office.MailboxEnums.EntityType.Url:member'
package: outlook!
summary: Specifies that the entity is an Internet URL.
value: '"url"'
- name: PhoneNumber
uid: 'outlook!Office.MailboxEnums.EntityType.PhoneNumber:member'
package: outlook!
summary: Specifies that the entity is a US phone number.
value: '"phoneNumber"'
- name: Contact
uid: 'outlook!Office.MailboxEnums.EntityType.Contact:member'
package: outlook!
summary: Specifies that the entity is a contact.
value: '"contact"'