PRTG Manual: Microsoft 365 Mailbox Sensor

The Microsoft 365 Mailbox sensor monitors a folder of a Microsoft 365 mailbox.

Microsoft 365 Mailbox Sensor

Microsoft 365 Mailbox Sensor

i_square_cyanFor a detailed list and descriptions of the channels that this sensor can show, see section Channel List.

Sensor in Other Languages

  • Dutch: Microsoft 365 Mailbox
  • French: Microsoft 365 Mailbox
  • German: Microsoft 365 Mailbox
  • Japanese: Microsoft 365 Mailbox
  • Portuguese: Microsoft 365 Mailbox
  • Russian: Microsoft 365 Mailbox
  • Simplified Chinese: Microsoft 365 Mailbox
  • Spanish: Microsoft 365 Mailbox

Remarks

Detailed Requirements

Requirement

Description

Secure HTTPS server

This sensor requires that the PRTG web server accepts incoming HTTPS requests.

i_square_cyanFor more information, see section PRTG Web Server in chapter User Interface.

Permission for the APIs

This sensor requires the following delegated permissions to query data from Microsoft Graph:

  • Microsoft Graph / User.Read
  • Microsoft Graph / Mail.Read
  • Microsoft Graph / Mail.Read.Shared (optional)
  • Microsoft Graph / offline_access

i_square_cyanFor more information, see the Knowledge Base: How do I obtain credentials and set permissions for the Microsoft 365 Mailbox sensor?

Redirect URIs

This sensor requires that you provide the DNS name or an IP address of your PRTG web server as redirect URI in the Microsoft Azure Portal according the following pattern: https://<yourprtgserver>/ms365.htm

i_round_blueMicrosoft Azure only accepts redirect URIs that start with HTTPS.

i_square_cyanFor more information, see the Knowledge Base: How do I obtain credentials and set permissions for the Microsoft 365 Mailbox sensor?

Add Sensor

The Add Sensor dialog appears when you manually add a new sensor to a device. It only shows the settings that are required to create the sensor. You can change nearly all settings on the sensor's Settings tab after creation.

PRTG performs a meta-scan before you can add this sensor and requires basic information in advance. Provide the required information in the dialog box that appears. PRTG then recognizes all items that are available for monitoring based on your input.

Step 1: Microsoft 365 Mailbox

Setting

Description

Shared Mailbox User Principal Name (optional)

Optionally enter the user principal name of a shared mailbox to which the authenticated user account has access. Leave the field empty to use the mailbox of the authenticated user account.

Step 2: Microsoft 365 Specific

Setting

Description

Folder

Select the folders that you want to monitor. PRTG creates one sensor for each folder that you select.

i_round_blueEnable check boxes in front of the respective lines to select the items. Use the check box in the table header to select all items or to cancel the selection. In large tables, use the search function in the upper-right corner.

Basic Sensor Settings

Click the Settings tab of a sensor to change its settings.

Basic Sensor Settings

Basic Sensor Settings

Setting

Description

Sensor Name

Enter a name to identify the sensor.

Parent Tags

Shows tags that the sensor inherits from its parent device, parent group, and parent probe.

i_round_blueThis setting is for your information only. You cannot change it.

Tags

Enter one or more tags. Confirm each tag with the Spacebar key, a comma, or the Enter key. You can use tags to group objects and use tag-filtered views later on. Tags are not case-sensitive. Tags are automatically inherited.

i_round_blueIt is not possible to enter tags with a leading plus (+) or minus (-) sign, nor tags with parentheses (()) or angle brackets (<>).

i_round_blueFor performance reasons, it can take some minutes until you can filter for new tags that you added.

The sensor has the following default tags that are automatically predefined in the sensor's settings when you add the sensor:

  • mailsensor
  • microsoft365
  • microsoft365sensor

Priority

Select a priority for the sensor. This setting determines the position of the sensor in lists. The highest priority is at the top of a list. Choose from the lowest priority (i_priority_1) to the highest priority (i_priority_5).

i_round_blueUsually, a sensor connects to the IP Address/DNS Name of the parent device. See the device settings for details. For some sensors, you can explicitly define the monitoring target in the sensor settings.

Microsoft 365 Specific

