/
office.from.yml
165 lines (123 loc) · 6.58 KB
/
office.from.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
### YamlMime:TSType
name: Office.From
uid: 'outlook!Office.From:interface'
package: outlook!
fullName: Office.From
summary: Provides a method to get the from value of a message in an Outlook add-in.
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)<!-- -->**:
Compose
**Important**: This interface is supported in Outlook on Android and on iOS. For a sample scenario, see [Implement
event-based activation in Outlook mobile
add-ins](https://learn.microsoft.com/office/dev/add-ins/outlook/mobile-event-based)<!-- -->.
isPreview: false
isDeprecated: false
type: interface
methods:
- name: 'getAsync(options, callback)'
uid: 'outlook!Office.From#getAsync:member(1)'
package: outlook!
fullName: 'getAsync(options, callback)'
summary: >-
Gets the from value of a message.
The `getAsync` method starts an asynchronous call to the Exchange server to get the from value of a message.
The from value of the item is provided as an
[EmailAddressDetails](xref:outlook!Office.EmailAddressDetails:interface) in the `asyncResult.value` property.
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)<!--
-->**: Compose
**Important**:
- This method is supported in Outlook on Android and on iOS. For a sample scenario, see [Implement event-based
activation in Outlook mobile
add-ins](https://learn.microsoft.com/office/dev/add-ins/outlook/mobile-event-based)<!-- -->. To learn more about
APIs supported 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)<!-- -->.
- A `recipientType` property value isn't returned by the `getAsync` method. The email sender is always a user
whose email address is on the Exchange server.
#### Examples
```TypeScript
// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-from-message-compose.yaml
Office.context.mailbox.item.from.getAsync(function(asyncResult) {
if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
const msgFrom = asyncResult.value;
console.log("Message from: " + msgFrom.displayName + " (" + msgFrom.emailAddress + ")");
} else {
console.error(asyncResult.error);
}
});
```
isPreview: false
isDeprecated: false
syntax:
content: >-
getAsync(options: Office.AsyncContextOptions, callback?: (asyncResult:
Office.AsyncResult<EmailAddressDetails>) => void): void;
parameters:
- id: options
description: >-
An object literal that contains one or more of the following properties:- `asyncContext`<!-- -->: Developers
can provide any object they wish to access in the callback function.
type: '<xref uid="office!Office.AsyncContextOptions:interface" />'
- id: callback
description: >-
Optional. When the method completes, the function passed in the `callback` parameter is called with a single
parameter, `asyncResult`<!-- -->, which is an `Office.AsyncResult` object. The `value` property of the
result is the item's from value, as an `EmailAddressDetails` object.
type: >-
(asyncResult: <xref uid="office!Office.AsyncResult:interface" /><<xref
uid="outlook!Office.EmailAddressDetails:interface" />>) => void
return:
type: void
description: ''
- name: getAsync(callback)
uid: 'outlook!Office.From#getAsync:member(2)'
package: outlook!
fullName: getAsync(callback)
summary: >-
Gets the from value of a message.
The `getAsync` method starts an asynchronous call to the Exchange server to get the from value of a message.
The from value of the item is provided as an
[EmailAddressDetails](xref:outlook!Office.EmailAddressDetails:interface) in the `asyncResult.value` property.
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)<!--
-->**: Compose
**Important**:
- This method is supported in Outlook on Android and on iOS. For a sample scenario, see [Implement event-based
activation in Outlook mobile
add-ins](https://learn.microsoft.com/office/dev/add-ins/outlook/mobile-event-based)<!-- -->. To learn more about
APIs supported 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)<!-- -->.
- A `recipientType` property value isn't returned by the `getAsync` method. The email sender is always a user
whose email address is on the Exchange server.
isPreview: false
isDeprecated: false
syntax:
content: 'getAsync(callback?: (asyncResult: Office.AsyncResult<EmailAddressDetails>) => void): void;'
parameters:
- id: callback
description: >-
Optional. When the method completes, the function passed in the `callback` parameter is called with a single
parameter, `asyncResult`<!-- -->, which is an `Office.AsyncResult` object. The `value` property of the
result is the item's from value, as an `EmailAddressDetails` object.
type: >-
(asyncResult: <xref uid="office!Office.AsyncResult:interface" /><<xref
uid="outlook!Office.EmailAddressDetails:interface" />>) => void
return:
type: void
description: ''