PRTG Manual: Microsoft 365 Mailbox Sensor

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

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 boîte aux lettres 
  • German: Microsoft 365 Postfach
  • Japanese: Microsoft 365 メールボックス
  • Portuguese: Caixa de correio do Microsoft 365
  • Russian: Почтовый ящик Microsoft 365
  • Simplified Chinese: Microsoft 365 邮箱
  • Spanish: Buzón de Microsoft 365

Remarks

Consider the following remarks and requirements for this sensor:

Remark

Description

Permission for the APIs

This sensor requires permissions for Microsoft Graph.

i_round_blueThis 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 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

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?

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.

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?

Basic Sensor Settings

Basic Sensor Settings

Basic Sensor Settings

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

  • mailsensor
  • microsoft365
  • microsoft365sensor

i_square_cyanFor more information about basic sensor settings, see section Sensor Settings.

Microsoft 365 Specific

Microsoft 365 Specific

Microsoft 365 Specific

Setting

Description

Folder Name

The name of the target folder that this sensor monitors.

Folder Path

The path of the target folder that this sensor monitors.

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)

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

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

Microsoft 365 Settings

Microsoft 365 Settings

Microsoft 365 Settings

Setting

Description

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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Debug Options

Debug Options

Debug Options

Setting

Description

Result Handling

Define what PRTG does with the sensor result:

  • Discard result (default): 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.

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

Matching Emails

The number of emails that match the defined filters

i_round_blueThis 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

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

More

i_square_blueKNOWLEDGE BASE

How can I provide feedback about PRTG and contribute to the PRTG development?

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

What security features does PRTG include?