In an Outlook addin, how to check whether we are in compose mode or read mode?

Question

I'm creating an outlook add-in and use the OfficeJS API in React app. In there I want to load a specific set of features for the compose mode and another set of features for the read mode. So my question is, how to see in which mode I'm currently on?

score 9 · Answer 1 · answered Sep 14 '18 at 02:11

I usually check for APIs to know the mode, if you don't want to create two separate landing pages for read and compose modes.

You can check for displayReplyForm API, this is a read mode API, so if this is undefined then you are in compose mode.

if (Office.context.mailbox.item.displayReplyForm != undefined) {
  // read mode
} else {
  // compose mode
}

score 5 · Accepted Answer · answered Sep 12 '18 at 15:50

In the manifest.xml file you should have different ExtensionPoint for compose and read view as follow ...

<ExtensionPoint xsi:type="MessageReadCommandSurface">
</ExtensionPoint>
<ExtensionPoint xsi:type="MessageComposeCommandSurface">
</ExtensionPoint>

Each of this sections have to have Action tag with ExecuteFunction or ShowTaskpane type. If you have ExecuteFunction type you just specify different function names for read and compose surface as follow ...

<ExtensionPoint xsi:type="MessageReadCommandSurface">
<Action xsi:type="ExecuteFunction">
    <FunctionName>FunctionSpecificToReadView</FunctionName>
</Action>
</ExtensionPoint>
<ExtensionPoint xsi:type="MessageComposeCommandSurface">
<Action xsi:type="ExecuteFunction">
    <FunctionName>FunctionSpecificToComposeView</FunctionName>
</Action>
</ExtensionPoint>

If you have ShowTaskpane type you would use different file names to load inside the frame or add some parameter if you use the same file as follow ...

<ExtensionPoint xsi:type="MessageReadCommandSurface">
<Action xsi:type="ShowTaskpane">
    <SourceLocation resid="readTaskPaneUrl" />
</Action>
</ExtensionPoint>
<ExtensionPoint xsi:type="MessageComposeCommandSurface">
<Action xsi:type="ShowTaskpane">
    <SourceLocation resid="composeTaskPaneUrl" />
</Action>
</ExtensionPoint>
...
<Resources>
<bt:Urls>
    <bt:Url id="readTaskPaneUrl" DefaultValue="https://localhost:44300/read.html"/>
    <bt:Url id="composeTaskPaneUrl" DefaultValue="https://localhost:44300/compose.html"/>
</bt:Urls>
</Resources>

Inside each HTML page you know what surface your add-in has been invoked.

score 0 · Answer 3 · edited Aug 04 '23 at 14:30

You need to get to email using Office Javascript API. If ToEmail is got, then you're in reply mode in Outlook.

Here's an example...

Office.initialize = function (reason) {


function getToRecipients() {

 Office.context.mailbox.item.to.getAsync(function (result) {

    if (result.status === Office.AsyncResultStatus.Succeeded) {

      var recipients = result.value;

      if (recipients && recipients.length > 0) {

        var toEmailAddresses = recipients.map(function (recipient) {

          return recipient.emailAddress;

        });

        console.log("To Email Addresses: ", toEmailAddresses[0]);

      }

    } else {

      console.error("Error getting 'To' recipients: ", result.error);}});}};

In an Outlook addin, how to check whether we are in compose mode or read mode?

3 Answers3

Linked