[Outlook] (EWS, REST) Update guidance and supported Exchange environments #4850

samantharamon · 2024-10-11T20:01:47Z

Retires outdated articles.
Clarifies that Exchange Web Services (EWS) can only be used in Exchange on-premises environments.
Promotes the use of Microsoft Graph and nested app authentication in Exchange Online environments.

learn-build-service-prod · 2024-10-11T20:03:15Z

Learn Build status updates of commit 7b78bb5:

⚠️ Validation status: warnings

File	Status	Preview URL	Details
docs/outlook/get-and-set-item-data-in-a-compose-form.md	⚠️Warning	n/a (file deleted or renamed)	Details
docs/outlook/item-data.md	⚠️Warning	n/a (file deleted or renamed)	Details
docs/includes/mailbox-object-desc.md	✅Succeeded	View
docs/outlook/add-and-remove-attachments-to-an-item-in-a-compose-form.md	✅Succeeded	View
docs/outlook/add-mobile-support.md	✅Succeeded	View
docs/outlook/compose-scenario.md	✅Succeeded	View
docs/outlook/get-attachments-of-an-outlook-item.md	✅Succeeded	View
docs/outlook/get-or-set-the-subject.md	✅Succeeded	View
docs/outlook/get-or-set-the-time-of-an-appointment.md	✅Succeeded	View
docs/outlook/get-set-or-add-recipients.md	✅Succeeded	View
docs/outlook/insert-data-in-the-body.md	✅Succeeded	View
docs/outlook/internet-headers.md	✅Succeeded	View
docs/outlook/metadata-for-an-outlook-add-in.md	✅Succeeded	View
docs/outlook/outlook-mobile-addins.md	✅Succeeded	View
docs/outlook/understanding-outlook-add-in-permissions.md	✅Succeeded	View
docs/outlook/web-services.md	✅Succeeded	View
docs/toc.yml	✅Succeeded	View

docs/outlook/get-and-set-item-data-in-a-compose-form.md

[Warning: file-not-redirected - See documentation] File docs/outlook/get-and-set-item-data-in-a-compose-form.md with URL /office/dev/add-ins/outlook/get-and-set-item-data-in-a-compose-form was deleted without redirection. To avoid broken links, add a redirection.

docs/outlook/item-data.md

[Warning: file-not-redirected - See documentation] File docs/outlook/item-data.md with URL /office/dev/add-ins/outlook/item-data was deleted without redirection. To avoid broken links, add a redirection.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

Try searching the learn.microsoft.com contributor guides
Post your question in the Learn support channel

learn-build-service-prod · 2024-10-11T20:09:56Z

Learn Build status updates of commit 432360b:

✅ Validation status: passed

File	Status	Preview URL
.openpublishing.redirection.json	✅Succeeded	View
docs/includes/mailbox-object-desc.md	✅Succeeded	View
docs/outlook/add-and-remove-attachments-to-an-item-in-a-compose-form.md	✅Succeeded	View
docs/outlook/add-mobile-support.md	✅Succeeded	View
docs/outlook/compose-scenario.md	✅Succeeded	View
docs/outlook/get-and-set-item-data-in-a-compose-form.md	✅Succeeded	n/a (file deleted or renamed)
docs/outlook/get-attachments-of-an-outlook-item.md	✅Succeeded	View
docs/outlook/get-or-set-the-subject.md	✅Succeeded	View
docs/outlook/get-or-set-the-time-of-an-appointment.md	✅Succeeded	View
docs/outlook/get-set-or-add-recipients.md	✅Succeeded	View
docs/outlook/insert-data-in-the-body.md	✅Succeeded	View
docs/outlook/internet-headers.md	✅Succeeded	View
docs/outlook/item-data.md	✅Succeeded	n/a (file deleted or renamed)
docs/outlook/metadata-for-an-outlook-add-in.md	✅Succeeded	View
docs/outlook/outlook-mobile-addins.md	✅Succeeded	View
docs/outlook/understanding-outlook-add-in-permissions.md	✅Succeeded	View
docs/outlook/web-services.md	✅Succeeded	View
docs/toc.yml	✅Succeeded	View

For more details, please refer to the build report.

For any questions, please:

Try searching the learn.microsoft.com contributor guides
Post your question in the Learn support channel

learn-build-service-prod · 2024-10-11T20:15:27Z

Learn Build status updates of commit 218c815:

✅ Validation status: passed

