Skip to content

[Outlook] (Body API) Document bodyMode property #5139

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.

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

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

samantharamon
Copy link
Contributor

@samantharamon samantharamon commented Apr 21, 2025

  • Documents the bodyMode property of the get and set body methods.
  • Reorganizes the article to include support in read and compose modes.

Related PR: DefinitelyTyped/DefinitelyTyped#72518

Copy link
Contributor

Learn Build status updates of commit 64b753d:

💡 Validation status: suggestions

File Status Preview URL Details
docs/outlook/insert-data-in-the-body.md 💡Suggestion View Details
docs/toc.yml ✅Succeeded View

docs/outlook/insert-data-in-the-body.md

  • Line 39, Column 239: [Suggestion: learn-site-link-broken - See documentation] Link '/javascript/api/outlook/office.mailboxenums.bodymode' points to a learn site page that doesn't exist. Check the path or URL and update the link.
  • Line 226, Column 292: [Suggestion: learn-site-link-broken - See documentation] Link '/javascript/api/outlook/office.mailboxenums.bodymode' points to a learn site page that doesn't exist. Check the path or URL and update the link.

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:

Copy link
Contributor

Learn Build status updates of commit 1653b7b:

💡 Validation status: suggestions

File Status Preview URL Details
docs/outlook/insert-data-in-the-body.md 💡Suggestion View Details
docs/toc.yml ✅Succeeded View

docs/outlook/insert-data-in-the-body.md

  • Line 39, Column 239: [Suggestion: learn-site-link-broken - See documentation] Link '/javascript/api/outlook/office.mailboxenums.bodymode' points to a learn site page that doesn't exist. Check the path or URL and update the link.
  • Line 226, Column 292: [Suggestion: learn-site-link-broken - See documentation] Link '/javascript/api/outlook/office.mailboxenums.bodymode' points to a learn site page that doesn't exist. Check the path or URL and update the link.

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:

Copy link
Contributor

Learn Build status updates of commit 13eb556:

💡 Validation status: suggestions

File Status Preview URL Details
docs/outlook/insert-data-in-the-body.md 💡Suggestion View Details
docs/toc.yml ✅Succeeded View

docs/outlook/insert-data-in-the-body.md

  • Line 39, Column 239: [Suggestion: learn-site-link-broken - See documentation] Link '/javascript/api/outlook/office.mailboxenums.bodymode' points to a learn site page that doesn't exist. Check the path or URL and update the link.
  • Line 226, Column 292: [Suggestion: learn-site-link-broken - See documentation] Link '/javascript/api/outlook/office.mailboxenums.bodymode' points to a learn site page that doesn't exist. Check the path or URL and update the link.

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:

@samantharamon samantharamon marked this pull request as ready for review May 30, 2025 00:51
@samantharamon samantharamon requested a review from Copilot May 30, 2025 00:51
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates the Outlook body API documentation to introduce and document the new bodyMode option for both getAsync and setAsync methods, and reorganizes the article to reflect read and compose scenarios.

  • Adds a new "Get or set body" entry to the TOC and removes a duplicate
  • Renames and extends the insert-data-in-the-body.md article with sections for getting and setting the body, including bodyMode behavior
  • Adds related links in the "See also" section

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
docs/toc.yml Added and deduped the "Get or set body" TOC entry
docs/outlook/insert-data-in-the-body.md Renamed file title, updated content to document bodyMode in get/set sections and expanded examples
Comments suppressed due to low confidence (1)

docs/toc.yml:819

  • The indentation of the new TOC entry for "Get or set body" should match its sibling items. Align the - name and href lines to the same indent level as other entries under the same parent.
-    - name: Get or set body

Copy link
Contributor

Learn Build status updates of commit 48f5652:

💡 Validation status: suggestions

File Status Preview URL Details
docs/outlook/insert-data-in-the-body.md 💡Suggestion View Details
docs/toc.yml ✅Succeeded View

docs/outlook/insert-data-in-the-body.md

  • Line 39, Column 239: [Suggestion: learn-site-link-broken - See documentation] Link '/javascript/api/outlook/office.mailboxenums.bodymode' points to a learn site page that doesn't exist. Check the path or URL and update the link.
  • Line 226, Column 292: [Suggestion: learn-site-link-broken - See documentation] Link '/javascript/api/outlook/office.mailboxenums.bodymode' points to a learn site page that doesn't exist. Check the path or URL and update the link.

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:

Copy link
Contributor

Learn Build status updates of commit 41fe4cc:

💡 Validation status: suggestions

File Status Preview URL Details
docs/outlook/insert-data-in-the-body.md 💡Suggestion View Details
docs/toc.yml ✅Succeeded View

docs/outlook/insert-data-in-the-body.md

  • Line 39, Column 239: [Suggestion: learn-site-link-broken - See documentation] Link '/javascript/api/outlook/office.mailboxenums.bodymode' points to a learn site page that doesn't exist. Check the path or URL and update the link.
  • Line 226, Column 292: [Suggestion: learn-site-link-broken - See documentation] Link '/javascript/api/outlook/office.mailboxenums.bodymode' points to a learn site page that doesn't exist. Check the path or URL and update the link.

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:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants