Skip to content

Commit fea1070

Browse files
[Outlook] Publish Mailbox 1.15 (#2165)
* Draft Mailbox 1.15 documentation * Fix link * Add build files * Remove preview tags from spam-reporting improvements * Update ms.date and add supported build number * Add Smart Alerts function support and sendAsync * Apply suggestion from review * Run build script
1 parent a50e7d1 commit fea1070

File tree

223 files changed

+61120
-1418
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

223 files changed

+61120
-1418
lines changed

.openpublishing.publish.config.json

+5
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@
4242
"outlook-js-1.12",
4343
"outlook-js-1.13",
4444
"outlook-js-1.14",
45+
"outlook-js-1.15",
4546
"powerpoint-js-preview",
4647
"powerpoint-js-1.1",
4748
"powerpoint-js-1.2",
@@ -184,6 +185,10 @@
184185
"ReferenceTOC": "docs/docs-ref-autogen/outlook_1_14/toc.yml",
185186
"ConceptualTOCUrl": "/office/dev/add-ins/toc.json"
186187
},
188+
{
189+
"ReferenceTOC": "docs/docs-ref-autogen/outlook_1_15/toc.yml",
190+
"ConceptualTOCUrl": "/office/dev/add-ins/toc.json"
191+
},
187192
{
188193
"ReferenceTOC": "docs/docs-ref-autogen/excel/toc.yml",
189194
"ConceptualTOCUrl": "/office/dev/add-ins/toc.json"

docs/docfx.json

+11
Original file line numberDiff line numberDiff line change
@@ -299,6 +299,12 @@
299299
"src": "docs-ref-autogen/outlook_1_14",
300300
"dest": "api"
301301
},
302+
{
303+
"files": ["**/*.md", "**/*.yml"],
304+
"group": "outlook-js-1.15",
305+
"src": "docs-ref-autogen/outlook_1_15",
306+
"dest": "api"
307+
},
302308
{
303309
"files": ["**/toc.yml"],
304310
"group": "excel-js-preview",
@@ -927,6 +933,10 @@
927933
"dest": "outlook-js-1.14",
928934
"moniker_range": "outlook-js-1.14"
929935
},
936+
"outlook-js-1.15": {
937+
"dest": "outlook-js-1.15",
938+
"moniker_range": "outlook-js-1.15"
939+
},
930940
"excel-js-preview": {
931941
"dest": "excel-js-preview",
932942
"moniker_range": "excel-js-preview"
@@ -1201,6 +1211,7 @@
12011211
"docs-ref-autogen/outlook_1_12/**": "outlook",
12021212
"docs-ref-autogen/outlook_1_13/**": "outlook",
12031213
"docs-ref-autogen/outlook_1_14/**": "outlook",
1214+
"docs-ref-autogen/outlook_1_15/**": "outlook",
12041215
"docs-ref-autogen/powerpoint/**": "powerpoint",
12051216
"docs-ref-autogen/powerpoint_1_1/**": "powerpoint",
12061217
"docs-ref-autogen/powerpoint_1_2/**": "powerpoint",

docs/docs-ref-autogen/office/office/office.eventtype.yml

+24
Original file line numberDiff line numberDiff line change
@@ -165,6 +165,30 @@ fields:
165165
166166
167167
\[ [API set: Mailbox 1.10](/office/dev/add-ins/reference/javascript-api-for-office) \]
168+
- name: InitializationContextChanged
169+
uid: 'office!Office.EventType.InitializationContextChanged:member'
170+
package: office!
171+
summary: >-
172+
Occurs in Outlook when an add-in's task pane is opened from an [actionable
173+
message](https://learn.microsoft.com/outlook/actionable-messages)<!-- -->,
174+
[InsightMessage](https://learn.microsoft.com/javascript/api/outlook/office.mailboxenums.itemnotificationmessagetype#fields)
175+
notification, [Smart
176+
Alerts](https://learn.microsoft.com/office/dev/add-ins/outlook/onmessagesend-onappointmentsend-events) dialog, or
177+
[integrated spam-reporting](https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting) dialog. This
178+
event prevents an add-in from relaunching if its task pane is already open in Outlook.
179+
180+
181+
**Important**: The `InitializationContextChanged` event can only be handled in a task pane. Function commands
182+
can't register a handler for this event.
183+
184+
185+
To add an event handler for the `InitializationContextChanged` event, use the `addHandlerAsync` method of the
186+
`Item` object. The event handler receives an argument of type
187+
[Office.InitializationContextChangedEventArgs](https://learn.microsoft.com/javascript/api/outlook/office.initializationcontextchangedeventargs?view=outlook-js-1.15)<!--
188+
-->.
189+
190+
191+
\[ [API set: Mailbox 1.15](/office/dev/add-ins/reference/javascript-api-for-office) \]
168192
- name: ItemChanged
169193
uid: 'office!Office.EventType.ItemChanged:member'
170194
package: office!

docs/docs-ref-autogen/office_release/office/office.eventtype.yml

+24
Original file line numberDiff line numberDiff line change
@@ -165,6 +165,30 @@ fields:
165165
166166
167167
\[ [API set: Mailbox 1.10](/office/dev/add-ins/reference/javascript-api-for-office) \]
168+
- name: InitializationContextChanged
169+
uid: 'office!Office.EventType.InitializationContextChanged:member'
170+
package: office!
171+
summary: >-
172+
Occurs in Outlook when an add-in's task pane is opened from an [actionable
173+
message](https://learn.microsoft.com/outlook/actionable-messages)<!-- -->,
174+
[InsightMessage](https://learn.microsoft.com/javascript/api/outlook/office.mailboxenums.itemnotificationmessagetype#fields)
175+
notification, [Smart
176+
Alerts](https://learn.microsoft.com/office/dev/add-ins/outlook/onmessagesend-onappointmentsend-events) dialog, or
177+
[integrated spam-reporting](https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting) dialog. This
178+
event prevents an add-in from relaunching if its task pane is already open in Outlook.
179+
180+
181+
**Important**: The `InitializationContextChanged` event can only be handled in a task pane. Function commands
182+
can't register a handler for this event.
183+
184+
185+
To add an event handler for the `InitializationContextChanged` event, use the `addHandlerAsync` method of the
186+
`Item` object. The event handler receives an argument of type
187+
[Office.InitializationContextChangedEventArgs](https://learn.microsoft.com/javascript/api/outlook/office.initializationcontextchangedeventargs?view=outlook-js-1.15)<!--
188+
-->.
189+
190+
191+
\[ [API set: Mailbox 1.15](/office/dev/add-ins/reference/javascript-api-for-office) \]
168192
- name: ItemChanged
169193
uid: 'office!Office.EventType.ItemChanged:member'
170194
package: office!

docs/docs-ref-autogen/outlook/outlook.yml

+1
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ interfaces:
3232
- 'outlook!Office.From:interface'
3333
- 'outlook!Office.InfobarClickedEventArgs:interface'
3434
- 'outlook!Office.InfobarDetails:interface'
35+
- 'outlook!Office.InitializationContextChangedEventArgs:interface'
3536
- 'outlook!Office.InternetHeaders:interface'
3637
- 'outlook!Office.IsAllDayEvent:interface'
3738
- 'outlook!Office.Item:interface'

docs/docs-ref-autogen/outlook/outlook/office.appointmentcompose.yml

+127
Original file line numberDiff line numberDiff line change
@@ -3704,6 +3704,133 @@ methods:
37043704
return:
37053705
type: void
37063706
description: ''
3707+
- name: 'sendAsync(options, callback)'
3708+
uid: 'outlook!Office.AppointmentCompose#sendAsync:member(1)'
3709+
package: outlook!
3710+
fullName: 'sendAsync(options, callback)'
3711+
summary: Sends the appointment being composed.
3712+
remarks: >-
3713+
\[ [API set: Mailbox 1.15](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) \]
3714+
3715+
3716+
**[Minimum permission
3717+
level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)<!--
3718+
-->**: **read/write mailbox**
3719+
3720+
3721+
**[Applicable Outlook
3722+
mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!--
3723+
-->**: Appointment Organizer
3724+
3725+
3726+
**Important**:
3727+
3728+
3729+
- The `sendAsync` method is only supported in task pane and function command implementations. It isn't supported
3730+
in [event-based handlers](https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch) or [item multi-select
3731+
scenarios](https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select)<!-- -->.
3732+
3733+
3734+
- In a function command implementation, the value returned in `asyncResult.status` may not reflect whether the
3735+
appointment being composed is successfully sent. This is because the `sendAsync` method is an asynchronous API and
3736+
events outside the add-in's control (for example, events handled by a separately installed [Smart Alerts
3737+
add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/onmessagesend-onappointmentsend-events)<!-- -->)
3738+
could block the item from being sent. Since you can't rely on the status returned in `asyncResult.status` to run
3739+
certain operations, you should only call the
3740+
[event.completed](https://learn.microsoft.com/javascript/api/office/office.addincommands.event#office-office-addincommands-event-completed-member(1))
3741+
method in the callback function. The `event.completed` call signals that the add-in has completed processing.
3742+
Other than this call, other code in the callback function isn't guaranteed to run. We recommend processing other
3743+
operations before calling `sendAsync`<!-- -->.
3744+
3745+
3746+
- In a task pane implementation, any code included to run when `asyncResult.status` is
3747+
`Office.AsyncResultStatus.Success` isn't guaranteed to be processed. This is because the item may have already
3748+
been sent and the add-in has completed processing. We recommend processing other operations before calling
3749+
`sendAsync`<!-- -->.
3750+
3751+
3752+
- Any code included after the `sendAsync` call isn't guaranteed to run since the add-in completes processing after
3753+
the `sendAsync` call.
3754+
isPreview: false
3755+
isDeprecated: false
3756+
syntax:
3757+
content: >-
3758+
sendAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) =>
3759+
void): void;
3760+
parameters:
3761+
- id: options
3762+
description: >-
3763+
An object literal that contains the `asyncContext` property. Use the `asyncContext` property to specify any
3764+
object you want to access in the callback function.
3765+
type: '<xref uid="office!Office.AsyncContextOptions:interface" />'
3766+
- id: callback
3767+
description: >-
3768+
Optional. When the method completes, the function passed in the `callback` parameter is called with a single
3769+
parameter, `asyncResult`<!-- -->. The `asyncResult` parameter is an `Office.AsyncResult` object.
3770+
type: '(asyncResult: <xref uid="office!Office.AsyncResult:interface" />&lt;void&gt;) =&gt; void'
3771+
return:
3772+
type: void
3773+
description: ''
3774+
- name: sendAsync(callback)
3775+
uid: 'outlook!Office.AppointmentCompose#sendAsync:member(2)'
3776+
package: outlook!
3777+
fullName: sendAsync(callback)
3778+
summary: Sends the appointment being composed.
3779+
remarks: >-
3780+
\[ [API set: Mailbox 1.15](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) \]
3781+
3782+
3783+
**[Minimum permission
3784+
level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)<!--
3785+
-->**: **read/write mailbox**
3786+
3787+
3788+
**[Applicable Outlook
3789+
mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!--
3790+
-->**: Appointment Organizer
3791+
3792+
3793+
**Important**:
3794+
3795+
3796+
- The `sendAsync` method is only supported in task pane and function command implementations. It isn't supported
3797+
in [event-based handlers](https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch) or [item multi-select
3798+
scenarios](https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select)<!-- -->.
3799+
3800+
3801+
- In a function command implementation, the value returned in `asyncResult.status` may not reflect whether the
3802+
appointment being composed is successfully sent. This is because the `sendAsync` method is an asynchronous API and
3803+
events outside the add-in's control (for example, events handled by a separately installed [Smart Alerts
3804+
add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/onmessagesend-onappointmentsend-events)<!-- -->)
3805+
could block the item from being sent. Since you can't rely on the status returned in `asyncResult.status` to run
3806+
certain operations, you should only call the
3807+
[event.completed](https://learn.microsoft.com/javascript/api/office/office.addincommands.event#office-office-addincommands-event-completed-member(1))
3808+
method in the callback function. The `event.completed` call signals that the add-in has completed processing.
3809+
Other than this call, other code in the callback function isn't guaranteed to run. We recommend processing other
3810+
operations before calling `sendAsync`<!-- -->.
3811+
3812+
3813+
- In a task pane implementation, any code included to run when `asyncResult.status` is
3814+
`Office.AsyncResultStatus.Success` isn't guaranteed to be processed. This is because the item may have already
3815+
been sent and the add-in has completed processing. We recommend processing other operations before calling
3816+
`sendAsync`<!-- -->.
3817+
3818+
3819+
- Any code included after the `sendAsync` call isn't guaranteed to run since the add-in completes processing after
3820+
the `sendAsync` call.
3821+
isPreview: false
3822+
isDeprecated: false
3823+
syntax:
3824+
content: 'sendAsync(callback?: (asyncResult: Office.AsyncResult<void>) => void): void;'
3825+
parameters:
3826+
- id: callback
3827+
description: >-
3828+
Optional. When the method completes, the function passed in the `callback` parameter is called with a single
3829+
parameter, `asyncResult`<!-- -->. The `asyncResult` parameter is an `Office.AsyncResult` object.
3830+
type: '(asyncResult: <xref uid="office!Office.AsyncResult:interface" />&lt;void&gt;) =&gt; void'
3831+
return:
3832+
type: void
3833+
description: ''
37073834
- name: 'setSelectedDataAsync(data, options, callback)'
37083835
uid: 'outlook!Office.AppointmentCompose#setSelectedDataAsync:member(1)'
37093836
package: outlook!
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
### YamlMime:TSType
2+
name: Office.InitializationContextChangedEventArgs
3+
uid: 'outlook!Office.InitializationContextChangedEventArgs:interface'
4+
package: outlook!
5+
fullName: Office.InitializationContextChangedEventArgs
6+
summary: >-
7+
Provides data from an [actionable message](https://learn.microsoft.com/outlook/actionable-messages)<!-- -->,
8+
[InsightMessage](https://learn.microsoft.com/javascript/api/outlook/office.mailboxenums.itemnotificationmessagetype#fields)
9+
notification, [Smart
10+
Alerts](https://learn.microsoft.com/office/dev/add-ins/outlook/onmessagesend-onappointmentsend-events) dialog, or
11+
[integrated spam-reporting](https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting) dialog when the
12+
`Office.EventType.InitializationContextChanged` event occurs.
13+
remarks: '\[ [API set: Mailbox 1.15](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) \]'
14+
isPreview: false
15+
isDeprecated: false
16+
type: interface
17+
properties:
18+
- name: initializationContextData
19+
uid: 'outlook!Office.InitializationContextChangedEventArgs#initializationContextData:member'
20+
package: outlook!
21+
fullName: initializationContextData
22+
summary: >-
23+
Represents the data to be passed to an add-in's task pane from an actionable message, notification message, Smart
24+
Alerts dialog, or integrated spam-reporting dialog.
25+
remarks: '\[ [API set: Mailbox 1.15](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) \]'
26+
isPreview: false
27+
isDeprecated: false
28+
syntax:
29+
content: 'initializationContextData: string;'
30+
return:
31+
type: string
32+
- name: type
33+
uid: 'outlook!Office.InitializationContextChangedEventArgs#type:member'
34+
package: outlook!
35+
fullName: type
36+
summary: >-
37+
Represents the type of the event. For details, refer to
38+
[Office.EventType](https://learn.microsoft.com/javascript/api/office/office.eventtype)<!-- -->.
39+
remarks: '\[ [API set: Mailbox 1.15](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) \]'
40+
isPreview: false
41+
isDeprecated: false
42+
syntax:
43+
content: 'type: "olkInitializationContextChanged";'
44+
return:
45+
type: '"olkInitializationContextChanged"'

0 commit comments

Comments
 (0)