-
Notifications
You must be signed in to change notification settings - Fork 63
/
office.selecteditemdetails.yml
214 lines (172 loc) · 7.6 KB
/
office.selecteditemdetails.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
### YamlMime:TSType
name: Office.SelectedItemDetails
uid: 'outlook!Office.SelectedItemDetails:interface'
package: outlook!
fullName: Office.SelectedItemDetails
summary: Represents the properties of a message that's currently selected in Outlook.
remarks: >-
\[ [API set: Mailbox 1.13](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) \]
**[Minimum permission
level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)<!-- -->**:
**read/write mailbox**
**[Applicable Outlook
mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!-- -->**:
Message Compose, Message Read
#### Examples
```TypeScript
// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-message-properties.yaml
// Retrieves the selected messages' properties and logs them to the console.
Office.context.mailbox.getSelectedItemsAsync((asyncResult) => {
if (asyncResult.status === Office.AsyncResultStatus.Failed) {
console.log(asyncResult.error.message);
return;
}
asyncResult.value.forEach((message) => {
console.log(`Item ID: ${message.itemId}`);
console.log(`Conversation ID: ${message.conversationId}`);
console.log(`Internet message ID: ${message.internetMessageId}`);
console.log(`Subject: ${message.subject}`);
console.log(`Item type: ${message.itemType}`);
console.log(`Item mode: ${message.itemMode}`);
console.log(`Has attachment: ${message.hasAttachment}`);
});
});
```
isPreview: false
isDeprecated: false
type: interface
properties:
- name: conversationId
uid: 'outlook!Office.SelectedItemDetails#conversationId:member'
package: outlook!
fullName: conversationId
summary: The identifier of the message conversation that contains the message that's currently selected.
remarks: >-
\[ [API set: Mailbox 1.14](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) \]
**[Minimum permission
level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)<!--
-->**: **read/write mailbox**
**[Applicable Outlook
mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!--
-->**: Message Compose, Message Read
isPreview: false
isDeprecated: false
syntax:
content: 'conversationId: string;'
return:
type: string
- name: hasAttachment
uid: 'outlook!Office.SelectedItemDetails#hasAttachment:member'
package: outlook!
fullName: hasAttachment
summary: Returns `true` if the message that's currently selected contains an attachment.
remarks: >-
\[ [API set: Mailbox 1.14](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) \]
**[Minimum permission
level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)<!--
-->**: **read/write mailbox**
**[Applicable Outlook
mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!--
-->**: Message Compose, Message Read
isPreview: false
isDeprecated: false
syntax:
content: 'hasAttachment: boolean;'
return:
type: boolean
- name: internetMessageId
uid: 'outlook!Office.SelectedItemDetails#internetMessageId:member'
package: outlook!
fullName: internetMessageId
summary: The internet message identifier of the message that's currently selected.
remarks: >-
\[ [API set: Mailbox 1.14](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) \]
**[Minimum permission
level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)<!--
-->**: **read/write mailbox**
**[Applicable Outlook
mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!--
-->**: Message Compose, Message Read
isPreview: false
isDeprecated: false
syntax:
content: 'internetMessageId: string;'
return:
type: string
- name: itemId
uid: 'outlook!Office.SelectedItemDetails#itemId:member'
package: outlook!
fullName: itemId
summary: The Exchange Web Services (EWS) item identifier of the message that's currently selected.
remarks: >-
\[ [API set: Mailbox 1.13](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) \]
**[Minimum permission
level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)<!--
-->**: **read/write mailbox**
**[Applicable Outlook
mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!--
-->**: Message Compose, Message Read
isPreview: false
isDeprecated: false
syntax:
content: 'itemId: string;'
return:
type: string
- name: itemMode
uid: 'outlook!Office.SelectedItemDetails#itemMode:member'
package: outlook!
fullName: itemMode
summary: The Outlook mode (`Read` or `Compose`<!-- -->) of the message that's currently selected.
remarks: >-
\[ [API set: Mailbox 1.13](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) \]
**[Minimum permission
level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)<!--
-->**: **read/write mailbox**
**[Applicable Outlook
mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!--
-->**: Message Compose, Message Read
isPreview: false
isDeprecated: false
syntax:
content: 'itemMode: string;'
return:
type: string
- name: itemType
uid: 'outlook!Office.SelectedItemDetails#itemType:member'
package: outlook!
fullName: itemType
summary: The type of the item that's currently selected. `Message` is the only supported type at this time.
remarks: >-
\[ [API set: Mailbox 1.13](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) \]
**[Minimum permission
level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)<!--
-->**: **read/write mailbox**
**[Applicable Outlook
mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!--
-->**: Message Compose, Message Read
isPreview: false
isDeprecated: false
syntax:
content: 'itemType: MailboxEnums.ItemType | string;'
return:
type: '<xref uid="outlook!Office.MailboxEnums.ItemType:enum" /> | string'
- name: subject
uid: 'outlook!Office.SelectedItemDetails#subject:member'
package: outlook!
fullName: subject
summary: The description that appears in the subject field of the message that's currently selected.
remarks: >-
\[ [API set: Mailbox 1.13](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) \]
**[Minimum permission
level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)<!--
-->**: **read/write mailbox**
**[Applicable Outlook
mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!--
-->**: Message Compose, Message Read
isPreview: false
isDeprecated: false
syntax:
content: 'subject: string;'
return:
type: string