Skip to content

Commit 7a6c4cd

Browse files
[Outlook] (SessionData) Document updated SessionData size (#5384)
* Update increased SessionData character limit * Fix typo * Add minimum supported version * Update ms.date * Update ms.date Co-authored-by: Elizabeth Samuel <elizs@microsoft.com> --------- Co-authored-by: Elizabeth Samuel <elizs@microsoft.com>
1 parent c304028 commit 7a6c4cd

File tree

2 files changed

+6
-3
lines changed

2 files changed

+6
-3
lines changed

docs/outlook/limits-for-activation-and-javascript-api-for-outlook-add-ins.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Limits for activation and API usage in Outlook add-ins
33
description: Be aware of certain activation and API usage guidelines, and implement your add-ins to stay within these limits.
4-
ms.date: 07/14/2025
4+
ms.date: 11/04/2025
55
ms.topic: best-practice
66
ms.localizationpriority: medium
77
---
@@ -25,7 +25,7 @@ Each Outlook client enforces certain limits in the JavaScript object model, as d
2525
|:-----|:-----|:-----|:-----|
2626
|Custom properties|2,500 characters|[CustomProperties](/javascript/api/outlook/office.customproperties) object<br/><br/>[Item.loadCustomPropertiesAsync](/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item#methods) method|Limit for all custom properties for an appointment or message item. All the Outlook clients return an error if the total size of all custom properties of an add-in exceeds this limit.|
2727
|Roaming settings|32 KB number of characters|[RoamingSettings](/javascript/api/outlook/office.roamingsettings) object<br/><br/>[Context.roamingSettings](/javascript/api/office/office.context#office-office-context-roamingsettings-member) property|Limit for all roaming settings for the add-in. All the Outlook clients return an error if your settings exceed this limit.|
28-
|Session data|50,000 characters|[Office.SessionData](/javascript/api/outlook/office.sessiondata)<br/><br/>[Item.sessionData](/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item#methods) method|For a specific mail item, the limit of an entire SessionData object per add-in.|
28+
|Session data|50,000 characters (Mailbox 1.15 and earlier)<br><br>2,621,440 characters (in preview in classic Outlook on Windows)|[Office.SessionData](/javascript/api/outlook/office.sessiondata)<br/><br/>[Item.sessionData](/javascript/api/requirement-sets/outlook/preview-requirement-set/office.context.mailbox.item#methods) method|For a specific mail item, the limit of an entire SessionData object per add-in.|
2929
|Internet headers|256 KB per message in Exchange Online<br/><br/>Header size limit determined by the organization's administrators in Exchange on-premises|[InternetHeaders.setAsync](/javascript/api/outlook/office.internetheaders) method|The total size limit of headers that can be applied to a message.|
3030
|Exchange Web Services|5 MB number of characters in Outlook on the web, on Windows (starting in Version 2303 (Build 16225.10000)), on Mac (starting in Version 16.73 (23042601)), and in [new Outlook on Windows](https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627)<br><br>1 MB of characters in earlier versions of Outlook on Windows (classic) and on Mac|[Mailbox.makeEwsRequestAsync](/javascript/api/outlook/office.mailbox#outlook-office-mailbox-makeewsrequestasync-member(1)) method|Limit for a request or response to a `Mailbox.makeEwsRequestAsync` call.|
3131
|Item multi-select|100 messages|[Mailbox.getSelectedItemsAsync](/javascript/api/outlook/office.mailbox#outlook-office-mailbox-getselecteditemsasync-member(1)) method|The maximum number of selected messages on which an Outlook add-in can activate.|

docs/outlook/metadata-for-an-outlook-add-in.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Get and set metadata in an Outlook add-in
33
description: Manage custom data in your Outlook add-in by using roaming settings, custom properties, or session data.
4-
ms.date: 02/11/2025
4+
ms.date: 11/04/2025
55
ms.topic: how-to
66
ms.localizationpriority: medium
77
---
@@ -246,6 +246,9 @@ If you only need to save and access data while a mail item is being composed, us
246246

247247
Custom data is saved to the SessionData object as key-value pairs. For each mail item, the data in the SessionData object is limited to 50,000 characters per add-in. That is, if multiple add-ins set custom session data on a single mail item, each add-in can create a SessionData object that contains up to 50,000 characters.
248248

249+
> [!NOTE]
250+
> An increased SessionData character limit of up to 2,621,440 characters is in preview in classic Outlook on Windows. To test the updated limit, join the [Microsoft 365 Insider program](https://aka.ms/MSFT365InsiderProgram), then choose the Beta Channel in the classic Outlook on Windows client. Your client must be on Version 2510 (Build 19317.20000) or later.
251+
249252
### Try the code example in Script Lab
250253

251254
To learn how to create and manage a SessionData object, get the [Script Lab for Outlook add-in](https://appsource.microsoft.com/product/office/wa200001603) and try out the ["Work with session data APIs (Compose)" sample](https://raw.githubusercontent.com/OfficeDev/office-js-snippets/refs/heads/main/samples/outlook/90-other-item-apis/session-data-apis.yaml). To learn more about Script Lab, see [Explore Office JavaScript API using Script Lab](../overview/explore-with-script-lab.md).

0 commit comments

Comments
 (0)