Microsoft 365 Specific

Microsoft 365 Specific

Setting

Description

Folder Name

Shows the name of the target folder that this sensor monitors.

i_round_bluePRTG shows this value for reference purposes only. If you need to change this value, add the sensor anew.

Folder Path

Shows the path of the target folder that this sensor monitors.

i_round_bluePRTG shows this value for reference purposes only. If you need to change this value, add the sensor anew.

Microsoft OAuth 2.0 Specific

Microsoft OAuth 2.0 Specific

Microsoft OAuth 2.0 Specific

Setting

Description

Authorization

Click Renew to start the Microsoft Azure authorization process.

Microsoft 365 Mailbox

Microsoft 365 Mailbox

Microsoft 365 Mailbox

Setting

Description

Shared Mailbox User Principal Name (optional)

Shows the user principal name of a shared mailbox to which the authenticated user account has access.

i_round_bluePRTG shows this value for reference purposes only. If you need to change this value, add the sensor anew.

Microsoft 365 Settings

Microsoft 365 Settings

Microsoft 365 Settings

Setting

Description

Filter by 'Subject'

Select if you want to filter the emails by their subject. Choose between:

  • Disable (default): Do not use Filter by 'Subject'.
  • Equals: Filter emails whose subject equals the defined string.
  • Contains all: Filter emails whose subject contains all defined strings.
  • Contains any: Filter emails whose subject contains at least one of the defined strings.

i_round_blueIf you enable Filter by 'Subject', Filter by 'From', or Filter by 'Body', the sensor creates three additional channels that monitor the emails that match your filters.

i_round_blueIf you disable the filters, the additional channels remain, but do not receive data anymore.

Search for

Enter a string that you want to use for Filter by 'Subject'.

i_round_blueIf you select Contains all or Contains any above, you can also enter a comma-separated list of strings to search for more than one string. For example, if you select Contains all and enter backup and failed, the sensor counts all items that contain both strings. If you select Contains any and enter backup and failed, the sensor counts all items that contain at least one of the strings.

Filter by 'From'

Select if you want to filter the 'From' field of the emails. Choose between:

  • Disable (default): Do not use Filter by 'From'.
  • Equals: Filter emails whose 'From' field equals the defined string.
  • Contains all: Filter emails whose 'From' field contains all defined strings.
  • Contains any: Filter emails whose 'From' field contains at least one of the defined strings.

i_round_blueIf you enable Filter by 'Subject', Filter by 'From', or Filter by 'Body', the sensor creates three additional channels that monitor the emails that match your filters.

i_round_blueIf you disable the filters, the additional channels remain, but do not receive data anymore.

Search for

Enter a string that you want to use for Filter by 'From'.

i_round_blueIf you select Contains all or Contains any above, you can also enter a comma-separated list of strings to search for more than one string. For example, if you select Contains all and enter backup and failed, the sensor counts all items that contain both strings. If you select Contains any and enter backup and failed, the sensor counts all items that contain at least one of the strings.

Filter by 'Body'

Select if you want to filter the emails by their body. Choose between:

  • Disable (default): Do not use Filter by 'Body'.
  • Equals: Filter emails whose body equals the defined string.
  • Contains all: Filter emails whose body contains all defined strings.
  • Contains any: Filter emails whose body contains at least one of the defined strings.

i_round_blueIf you enable Filter by 'Subject', Filter by 'From', or Filter by 'Body', the sensor creates three additional channels that monitor the emails that match your filters.

i_round_blueIf you disable the filters, the additional channels remain, but do not receive data anymore.

Search for

Enter a string that you want to use for Filter by 'Body'.

i_round_blueIf you select Contains all or Contains any above, you can also enter a comma-separated list of strings to search for more than one string. For example, if you select Contains all and enter backup and failed, the sensor counts all items that contain both strings. If you select Contains any and enter backup and failed, the sensor counts all items that contain at least one of the strings.

Filter by 'Age'

Select if you want to filter the emails by their age. The filter will be applied to all channels of the sensor.

Maximum Age (Minutes)

Enter the maximum age in minutes. The sensor only processes emails that are younger. Enter an integer.

Sensor Display

Sensor Display

Sensor Display

Setting

Description

