Office.MailboxEnums.BodyMode enum

Remarks

Applicable Outlook mode: Message Compose

Important: This enum is only supported in Outlook on the web, on mobile devices (starting in Version 4.2538.0), and in the new Outlook on Windows.

In Outlook on the web and the new Outlook on Windows, users can organize their messages as conversations or individual messages in Settings > Mail > Layout > Message organization. This user setting affects the portion of the body of a message that's displayed. The BodyMode enum supports the following message organization settings on these clients.

• Conversations: Group messages by conversation > All messages from the selected conversation or Show email grouped by conversation > Newest on top/Newest on bottom

• Individual messages: Do not group messages > Only a single message or Show email as individual messages

For more information, see Change how the message list is displayed in Outlook.

Examples

// Get the body of the message based on the user's setting for message organization.
Office.context.mailbox.item.body.getAsync(
  Office.CoercionType.Html,
  { bodyMode: Office.MailboxEnums.BodyMode.HostConfig },
  (bodyResult) => {
    if (bodyResult.status === Office.AsyncResultStatus.Failed) {
      console.log(`Failed to get body: ${bodyResult.error.message}`);
      return;
    }

    const body = bodyResult.value;
  }
);

Fields