Office.Diagnostics interface
Provides diagnostic information to an Outlook add-in.
Remarks
[Api set: Mailbox 1.1]
Minimum permission level: read item
Applicable Outlook mode: Compose or Read
Starting with Mailbox requirement set 1.5, you can also use the Office.context.diagnostics property to get similar information.
Properties
| ews | Gets an object to identify whether Exchange Web Services (EWS) callback tokens are supported in an organization. |
| host |
Gets a string that represents the type of Outlook client. The string can be one of the following values: |
| host |
Gets a string that represents the version of either the Outlook client or the Exchange Server (for example, "15.0.468.0"). If the mail add-in is running in Outlook on Windows (classic), on Mac, or on mobile devices, the |
| OWAView | Gets a string that represents the current view of Outlook on the web. The returned string can be one of the following values: If the 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:
|
Property Details
ews
Gets an object to identify whether Exchange Web Services (EWS) callback tokens are supported in an organization.
ews: Ews;Property Value
Remarks
[Api set: Mailbox 1.16]
Minimum permission level: read item
Applicable Outlook mode: Compose or Read
Important: Legacy Exchange Online user identity tokens and callback tokens are no longer supported and are turned off across all Microsoft 365 tenants. If an Outlook add-in requires delegated user access or user identity, we recommend using MSAL (Microsoft Authentication Library) and nested app authentication (NAA). Exchange user identity tokens are still supported for Exchange on-premises. For more information, see Nested app authentication FAQ.
hostName
Gets a string that represents the type of Outlook client.
The string can be one of the following values: Outlook, newOutlookWindows, OutlookWebApp, OutlookIOS, or OutlookAndroid.
hostName: string;Property Value
string
Remarks
[Api set: Mailbox 1.1]
Minimum permission level: read item
Applicable Outlook mode: Compose or Read
Important: The Outlook value is returned for Outlook on Windows (classic) and on Mac. newOutlookWindows is returned for new Outlook on Windows.
hostVersion
Gets a string that represents the version of either the Outlook client or the Exchange Server (for example, "15.0.468.0").
If the mail add-in is running in Outlook on Windows (classic), on Mac, or on mobile devices, the hostVersion property returns the version of the Outlook client. In Outlook on the web and new Outlook on Windows, the property returns the version of the Exchange Server.
hostVersion: string;Property Value
string
Remarks
[Api set: Mailbox 1.1]
Minimum permission level: read item
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 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
[Api set: Mailbox 1.1]
Minimum permission level: read item
Applicable Outlook mode: Compose or Read