Primary Channel

Select a channel from the list to define it as the primary channel. In the device tree, the last value of the primary channel is always displayed below the sensor's name. The available options depend on what channels are available for this sensor.

i_round_blueYou can set a different primary channel later by clicking b_channel_primary below a channel gauge on the sensor's Overview tab.

Graph Type

Define how different channels are shown for this sensor:

  • Show channels independently (default): Show a graph for each channel.
  • Stack channels on top of each other: Stack channels on top of each other to create a multi-channel graph. This generates a graph that visualizes the different components of your total traffic.
    i_round_redYou cannot use this option in combination with manual Vertical Axis Scaling (available in the channel settings).

Stack Unit

This setting is only visible if you enable Stack channels on top of each other as Graph Type. Select a unit from the list. All channels with this unit are stacked on top of each other. By default, you cannot exclude single channels from stacking if they use the selected unit. However, there is an advanced procedure to do so.

Debug Options

Debug Options

Debug Options

Setting

Description

Result Handling

Define what PRTG does with the sensor result:

  • Discard result: Do not store the sensor result.
  • Store result: Store the last sensor result in the \Logs\sensors subfolder of the PRTG data directory on the probe system. The file name is Result of Sensor [ID].log. This setting is for debugging purposes. PRTG overwrites this file with each scanning interval.

i_podThis option is not available when the sensor runs on the hosted probe of a PRTG Hosted Monitor instance.

i_round_blueIn a cluster, PRTG stores the result in the PRTG data directory of the master node.

Inherited Settings

By default, all of these settings are inherited from objects that are higher in the hierarchy. We recommend that you change them centrally in the root group settings if necessary. To change a setting for this object only, click b_inherited_enabled under the corresponding setting name to disable the inheritance and to display its options.

i_square_cyanFor more information, see section Inheritance of Settings.

Scanning Interval

i_round_blueThe minimum scanning interval of this sensor is 30 seconds.

i_round_blueThe recommended scanning interval of this sensor is 10 minutes.

Scanning Interval

Scanning Interval

i_square_cyanFor more information, see section Root Group Settings, section Scanning Interval.

Schedules, Dependencies, and Maintenance Window

i_round_blueYou cannot interrupt the inheritance for schedules, dependencies, and maintenance windows. The corresponding settings from the parent objects are always active. However, you can define additional schedules, dependencies, and maintenance windows. They are active at the same time as the parent objects' settings.

Schedules, Dependencies, and Maintenance Window

Schedules, Dependencies, and Maintenance Window

i_square_cyanFor more information, see section Root Group Settings, section Schedules, Dependencies, and Maintenance Window.

Access Rights

Access Rights

Access Rights

i_square_cyanFor more information, see section Root Group Settings, section Access Rights.

Channel Unit Configuration

i_round_blueWhich channel units are available depends on the sensor type and the available parameters. If no configurable channels are available, this field shows No configurable channels.

Channel Unit Configuration

Channel Unit Configuration

i_square_cyanFor more information, see section Root Group Settings, section Channel Unit Configuration.

Channel List

i_round_blueWhich channels the sensor actually shows might depend on the target device, the available components, and the sensor setup.

Channel

Description

Downtime

In the channel table on the Overview tab, this channel never shows any values. PRTG uses this channel in graphs and reports to show the amount of time in which the sensor was in the Down status in percent.

Matching Emails

The number of emails that match the defined filters

i_round_blueThis channel will only be created if you enable Filter by 'Subject', Filter by 'From', or Filter by 'Body'.

Newest Email

The age of the newest email

Newest Matching Email

The age of the newest email that matches the defined filters

i_round_blueThis channel will only be created if you enable Filter by 'Subject', Filter by 'From', or Filter by 'Body'.

Number of Emails

The number of emails

i_round_blueThis channel is the primary channel by default.

Oldest Email

The age of the oldest email

Oldest Matching Email

The age of the oldest email that matches the defined filters

i_round_blueThis channel will only be created if you enable Filter by 'Subject', Filter by 'From', or Filter by 'Body'.

More

i_square_blueKnowledge Base

How do I obtain credentials and set permissions for the Microsoft 365 Mailbox sensor?

What security features does PRTG include?