Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[office-js][office-js-preview] (Outlook) Document internet headers API support in Outlook on mobile devices #69444

Merged
merged 1 commit into from
Apr 30, 2024
Merged

[office-js][office-js-preview] (Outlook) Document internet headers API support in Outlook on mobile devices #69444

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
68 changes: 52 additions & 16 deletions types/office-js-preview/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14177,6 +14177,14 @@ declare namespace Office {
* @remarks
* [Api set: Mailbox 1.8]
*
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
*
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
*
* **Important**: The internet headers API is supported in Outlook on Android and on iOS starting in Version 4.2405.0.
* To learn more about features supported in Outlook on mobile devices, see
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
*
* **Recommended practices**
*
* Currently, internet headers are a finite resource on a user's mailbox. When the quota is exhausted, you can't create any more internet headers
Expand All @@ -14192,10 +14200,6 @@ declare namespace Office {
*
* - Name headers so that you can reuse and update their values later. As such, avoid naming headers in a variable manner
* (for example, based on user input, timestamp, etc.).
*
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
*
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
*/
interface InternetHeaders {
/**
Expand All @@ -14211,6 +14215,10 @@ declare namespace Office {
*
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
*
* **Important**: The internet headers API is supported in Outlook on Android and on iOS starting in Version 4.2405.0.
* To learn more about features supported in Outlook on mobile devices, see
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
*
* @param names - The names of the internet headers to be returned.
* @param options - 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.
Expand All @@ -14232,6 +14240,10 @@ declare namespace Office {
*
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
*
* **Important**: The internet headers API is supported in Outlook on Android and on iOS starting in Version 4.2405.0.
* To learn more about features supported in Outlook on mobile devices, see
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
*
* @param names - The names of the internet headers to be returned.
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter,
* `asyncResult`, of type `Office.AsyncResult`. The string key-value pairs of internet headers are returned in the
Expand All @@ -14250,6 +14262,10 @@ declare namespace Office {
*
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
*
* **Important**: The internet headers API is supported in Outlook on Android and on iOS starting in Version 4.2405.0.
* To learn more about features supported in Outlook on mobile devices, see
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
*
* @param names - The names of the internet headers to be removed.
* @param options - 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.
Expand All @@ -14269,6 +14285,10 @@ declare namespace Office {
*
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
*
* **Important**: The internet headers API is supported in Outlook on Android and on iOS starting in Version 4.2405.0.
* To learn more about features supported in Outlook on mobile devices, see
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
*
* @param names - The names of the internet headers to be removed.
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
* `asyncResult`, of type `Office.AsyncResult`. Any errors encountered are provided in the `asyncResult.error` property.
Expand All @@ -14281,12 +14301,6 @@ declare namespace Office {
* the new value.
*
* **Note**: This method is intended to set the values of your custom headers.
*
* **Important**: The header quota is based on the total size of headers applied to a message. In Exchange Online,
* the header limit is capped at 256 KB, while in an Exchange on-premises environment, the limit is determined by your organization's administrator.
* For further information on header limits, see
* {@link https://learn.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits#message-limits | Exchange Online message limits}
* and {@link https://learn.microsoft.com/exchange/mail-flow/message-size-limits?view=exchserver-2019#types-of-message-size-limits | Exchange Server message limits}.
*
* @remarks
* [Api set: Mailbox 1.8]
Expand All @@ -14295,6 +14309,18 @@ declare namespace Office {
*
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
*
* **Important**:
*
* - The internet headers API is supported in Outlook on Android and on iOS starting in Version 4.2405.0.
* To learn more about features supported in Outlook on mobile devices, see
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
*
* - The header quota is based on the total size of headers applied to a message. In Exchange Online,
* the header limit is capped at 256 KB, while in an Exchange on-premises environment, the limit is determined by your organization's administrator.
* For further information on header limits, see
* {@link https://learn.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits#message-limits | Exchange Online message limits}
* and {@link https://learn.microsoft.com/exchange/mail-flow/message-size-limits?view=exchserver-2019#types-of-message-size-limits | Exchange Server message limits}.
*
* @param headers - The names and corresponding values of the headers to be set. This should be a record object with its keys being internet header names
* and values being the corresponding header value strings.
* @param options - An object literal that contains one or more of the following properties:-
Expand All @@ -14310,12 +14336,6 @@ declare namespace Office {
* the new value.
*
* **Note**: This method is intended to set the values of your custom headers.
*
* **Important**: The header quota is based on the total size of headers applied to a message. In Exchange Online,
* the header limit is capped at 256 KB, while in an Exchange on-premises environment, the limit is determined by your organization's administrator.
* For further information on header limits, see
* {@link https://learn.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits#message-limits | Exchange Online message limits}
* and {@link https://learn.microsoft.com/exchange/mail-flow/message-size-limits?view=exchserver-2019#types-of-message-size-limits | Exchange Server message limits}.
*
* @remarks
* [Api set: Mailbox 1.8]
Expand All @@ -14324,6 +14344,18 @@ declare namespace Office {
*
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
*
* **Important**:
*
* - The internet headers API is supported in Outlook on Android and on iOS starting in Version 4.2405.0.
* To learn more about features supported in Outlook on mobile devices, see
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
*
* - The header quota is based on the total size of headers applied to a message. In Exchange Online,
* the header limit is capped at 256 KB, while in an Exchange on-premises environment, the limit is determined by your organization's administrator.
* For further information on header limits, see
* {@link https://learn.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits#message-limits | Exchange Online message limits}
* and {@link https://learn.microsoft.com/exchange/mail-flow/message-size-limits?view=exchserver-2019#types-of-message-size-limits | Exchange Server message limits}.
*
* @param headers - The names and corresponding values of the headers to be set. This should be a record object with its keys being internet header names
* and values being the corresponding header value strings.
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
Expand Down Expand Up @@ -15937,6 +15969,10 @@ declare namespace Office {
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
*
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
*
* **Important**: The internet headers API is supported in Outlook on Android and on iOS starting in Version 4.2405.0.
* To learn more about features supported in Outlook on mobile devices, see
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
*/
internetHeaders: InternetHeaders;
/**
Expand Down