-
Notifications
You must be signed in to change notification settings - Fork 65
/
office.entities.yml
272 lines (221 loc) · 11 KB
/
office.entities.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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
### YamlMime:TSType
name: Office.Entities
uid: 'outlook!Office.Entities:interface'
package: outlook!
fullName: Office.Entities
summary: >-
Represents a collection of entities found in an email message or appointment. Read mode only.
The `Entities` object is a container for the entity arrays returned by the `getEntities` and `getEntitiesByType`
methods when the item (either an email message or an appointment) contains one or more entities that have been found
by the server. You can use these entities in your code to provide additional context information to the viewer, such
as a map to an address found in the item, or to open a dialer for a phone number found in the item.
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 `getEntitiesByType` method, only the property for the specified entity
contains data; all other properties are null.
**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](https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins)<!-- -->.
remarks: >-
**[Minimum permission
level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)<!-- -->**:
**read item**
**[Applicable Outlook
mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!-- -->**:
Read
isPreview: false
isDeprecated: true
customDeprecatedMessage: >-
Use [regular expression rules](https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins)
instead.
type: interface
properties:
- name: addresses
uid: 'outlook!Office.Entities#addresses:member'
package: outlook!
fullName: addresses
summary: >-
Gets the physical addresses (street or mailing addresses) found in an email message or appointment.
**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](https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins)<!-- -->.
remarks: ''
isPreview: false
isDeprecated: true
customDeprecatedMessage: >-
Use [regular expression rules](https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins)
instead.
syntax:
content: 'addresses: string[];'
return:
type: 'string[]'
description: |-
#### Examples
```TypeScript
const item = Office.context.mailbox.item;
const addresses = item.getEntitiesByType(Office.MailboxEnums.EntityType.Address);
```
- name: contacts
uid: 'outlook!Office.Entities#contacts:member'
package: outlook!
fullName: contacts
summary: >-
Gets the contacts found in an email address or appointment.
**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](https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins)<!-- -->.
remarks: ''
isPreview: false
isDeprecated: true
customDeprecatedMessage: >-
Use [regular expression rules](https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins)
instead.
syntax:
content: 'contacts: Contact[];'
return:
type: '<xref uid="outlook!Office.Contact:interface" />[]'
description: |-
#### Examples
```TypeScript
const item = Office.context.mailbox.item;
const contacts = item.getEntitiesByType(Office.MailboxEnums.EntityType.Contact);
```
- name: emailAddresses
uid: 'outlook!Office.Entities#emailAddresses:member'
package: outlook!
fullName: emailAddresses
summary: >-
Gets the email addresses found in an email message or appointment.
**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](https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins)<!-- -->.
remarks: ''
isPreview: false
isDeprecated: true
customDeprecatedMessage: >-
Use [regular expression rules](https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins)
instead.
syntax:
content: 'emailAddresses: string[];'
return:
type: 'string[]'
description: |-
#### Examples
```TypeScript
const item = Office.context.mailbox.item;
const emailAddresses = item.getEntitiesByType(Office.MailboxEnums.EntityType.EmailAddress);
```
- name: meetingSuggestions
uid: 'outlook!Office.Entities#meetingSuggestions:member'
package: outlook!
fullName: meetingSuggestions
summary: >-
Gets the meeting suggestions found in an email message.
**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](https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins)<!-- -->.
remarks: ''
isPreview: false
isDeprecated: true
customDeprecatedMessage: >-
Use [regular expression rules](https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins)
instead.
syntax:
content: 'meetingSuggestions: MeetingSuggestion[];'
return:
type: '<xref uid="outlook!Office.MeetingSuggestion:interface" />[]'
description: |-
#### Examples
```TypeScript
const item = Office.context.mailbox.item;
const meetingSuggestions = item.getEntitiesByType(Office.MailboxEnums.EntityType.MeetingSuggestion);
```
- name: phoneNumbers
uid: 'outlook!Office.Entities#phoneNumbers:member'
package: outlook!
fullName: phoneNumbers
summary: >-
Gets the phone numbers found in an email message or appointment.
**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](https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins)<!-- -->.
remarks: ''
isPreview: false
isDeprecated: true
customDeprecatedMessage: >-
Use [regular expression rules](https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins)
instead.
syntax:
content: 'phoneNumbers: PhoneNumber[];'
return:
type: '<xref uid="outlook!Office.PhoneNumber:interface" />[]'
description: |-
#### Examples
```TypeScript
const item = Office.context.mailbox.item;
const phoneNumbers = item.getEntitiesByType(Office.MailboxEnums.EntityType.PhoneNumber);
```
- name: taskSuggestions
uid: 'outlook!Office.Entities#taskSuggestions:member'
package: outlook!
fullName: taskSuggestions
summary: >-
Gets the task suggestions found in an email message or appointment.
**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](https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins)<!-- -->.
remarks: ''
isPreview: false
isDeprecated: true
customDeprecatedMessage: >-
Use [regular expression rules](https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins)
instead.
syntax:
content: 'taskSuggestions: string[];'
return:
type: 'string[]'
description: |-
#### Examples
```TypeScript
const item = Office.context.mailbox.item;
const taskSuggestions = item.getEntitiesByType(Office.MailboxEnums.EntityType.TaskSuggestion);
```
- name: urls
uid: 'outlook!Office.Entities#urls:member'
package: outlook!
fullName: urls
summary: >-
Gets the Internet URLs present in an email message or appointment.
**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](https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins)<!-- -->.
remarks: ''
isPreview: false
isDeprecated: true
customDeprecatedMessage: >-
Use [regular expression rules](https://learn.microsoft.com/office/dev/add-ins/outlook/contextual-outlook-add-ins)
instead.
syntax:
content: 'urls: string[];'
return:
type: 'string[]'
description: |-
#### Examples
```TypeScript
const item = Office.context.mailbox.item;
const urls = item.getEntitiesByType(Office.MailboxEnums.EntityType.Url);
```