File	Status	Preview URL
.openpublishing.redirection.json	✅Succeeded	View
docs/includes/mailbox-object-desc.md	✅Succeeded	View
docs/outlook/add-and-remove-attachments-to-an-item-in-a-compose-form.md	✅Succeeded	View
docs/outlook/add-mobile-support.md	✅Succeeded	View
docs/outlook/compose-scenario.md	✅Succeeded	View
docs/outlook/get-and-set-item-data-in-a-compose-form.md	✅Succeeded	n/a (file deleted or renamed)
docs/outlook/get-attachments-of-an-outlook-item.md	✅Succeeded	View
docs/outlook/get-or-set-the-subject.md	✅Succeeded	View
docs/outlook/get-or-set-the-time-of-an-appointment.md	✅Succeeded	View
docs/outlook/get-set-or-add-recipients.md	✅Succeeded	View
docs/outlook/insert-data-in-the-body.md	✅Succeeded	View
docs/outlook/internet-headers.md	✅Succeeded	View
docs/outlook/item-data.md	✅Succeeded	n/a (file deleted or renamed)
docs/outlook/metadata-for-an-outlook-add-in.md	✅Succeeded	View
docs/outlook/outlook-mobile-addins.md	✅Succeeded	View
docs/outlook/understanding-outlook-add-in-permissions.md	✅Succeeded	View
docs/outlook/web-services.md	✅Succeeded	View
docs/toc.yml	✅Succeeded	View

For more details, please refer to the build report.

For any questions, please:

Try searching the learn.microsoft.com contributor guides
Post your question in the Learn support channel

ElizabethSamuel-MSFT · 2024-10-11T20:30:49Z

docs/outlook/add-and-remove-attachments-to-an-item-in-a-compose-form.md

 ```

-You can check for success or error of an asynchronous method call in the callback function using the `status` and `error` properties of the `AsyncResult` object. If the attaching completes successfully, you can use the `AsyncResult.value` property to get the attachment ID. The attachment ID is an integer which you can subsequently use to remove the attachment.
+To check for a successful asynchronous method call in the callback function, use the `status` and `error` properties of the `AsyncResult` object. If the attaching completes successfully, use the `AsyncResult.value` property to get the attachment ID. The attachment ID is an integer which you can subsequently use to remove the attachment.


Suggested change

To check for a successful asynchronous method call in the callback function, use the `status` and `error` properties of the `AsyncResult` object. If the attaching completes successfully, use the `AsyncResult.value` property to get the attachment ID. The attachment ID is an integer which you can subsequently use to remove the attachment.

To check for the outcome of an asynchronous method call in the callback function, use the `status` and `error` properties of the `AsyncResult` object. If the attaching completes successfully, use the `AsyncResult.value` property to get the attachment ID. The attachment ID is an integer which you can subsequently use to remove the attachment.

ElizabethSamuel-MSFT · 2024-10-11T20:31:23Z

docs/outlook/add-and-remove-attachments-to-an-item-in-a-compose-form.md

 ```

-To add an inline base64 image to the body of a message or appointment being composed, you must first get the current item body using the `Office.context.mailbox.item.body.getAsync` method before inserting the image using the `addFileAttachmentFromBase64Async` method. Otherwise, the image will not render in the body once it's inserted. For guidance, see the following JavaScript example, which adds an inline Base64 image to the beginning of an item body.
+To add an inline Base64 image to the body of a message or appointment being composed, you must first get the current item body using the `Office.context.mailbox.item.body.getAsync` method before inserting the image using the `addFileAttachmentFromBase64Async` method. Otherwise, the image won't render in the body once it's inserted. For guidance, see the following JavaScript example, which adds an inline Base64 image to the beginning of an item body.


Suggested change

To add an inline Base64 image to the body of a message or appointment being composed, you must first get the current item body using the `Office.context.mailbox.item.body.getAsync` method before inserting the image using the `addFileAttachmentFromBase64Async` method. Otherwise, the image won't render in the body once it's inserted. For guidance, see the following JavaScript example, which adds an inline Base64 image to the beginning of an item body.

To add inline a Base64-encoded image to the body of a message or appointment being composed, you must first get the current item body using the `Office.context.mailbox.item.body.getAsync` method before inserting the image using the `addFileAttachmentFromBase64Async` method. Otherwise, the image won't render in the body once it's inserted. For guidance, see the following JavaScript example, which adds an inline Base64 image to the beginning of an item body.

