-
Notifications
You must be signed in to change notification settings - Fork 63
/
office.emailaddressdetails.yml
123 lines (104 loc) · 4.45 KB
/
office.emailaddressdetails.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
### YamlMime:TSType
name: Office.EmailAddressDetails
uid: 'outlook!Office.EmailAddressDetails:interface'
package: outlook!
fullName: Office.EmailAddressDetails
summary: Provides the email properties of the sender or specified recipients of an email message or 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)<!-- -->**:
Compose or Read
isPreview: false
isDeprecated: false
type: interface
properties:
- name: appointmentResponse
uid: 'outlook!Office.EmailAddressDetails#appointmentResponse:member'
package: outlook!
fullName: appointmentResponse
summary: >-
Gets the response that an attendee returned for an appointment. This property applies to only an attendee of an
appointment, as represented by the `optionalAttendees` or `requiredAttendees` property. This property returns
undefined in other scenarios.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'appointmentResponse: MailboxEnums.ResponseType | string;'
return:
type: '<xref uid="outlook!Office.MailboxEnums.ResponseType:enum" /> | string'
description: |-
#### Examples
```TypeScript
// The following sample provides the responses from required attendees.
// Note that this sample needs the add-in to be in Appointment Read (Attendee) mode.
const requiredAttendees = Office.context.mailbox.item.requiredAttendees;
console.log("There are " + requiredAttendees.length + " required attendees.")
requiredAttendees.forEach(function (requiredAttendee) {
console.log("Attendee " + requiredAttendee.displayName + ": " + requiredAttendee.appointmentResponse);
});
```
- name: displayName
uid: 'outlook!Office.EmailAddressDetails#displayName:member'
package: outlook!
fullName: displayName
summary: Gets the display name associated with an email address.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'displayName: string;'
return:
type: string
description: |-
#### Examples
```TypeScript
const organizerName = Office.context.mailbox.item.organizer.displayName;
console.log("Organizer: " + organizerName);
```
- name: emailAddress
uid: 'outlook!Office.EmailAddressDetails#emailAddress:member'
package: outlook!
fullName: emailAddress
summary: Gets the SMTP email address.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'emailAddress: string;'
return:
type: string
description: |-
#### Examples
```TypeScript
const organizerAddress = Office.context.mailbox.item.organizer.emailAddress;
console.log("Organizer's email address: " + organizerAddress);
```
- name: recipientType
uid: 'outlook!Office.EmailAddressDetails#recipientType:member'
package: outlook!
fullName: recipientType
summary: Gets the email address type of a recipient.
remarks: >-
**Important**: A `recipientType` property value isn't returned by the
[Office.context.mailbox.item.from.getAsync](https://learn.microsoft.com/javascript/api/outlook/office.from?view=outlook-js-1.7#outlook-office-from-getasync-member(1))
and
[Office.context.mailbox.item.organizer.getAsync](https://learn.microsoft.com/javascript/api/outlook/office.organizer?view=outlook-js-1.7#outlook-office-organizer-getasync-member(1))
methods. The email sender or appointment organizer is always a user whose email address is on the Exchange server.
#### Examples
```TypeScript
const requiredAttendees = Office.context.mailbox.item.requiredAttendees;
console.log("There are " + requiredAttendees.length + " required attendees.")
requiredAttendees.forEach(function (requiredAttendee) {
console.log("Attendee " + requiredAttendee.displayName + ": " + requiredAttendee.recipientType);
});
```
isPreview: false
isDeprecated: false
syntax:
content: 'recipientType: MailboxEnums.RecipientType | string;'
return:
type: '<xref uid="outlook!Office.MailboxEnums.RecipientType:enum" /> | string'