-
Notifications
You must be signed in to change notification settings - Fork 66
/
office.appointmentread.yml
2917 lines (2111 loc) · 109 KB
/
office.appointmentread.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
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
### YamlMime:TSType
name: Office.AppointmentRead
uid: 'outlook!Office.AppointmentRead:interface'
package: outlook!
fullName: Office.AppointmentRead
summary: >-
The appointment attendee mode of [Office.context.mailbox.item](xref:outlook!Office.Item:interface)<!-- -->.
**Important**: This is an internal Outlook object, not directly exposed through existing interfaces. You should
treat this as a mode of `Office.context.mailbox.item`<!-- -->. For more information, refer to the [Object
Model](https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.15/office.context.mailbox.item)
page.
Parent interfaces:
- [ItemRead](xref:outlook!Office.ItemRead:interface)
- [Appointment](xref:outlook!Office.Appointment:interface)
remarks: ''
isPreview: false
isDeprecated: false
type: interface
properties:
- name: attachments
uid: 'outlook!Office.AppointmentRead#attachments:member'
package: outlook!
fullName: attachments
summary: Gets the item's attachments as an array.
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)<!--
-->**: Appointment Attendee
**Note**: Certain types of files are blocked by Outlook due to potential security issues and are therefore not
returned. For more information, see [Blocked attachments in
Outlook](https://support.microsoft.com/office/434752e1-02d3-4e90-9124-8b81e49a8519)<!-- -->.
#### Examples
```TypeScript
// The following code builds an HTML string with details of all attachments on the current item.
const item = Office.context.mailbox.item;
let outputString = "";
if (item.attachments.length > 0) {
for (let i = 0 ; i < item.attachments.length ; i++) {
const attachment = item.attachments[i];
outputString += "<BR>" + i + ". Name: ";
outputString += attachment.name;
outputString += "<BR>ID: " + attachment.id;
outputString += "<BR>contentType: " + attachment.contentType;
outputString += "<BR>size: " + attachment.size;
outputString += "<BR>attachmentType: " + attachment.attachmentType;
outputString += "<BR>isInline: " + attachment.isInline;
}
}
console.log(outputString);
```
```TypeScript
// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/40-attachments/get-attachments-read.yaml
const attachments = Office.context.mailbox.item.attachments;
console.log(attachments);
```
isPreview: false
isDeprecated: false
syntax:
content: 'attachments: AttachmentDetails[];'
return:
type: '<xref uid="outlook!Office.AttachmentDetails:interface" />[]'
- name: body
uid: 'outlook!Office.AppointmentRead#body:member'
package: outlook!
fullName: body
summary: Gets an object that provides methods for manipulating the body of an item.
remarks: >-
\[ [API set: Mailbox 1.1](/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 item**
**[Applicable Outlook
mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!--
-->**: Appointment Attendee
#### Examples
```TypeScript
// This example gets the body of the item as plain text.
Office.context.mailbox.item.body.getAsync(
Office.CoercionType.Text,
{ asyncContext: "This is passed to the callback" },
(result) => {
// Do something with the result.
}
);
// The following is an example of the result parameter passed to the callback function.
{
"value": "TEXT of whole body (including message threads that appear below the current body)",
"status": "succeeded",
"asyncContext": "This is passed to the callback"
}
```
isPreview: false
isDeprecated: false
syntax:
content: 'body: Body;'
return:
type: '<xref uid="outlook!Office.Body:interface" />'
- name: categories
uid: 'outlook!Office.AppointmentRead#categories:member'
package: outlook!
fullName: categories
summary: Gets an object that provides methods for managing the item's categories.
remarks: >-
\[ [API set: Mailbox 1.8](/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 item**
**[Applicable Outlook
mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!--
-->**: Appointment Attendee
#### Examples
```TypeScript
// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/45-categories/work-with-categories.yaml
Office.context.mailbox.item.categories.getAsync(function(asyncResult) {
if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
const categories = asyncResult.value;
if (categories && categories.length > 0) {
console.log("Categories assigned to this item:");
console.log(JSON.stringify(categories));
} else {
console.log("There are no categories assigned to this item.");
}
} else {
console.error(asyncResult.error);
}
});
...
// Note: In order for you to successfully add a category,
// it must be in the mailbox categories master list.
Office.context.mailbox.masterCategories.getAsync(function(asyncResult) {
if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
const masterCategories = asyncResult.value;
if (masterCategories && masterCategories.length > 0) {
// Grab the first category from the master list.
const categoryToAdd = [masterCategories[0].displayName];
Office.context.mailbox.item.categories.addAsync(categoryToAdd, function(asyncResult) {
if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
console.log(`Successfully assigned category '${categoryToAdd}' to item.`);
} else {
console.log("categories.addAsync call failed with error: " + asyncResult.error.message);
}
});
} else {
console.log("There are no categories in the master list on this mailbox. You can add categories using Office.context.mailbox.masterCategories.addAsync.");
}
} else {
console.error(asyncResult.error);
}
});
...
Office.context.mailbox.item.categories.getAsync(function(asyncResult) {
if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
const categories = asyncResult.value;
if (categories && categories.length > 0) {
// Grab the first category assigned to this item.
const categoryToRemove = [categories[0].displayName];
Office.context.mailbox.item.categories.removeAsync(categoryToRemove, function(asyncResult) {
if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
console.log(`Successfully unassigned category '${categoryToRemove}' from this item.`);
} else {
console.log("categories.removeAsync call failed with error: " + asyncResult.error.message);
}
});
} else {
console.log("There are no categories assigned to this item.");
}
} else {
console.error(asyncResult.error);
}
});
```
isPreview: false
isDeprecated: false
syntax:
content: 'categories: Categories;'
return:
type: '<xref uid="outlook!Office.Categories:interface" />'
- name: dateTimeCreated
uid: 'outlook!Office.AppointmentRead#dateTimeCreated:member'
package: outlook!
fullName: dateTimeCreated
summary: Gets the date and time that an item was created.
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)<!--
-->**: Appointment Attendee
#### Examples
```TypeScript
// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-date-time-created-read.yaml
console.log(`Creation date and time: ${Office.context.mailbox.item.dateTimeCreated}`);
```
isPreview: false
isDeprecated: false
syntax:
content: 'dateTimeCreated: Date;'
return:
type: Date
- name: dateTimeModified
uid: 'outlook!Office.AppointmentRead#dateTimeModified:member'
package: outlook!
fullName: dateTimeModified
summary: Gets the date and time that an item was last modified.
remarks: >-
\[ [API set: Mailbox 1.1](/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 item**
**[Applicable Outlook
mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!--
-->**: Appointment Attendee
**Important**: This property isn't supported in Outlook on Android or on iOS. For more information on
supported APIs in Outlook mobile, see [Outlook JavaScript APIs supported in Outlook on mobile
devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis)<!-- -->.
#### Examples
```TypeScript
// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-date-time-modified-read.yaml
console.log(`Date and time item last modified: ${Office.context.mailbox.item.dateTimeModified}`);
```
isPreview: false
isDeprecated: false
syntax:
content: 'dateTimeModified: Date;'
return:
type: Date
- name: end
uid: 'outlook!Office.AppointmentRead#end:member'
package: outlook!
fullName: end
summary: >-
Gets the date and time that the appointment is to end.
The `end` property is a `Date` object expressed as a Coordinated Universal Time (UTC) date and time value. You can
use the `convertToLocalClientTime` method to convert the `end` property value to the client's local date and time.
When you use the `Time.setAsync` method to set the end time, you should use the `convertToUtcClientTime` method to
convert the local time on the client to UTC for the server.
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)<!--
-->**: Appointment Attendee
#### Examples
```TypeScript
// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-end-read.yaml
console.log(`Appointment ends: ${Office.context.mailbox.item.end}`);
```
isPreview: false
isDeprecated: false
syntax:
content: 'end: Date;'
return:
type: Date
- name: enhancedLocation
uid: 'outlook!Office.AppointmentRead#enhancedLocation:member'
package: outlook!
fullName: enhancedLocation
summary: >-
Gets the locations of an appointment.
The `enhancedLocation` property returns an [EnhancedLocation](xref:outlook!Office.EnhancedLocation:interface)
object that allows you to get the set of locations (each represented by a
[LocationDetails](xref:outlook!Office.LocationDetails:interface) object) associated with the appointment.
remarks: >-
\[ [API set: Mailbox 1.8](/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 item**
**[Applicable Outlook
mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!--
-->**: Appointment Attendee
#### Examples
```TypeScript
// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-add-remove-enhancedlocation-appointment.yaml
Office.context.mailbox.item.enhancedLocation.getAsync((result) => {
if (result.status !== Office.AsyncResultStatus.Succeeded) {
console.error(`Failed to get locations. Error message: ${result.error.message}`);
return;
}
const places = result.value;
if (places && places.length > 0) {
result.value.forEach(function(place) {
console.log(`Location: ${place.displayName} (type: ${place.locationIdentifier.type})`);
if (place.locationIdentifier.type === Office.MailboxEnums.LocationType.Room) {
console.log("Email address: " + place.emailAddress);
}
});
} else {
console.log("There are no locations.");
}
});
```
isPreview: false
isDeprecated: false
syntax:
content: 'enhancedLocation: EnhancedLocation;'
return:
type: '<xref uid="outlook!Office.EnhancedLocation:interface" />'
- name: itemClass
uid: 'outlook!Office.AppointmentRead#itemClass:member'
package: outlook!
fullName: itemClass
summary: >-
Gets the Exchange Web Services item class of the selected appointment.
Returns `IPM.Appointment` for non-recurring appointments and `IPM.Appointment.Occurrence` for recurring
appointments.
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)<!--
-->**: Appointment Attendee
**Important**: You can create custom classes that extend a default item class. For example,
`IPM.Appointment.Contoso`<!-- -->.
#### Examples
```TypeScript
// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-item-class-read.yaml
console.log(`Item class: ${Office.context.mailbox.item.itemClass}`);
```
isPreview: false
isDeprecated: false
syntax:
content: 'itemClass: string;'
return:
type: string
- name: itemId
uid: 'outlook!Office.AppointmentRead#itemId:member'
package: outlook!
fullName: itemId
summary: >-
Gets the [Exchange Web Services (EWS) item
identifier](https://learn.microsoft.com/exchange/client-developer/exchange-web-services/ews-identifiers-in-exchange)
of the current item.
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)<!--
-->**: Appointment Attendee
**Important**:
- The `itemId` property isn't available in compose mode. If an item identifier is required, the
`Office.context.mailbox.item.saveAsync` method can be used to save the item to the store, which will return the
item identifier in the `asyncResult.value` parameter in the callback function. If the item is already saved, you
can call the `Office.context.mailbox.item.getItemIdAsync` method instead.
- The item ID returned isn't identical to the Outlook Entry ID or the ID used by the Outlook REST API. Before
making REST API calls using this value, it should be converted using `Office.context.mailbox.convertToRestId`<!--
-->.
#### Examples
```TypeScript
// The following code checks for the presence of an item
// identifier. If the `itemId` property returns `null` or
// `undefined`, it saves the item to the store and gets the
// item identifier from the asynchronous result.
// **Important**: `saveAsync` was introduced with requirement set 1.3
// so you can't get the `itemId` in Compose mode in earlier sets.
let itemId = Office.context.mailbox.item.itemId;
if (itemId === null || itemId == undefined) {
Office.context.mailbox.item.saveAsync(function(result) {
itemId = result.value;
});
}
```
isPreview: false
isDeprecated: false
syntax:
content: 'itemId: string;'
return:
type: string
- name: itemType
uid: 'outlook!Office.AppointmentRead#itemType:member'
package: outlook!
fullName: itemType
summary: >-
Gets the type of item that an instance represents.
The `itemType` property returns one of the `ItemType` enumeration values, indicating whether the item object
instance is a message or an appointment.
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)<!--
-->**: Appointment Attendee
#### Examples
```TypeScript
// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-item-type.yaml
const itemType = Office.context.mailbox.item.itemType;
switch (itemType) {
case Office.MailboxEnums.ItemType.Appointment:
console.log(`Current item is an ${itemType}.`);
break;
case Office.MailboxEnums.ItemType.Message:
console.log(`Current item is a ${itemType}. A message could be an email, meeting request, meeting response, or meeting cancellation.`);
break;
}
```
isPreview: false
isDeprecated: false
syntax:
content: 'itemType: MailboxEnums.ItemType | string;'
return:
type: '<xref uid="outlook!Office.MailboxEnums.ItemType:enum" /> | string'
- name: location
uid: 'outlook!Office.AppointmentRead#location:member'
package: outlook!
fullName: location
summary: |-
Gets the location of an appointment.
The `location` property returns a string that contains the location of the appointment.
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)<!--
-->**: Appointment Attendee
#### Examples
```TypeScript
const location = Office.context.mailbox.item.location;
console.log("location: " + location);
```
```TypeScript
// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-location-read.yaml
console.log(`Appointment location: ${Office.context.mailbox.item.location}`);
```
isPreview: false
isDeprecated: false
syntax:
content: 'location: string;'
return:
type: string
- name: normalizedSubject
uid: 'outlook!Office.AppointmentRead#normalizedSubject:member'
package: outlook!
fullName: normalizedSubject
summary: >-
Gets the subject of an item, with all prefixes removed (including RE: and FWD:).
The `normalizedSubject` property gets the subject of the item, with any standard prefixes (such as RE: and FW:)
that are added by email programs. To get the subject of the item with the prefixes intact, use the `subject`
property.
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)<!--
-->**: Appointment Attendee
#### Examples
```TypeScript
// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-normalized-subject-read.yaml
console.log(`Normalized subject: ${Office.context.mailbox.item.normalizedSubject}`);
```
isPreview: false
isDeprecated: false
syntax:
content: 'normalizedSubject: string;'
return:
type: string
- name: notificationMessages
uid: 'outlook!Office.AppointmentRead#notificationMessages:member'
package: outlook!
fullName: notificationMessages
summary: Gets the notification messages for an item.
remarks: >-
\[ [API set: Mailbox 1.3](/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 item**
**[Applicable Outlook
mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!--
-->**: Appointment Attendee
#### Examples
```TypeScript
// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/35-notifications/add-getall-remove.yaml
// Adds a progress indicator to the mail item.
const id = $("#notificationId").val().toString();
const details =
{
type: Office.MailboxEnums.ItemNotificationMessageType.ProgressIndicator,
message: "Progress indicator with id = " + id
};
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);
...
// Adds an informational notification to the mail item.
const id = $("#notificationId").val().toString();
const details =
{
type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
message: "Non-persistent informational notification message with id = " + id,
icon: "icon1",
persistent: false
};
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);
...
// Adds a persistent information notification to the mail item.
const id = $("#notificationId").val().toString();
const details =
{
type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
message: "Persistent informational notification message with id = " + id,
icon: "icon1",
persistent: true
};
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);
...
// Gets all the notification messages and their keys for the current mail item.
Office.context.mailbox.item.notificationMessages.getAllAsync((asyncResult) => {
if (asyncResult.status === Office.AsyncResultStatus.Failed) {
console.log(asyncResult.error.message);
return;
}
console.log(asyncResult.value);
});
...
// Replaces a notification message of a given key with another message.
const id = $("#notificationId").val().toString();
Office.context.mailbox.item.notificationMessages.replaceAsync(
id,
{
type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
message: "Notification message with id = " + id + " has been replaced with an informational message.",
icon: "icon2",
persistent: false
},
handleResult);
...
// Removes a notification message from the current mail item.
const id = $("#notificationId").val().toString();
Office.context.mailbox.item.notificationMessages.removeAsync(id, handleResult);
```
isPreview: false
isDeprecated: false
syntax:
content: 'notificationMessages: NotificationMessages;'
return:
type: '<xref uid="outlook!Office.NotificationMessages:interface" />'
- name: optionalAttendees
uid: 'outlook!Office.AppointmentRead#optionalAttendees:member'
package: outlook!
fullName: optionalAttendees
summary: >-
Provides access to the optional attendees of an event. The type of object and level of access depend on the mode
of the current item.
The `optionalAttendees` property returns an array that contains an
[EmailAddressDetails](xref:outlook!Office.EmailAddressDetails:interface) object for each optional attendee to the
meeting. The maximum number of attendees returned varies per Outlook client.
- Windows: 500 attendees
- Android, classic Mac UI, iOS: 100 attendees
- New Mac UI, web browser: No limit
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)<!--
-->**: Appointment Attendee
#### Examples
```TypeScript
// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-optional-attendees-appointment-attendee.yaml
const apptOptionalAttendees = Office.context.mailbox.item.optionalAttendees;
console.log("Optional attendees:");
for (let i = 0; i < apptOptionalAttendees.length; i++) {
console.log(
apptOptionalAttendees[i].displayName +
" (" +
apptOptionalAttendees[i].emailAddress +
") - response: " +
apptOptionalAttendees[i].appointmentResponse
);
}
```
isPreview: false
isDeprecated: false
syntax:
content: 'optionalAttendees: EmailAddressDetails[];'
return:
type: '<xref uid="outlook!Office.EmailAddressDetails:interface" />[]'
- name: organizer
uid: 'outlook!Office.AppointmentRead#organizer:member'
package: outlook!
fullName: organizer
summary: Gets the meeting organizer's email properties.
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)<!--
-->**: Appointment Attendee
#### Examples
```TypeScript
// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-organizer-appointment-attendee.yaml
const apptOrganizer = Office.context.mailbox.item.organizer;
console.log("Organizer: " + apptOrganizer.displayName + " (" + apptOrganizer.emailAddress + ")");
```
isPreview: false
isDeprecated: false
syntax:
content: 'organizer: EmailAddressDetails;'
return:
type: '<xref uid="outlook!Office.EmailAddressDetails:interface" />'
- name: recurrence
uid: 'outlook!Office.AppointmentRead#recurrence:member'
package: outlook!
fullName: recurrence
summary: >-
Gets the recurrence pattern of an appointment. Gets the recurrence pattern of a meeting request.
The `recurrence` property returns a [Recurrence](xref:outlook!Office.Recurrence:interface) object for recurring
appointments or meetings requests if an item is a series or an instance in a series. `null` is returned for single
appointments and meeting requests of single appointments.
**Note**: Meeting requests have an `itemClass` value of `IPM.Schedule.Meeting.Request`<!-- -->.
**Note**: If the recurrence object is null, this indicates that the object is a single appointment or a
meeting request of a single appointment and NOT a part of a series.
remarks: >-
\[ [API set: Mailbox 1.7](/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 item**
**[Applicable Outlook
mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!--
-->**: Appointment Attendee
#### Examples
```TypeScript
// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/50-recurrence/get-recurrence-read.yaml
const recurrence = Office.context.mailbox.item.recurrence;
if (recurrence === undefined) {
console.log("This item is a message but not a meeting request.");
} else if (recurrence === null) {
console.log("This is a single appointment.");
} else {
console.log(JSON.stringify(recurrence));
}
```
isPreview: false
isDeprecated: false
syntax:
content: 'recurrence: Recurrence;'
return:
type: '<xref uid="outlook!Office.Recurrence:interface" />'
- name: requiredAttendees
uid: 'outlook!Office.AppointmentRead#requiredAttendees:member'
package: outlook!
fullName: requiredAttendees
summary: >-
Provides access to the required attendees of an event. The type of object and level of access depend on the mode
of the current item.
The `requiredAttendees` property returns an array that contains an
[EmailAddressDetails](xref:outlook!Office.EmailAddressDetails:interface) object for each required attendee to the
meeting. The maximum number of attendees returned varies per Outlook client.
- Windows: 500 attendees
- Android, classic Mac UI, iOS: 100 attendees
- New Mac UI, web browser: No limit
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)<!--
-->**: Appointment Attendee
**Important**: In Outlook on the web and on Windows (new and classic), the appointment organizer is included
in the object returned by the `requiredAttendees` property.
#### Examples
```TypeScript
// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-required-attendees-appointment-attendee.yaml
const apptRequiredAttendees = Office.context.mailbox.item.requiredAttendees;
console.log("Required attendees:");
for (let i = 0; i < apptRequiredAttendees.length; i++) {
console.log(
apptRequiredAttendees[i].displayName +
" (" +