<%NUMBERING1%>.<%NUMBERING2%>.<%NUMBERING3%> PRTG Manual: Microsoft 365 Mailbox Sensor

Secure HTTPS server

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

For 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

For 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

Microsoft Azure only accepts redirect URIs that start with HTTPS.

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

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.

Folder

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

Enable 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.

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.

This 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.

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

For 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 () to the highest priority ().

Folder Name

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

PRTG 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.

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

Authorization

Click Renew to start the Microsoft Azure authorization process.

Shared Mailbox User Principal Name (optional)

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

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

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.

If 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.

If 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'.

If 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.

If 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.

If 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'.

If 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.

If 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.

If 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'.

If 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.

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.

You can set a different primary channel later by clicking 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.
  You 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.

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.

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

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

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

This 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

This 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

This 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

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