ElizabethSamuel-MSFT · 2024-10-11T20:33:13Z

docs/outlook/add-and-remove-attachments-to-an-item-in-a-compose-form.md

+        console.error(bodyResult.error.message);
+        return;
+    }
+
    // Insert the Base64 image to the beginning of the body.


Suggested change

// Insert the Base64 image to the beginning of the body.

// Insert the Base64-encoded image at the beginning of the body.

ElizabethSamuel-MSFT · 2024-10-11T20:36:00Z

docs/outlook/add-mobile-support.md

@@ -20,7 +20,7 @@ The first step to enabling add-in commands in Outlook mobile is to define them i
    ```json
    "formFactors": [
        "mobile",
-        <!-- Typically there will be other form factors listed. -->
+        <!-- Typically, there will be other form factors listed. -->


Suggested change

ElizabethSamuel-MSFT · 2024-10-11T20:37:03Z

docs/outlook/get-attachments-of-an-outlook-item.md

-title: Get attachments in an Outlook add-in
-description: Your add-in can use the attachments API to send information about the attachments to a remote service.
-ms.date: 08/07/2023
+title: Get attachments of an Outlook item from Exchange


Suggested change

title: Get attachments of an Outlook item from Exchange

title: Get an Outlook item's attachments from Exchange

ElizabethSamuel-MSFT · 2024-10-11T20:41:28Z

docs/outlook/get-attachments-of-an-outlook-item.md

 ms.topic: how-to
 ms.localizationpriority: medium
 ---

-# Get attachments of an Outlook item from the server
+# Get attachments of an Outlook item from Exchange


Suggested change

# Get attachments of an Outlook item from Exchange

# Get an Outlook item's attachments from Exchange

samantharamon added 2 commits October 8, 2024 18:53

Remove outdated articles

e4835c0

Update EWS-related articles

7b78bb5

samantharamon added the Status: Do Not Merge Do Not Merge label Oct 11, 2024

Set up file redirection

432360b

samantharamon requested a review from ElizabethSamuel-MSFT October 11, 2024 20:14

Update list of related articles

218c815

ElizabethSamuel-MSFT reviewed Oct 11, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Outlook] (EWS, REST) Update guidance and supported Exchange environments #4850

[Outlook] (EWS, REST) Update guidance and supported Exchange environments #4850

samantharamon commented Oct 11, 2024

learn-build-service-prod bot commented Oct 11, 2024

learn-build-service-prod bot commented Oct 11, 2024

learn-build-service-prod bot commented Oct 11, 2024

ElizabethSamuel-MSFT Oct 11, 2024

ElizabethSamuel-MSFT Oct 11, 2024

ElizabethSamuel-MSFT Oct 11, 2024

ElizabethSamuel-MSFT Oct 11, 2024

ElizabethSamuel-MSFT Oct 11, 2024

ElizabethSamuel-MSFT Oct 11, 2024

	To check for a successful asynchronous method call in the callback function, use the `status` and `error` properties of the `AsyncResult` object. If the attaching completes successfully, use the `AsyncResult.value` property to get the attachment ID. The attachment ID is an integer which you can subsequently use to remove the attachment.
	To check for the outcome of an asynchronous method call in the callback function, use the `status` and `error` properties of the `AsyncResult` object. If the attaching completes successfully, use the `AsyncResult.value` property to get the attachment ID. The attachment ID is an integer which you can subsequently use to remove the attachment.

	// Insert the Base64 image to the beginning of the body.
	// Insert the Base64-encoded image at the beginning of the body.

	<!-- Typically, there will be other form factors listed. -->
	<!-- Typically, there'll be other form factors listed. -->

	title: Get attachments of an Outlook item from Exchange
	title: Get an Outlook item's attachments from Exchange

	# Get attachments of an Outlook item from Exchange
	# Get an Outlook item's attachments from Exchange

[Outlook] (EWS, REST) Update guidance and supported Exchange environments #4850

Are you sure you want to change the base?

[Outlook] (EWS, REST) Update guidance and supported Exchange environments #4850

Conversation

samantharamon commented Oct 11, 2024

learn-build-service-prod bot commented Oct 11, 2024

⚠️ Validation status: warnings

learn-build-service-prod bot commented Oct 11, 2024

✅ Validation status: passed

learn-build-service-prod bot commented Oct 11, 2024

✅ Validation status: passed

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment