PRTG Manual: Microsoft 365 Mailbox Sensor

Permission for the APIs

This sensor requires permissions for Microsoft Graph.

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 a redirect URI in the Microsoft Azure Portal. You must 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?

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.

Credentials

This sensor requires credentials for Microsoft 365.

IPv6

This sensor supports IPv6.

Performance impact

This sensor has a low performance impact.

Scanning interval

• The minimum scanning interval of this sensor is 30 seconds.
• The recommended scanning interval of this sensor is 10 minutes.

Knowledge Base

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

Folder Name

The name of the target folder that this sensor monitors.

Folder Path

The path of the target folder that this sensor monitors.

Authorization

Click Renew to start the Microsoft Azure authorization process.

Shared Mailbox User Principal Name (optional)

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

In most cases, the user principal name is the email address of the shared mailbox.

Filter by 'Subject'

Select if you want to filter the emails by the 'Subject' field:

• Disable (default): Do not use Filter by 'Subject'.
• 'Subject' matches exact string: Filter emails whose 'Subject' field matches the defined string exactly.
• 'Subject' contains all strings: Filter emails whose 'Subject' field contains all defined strings.
• 'Subject' contains one or more strings: Filter emails whose 'Subject' field contains at least one of the defined strings.
• 'Subject' matches regular expression: Filter emails whose 'Subject' field matches the defined regular expression.

The regular expressions filter will result in the Down status if there are more than 10,000 emails in the mailbox folder you want to monitor. This is because the regular expression filter is applied after the emails are retrieved from the API. The larger the volume of emails, the greater the impact on performance. Enable the Filter by 'Age' setting or use a non-regular expression filter in addition to the regular expression filter to reduce the number of emails.

If you enable Filter by 'Subject', Filter by 'From', or Filter by 'Body', the sensor creates up to 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

This setting is only visible if you choose to filter by the 'Subject' field above.

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

If you select 'Subject' contains all strings or 'Subject' contains one or more strings above, you can also enter a comma-separated list of strings to search for more than one string. For example, if you select 'Subject' contains all strings and enter backup and failed, the sensor counts all items that contain both strings. If you select 'Subject' contains one or more strings 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 emails by the 'From' field:

• Disable (default): Do not use Filter by 'From'.
• 'From' matches exact string: Filter emails whose 'From' field matches the defined string exactly.
• 'From' contains all strings: Filter emails whose 'From' field contains all defined strings.
• 'From' contains one or more strings: Filter emails whose 'From' field contains at least one of the defined strings.
• 'From' matches regular expression: Filter emails whose 'From' field matches the defined regular expression.

The regular expressions filter will result in the Down status if there are more than 10,000 emails in the mailbox folder you want to monitor. This is because the regular expression filter is applied after the emails are retrieved from the API. The larger the volume of emails, the greater the impact on performance. Enable the Filter by 'Age' setting or use a non-regular expression filter in addition to the regular expression filter to reduce the number of emails.

If you enable Filter by 'Subject', Filter by 'From', or Filter by 'Body', the sensor creates up to 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

This setting is only visible if you choose to filter by the 'From' field above.

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

If you select 'From' contains all strings or 'From' contains one or more strings above, you can also enter a comma-separated list of strings to search for more than one string. For example, if you select 'From' contains all strings and enter backup and failed, the sensor counts all items that contain both strings. If you select 'From' contains one or more strings 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 the text in the 'Body' field:

• Disable (default): Do not use Filter by 'Body'.
• 'Body' matches exact string: Filter emails whose body matches the defined string exactly.
• 'Body' contains all strings: Filter emails whose body contains all defined strings.
• 'Body' contains one or more strings: Filter emails whose body contains at least one of the defined strings.
• 'Body' matches regular expression: Filter emails whose body matches the defined regular expression.

The regular expressions filter will result in the Down status if there are more than 10,000 emails in the mailbox folder you want to monitor. This is because the regular expression filter is applied after the emails are retrieved from the API. The larger the volume of emails, the greater the impact on performance. Enable the Filter by 'Age' setting or use a non-regular expression filter in addition to the regular expression filter to reduce the number of emails.

If you enable Filter by 'Subject', Filter by 'From', or Filter by 'Body', the sensor creates up to 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

This setting is only visible if you choose to filter by the 'Body' field above.

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

If you select 'Body' contains all strings or 'Body' contains one or more strings above, you can also enter a comma-separated list of strings to search for more than one string. For example, if you select 'Body' contains all strings and enter backup and failed, the sensor counts all items that contain both strings. If you select 'Body' contains one or more strings 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)

This setting is only visible if you enable Filter by 'Age' above.

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, PRTG displays the last value of the primary channel 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 this sensor shows different channels:

• 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 select Stack channels on top of each other above.

Select a unit from the list. PRTG stacks all channels with this unit 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 (default): Do not store the sensor result.
• Store result: Store the sensor result and the last response 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.

Matching Emails

The number of emails that match the defined filters

This channel is only 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 is only 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 is only created if you enable Filter by 'Subject', Filter by 'From', or Filter by 'Body'.