-
Notifications
You must be signed in to change notification settings - Fork 61
/
office.userprofile.yml
173 lines (125 loc) · 5.09 KB
/
office.userprofile.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
### YamlMime:TSType
name: Office.UserProfile
uid: 'outlook!Office.UserProfile:interface'
package: outlook!
fullName: Office.UserProfile
summary: >-
Information about the user associated with the mailbox. This includes their account type, display name, email address,
and time zone.
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: accountType
uid: 'outlook!Office.UserProfile#accountType:member'
package: outlook!
fullName: accountType
summary: |-
Gets the account type of the user associated with the mailbox.
**Note**: This member is currently only supported in Outlook on Mac, Build 16.9.1212 and greater.
remarks: >-
\[ [API set: Mailbox 1.6](/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)<!--
-->**: Compose or Read
The possible account types are listed in the following table.
<table> <tr> <th>Value</th> <th>Description</th> </tr> <tr> <td>enterprise</td> <td>The mailbox is on an
on-premises Exchange server.</td> </tr> <tr> <td>gmail</td> <td>The mailbox is associated with a Gmail
account.</td> </tr> <tr> <td>office365</td> <td>The mailbox is associated with a Microsoft 365 work or school
account.</td> </tr> <tr> <td>outlookCom</td> <td>The mailbox is associated with a personal Outlook.com
account.</td> </tr> </table>
**Note**: For hybrid Exchange environments, the returned account type value depends on where the mailbox is
hosted. If the mailbox is on an on-premises server, the account type value is **enterprise**. However, if it's
hosted on Exchange Online, the account type value is **office365**.
#### Examples
```TypeScript
console.log(Office.context.mailbox.userProfile.accountType);
```
isPreview: false
isDeprecated: false
syntax:
content: 'accountType: string;'
return:
type: string
- name: displayName
uid: 'outlook!Office.UserProfile#displayName:member'
package: outlook!
fullName: displayName
summary: Gets the user's display name.
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
#### Examples
```TypeScript
// Example: Allie Bellew
console.log(Office.context.mailbox.userProfile.displayName);
```
isPreview: false
isDeprecated: false
syntax:
content: 'displayName: string;'
return:
type: string
- name: emailAddress
uid: 'outlook!Office.UserProfile#emailAddress:member'
package: outlook!
fullName: emailAddress
summary: Gets the user's SMTP email address.
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
#### Examples
```TypeScript
// Example: allieb@contoso.com
console.log(Office.context.mailbox.userProfile.emailAddress);
```
isPreview: false
isDeprecated: false
syntax:
content: 'emailAddress: string;'
return:
type: string
- name: timeZone
uid: 'outlook!Office.UserProfile#timeZone:member'
package: outlook!
fullName: timeZone
summary: >-
Gets the user's time zone in Windows format.
The system time zone is usually returned. However, in Outlook on the web, the default time zone in the calendar
preferences is returned instead.
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
#### Examples
```TypeScript
// Example: Pacific Standard Time
console.log(Office.context.mailbox.userProfile.timeZone);
```
isPreview: false
isDeprecated: false
syntax:
content: 'timeZone: string;'
return:
type: string