Office.Diagnostics interface

Provides diagnostic information to an Outlook add-in.

Remarks

Minimum permission level: ReadItem

Applicable Outlook mode: Compose or Read

Properties

hostName

Gets a string that represents the name of the host application.

A string that can be one of the following values: Outlook, OutlookWebApp, OutlookIOS, or OutlookAndroid.

Note: The Outlook value is returned for Outlook on desktop clients (i.e., Windows and Mac).

hostVersion

Gets a string that represents the version of either the host application or the Exchange Server (e.g., "15.0.468.0").

If the mail add-in is running in Outlook on a desktop or mobile client, the hostVersion property returns the version of the host application, Outlook. In Outlook on the web, the property returns the version of the Exchange Server.

OWAView

Gets a string that represents the current view of Outlook on the web.

The returned string can be one of the following values: OneColumn, TwoColumns, or ThreeColumns.

If the host application is not Outlook on the web, then accessing this property results in undefined.

Outlook on the web has three views that correspond to the width of the screen and the window, and the number of columns that can be displayed:

  • OneColumn, which is displayed when the screen is narrow. Outlook on the web uses this single-column layout on the entire screen of a smartphone.

  • TwoColumns, which is displayed when the screen is wider. Outlook on the web uses this view on most tablets.

  • ThreeColumns, which is displayed when the screen is wide. For example, Outlook on the web uses this view in a full screen window on a desktop computer.

Property Details

hostName

Gets a string that represents the name of the host application.

A string that can be one of the following values: Outlook, OutlookWebApp, OutlookIOS, or OutlookAndroid.

Note: The Outlook value is returned for Outlook on desktop clients (i.e., Windows and Mac).

hostName: string;

Property Value

string

Remarks

Minimum permission level: ReadItem

Applicable Outlook mode: Compose or Read

hostVersion

Gets a string that represents the version of either the host application or the Exchange Server (e.g., "15.0.468.0").

If the mail add-in is running in Outlook on a desktop or mobile client, the hostVersion property returns the version of the host application, Outlook. In Outlook on the web, the property returns the version of the Exchange Server.

hostVersion: string;

Property Value

string

Remarks

Minimum permission level: ReadItem

Applicable Outlook mode: Compose or Read

OWAView

Gets a string that represents the current view of Outlook on the web.

The returned string can be one of the following values: OneColumn, TwoColumns, or ThreeColumns.

If the host application is not Outlook on the web, then accessing this property results in undefined.

Outlook on the web has three views that correspond to the width of the screen and the window, and the number of columns that can be displayed:

  • OneColumn, which is displayed when the screen is narrow. Outlook on the web uses this single-column layout on the entire screen of a smartphone.

  • TwoColumns, which is displayed when the screen is wider. Outlook on the web uses this view on most tablets.

  • ThreeColumns, which is displayed when the screen is wide. For example, Outlook on the web uses this view in a full screen window on a desktop computer.

OWAView: MailboxEnums.OWAView | "OneColumn" | "TwoColumns" | "ThreeColumns";

Property Value

Office.MailboxEnums.OWAView | "OneColumn" | "TwoColumns" | "ThreeColumns"

Remarks

Minimum permission level: ReadItem

Applicable Outlook mode: Compose or Read