PRTG Manual: Microsoft 365 Mailbox Sensor
The Microsoft 365 Mailbox sensor monitors a folder of a Microsoft 365 mailbox via Microsoft Graph.
For a detailed list and descriptions of the channels that this sensor can show, see section Channel List.
- Dutch: Microsoft 365 Mailbox
- French: Boîte aux lettres Microsoft 365
- 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
- This sensor requires permissions for Microsoft Graph.
- This sensor requires that you provide a redirect URI in the Microsoft Azure Portal.
- This sensor requires that the PRTG web server accepts incoming HTTPS requests.
- This sensor requires credentials for Microsoft 365 in settings that are higher in the object hierarchy.
- This sensor supports IPv6.
- This sensor has a low performance impact.
- Knowledge Base: How do I obtain credentials and set permissions for the Microsoft 365 Mailbox sensor?
Requirement |
Description |
---|---|
This sensor requires the following delegated permissions to query data from Microsoft Graph:
For more information, see the Knowledge Base: How do I obtain credentials and set permissions for the Microsoft 365 Mailbox sensor? |
|
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? |
|
This sensor requires that the PRTG web server accepts incoming HTTPS requests. For more information, see section PRTG Web Server in chapter User Interface. |
Setting |
Description |
---|---|
Sensor Name |
Enter a name to identify the sensor. By default, PRTG shows this name in the device tree, as well as in alarms, logs, notifications, reports, maps, libraries, and tickets. If the name contains angle brackets (<>), PRTG replaces them with braces ({}) for security reasons. For more information, see the Knowledge Base: What security features does PRTG include? |
Parent Tags |
The 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:
|
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 (). |
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
Setting |
Description |
---|---|
Authorization |
Click Renew to start the Microsoft Azure authorization process. |
Setting |
Description |
---|---|
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. |
Setting |
Description |
---|---|
Filter by 'Subject' |
Select if you want to filter the emails by the 'Subject' field:
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:
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:
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. |
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. 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:
|
Stack Unit |
This setting is only visible if you select Stack channels on top of each other above. 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. |
Setting |
Description |
---|---|
Result Handling |
Define what PRTG does with the sensor result:
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. |
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 under the corresponding setting name to disable the inheritance and to display its options.
For more information, see section Inheritance of Settings.
The minimum scanning interval of this sensor is 30 seconds.
The recommended scanning interval of this sensor is 10 minutes.
For more information, see section Root Group Settings, section Scanning Interval.
Schedules, Dependencies, and Maintenance Window
You 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.
For more information, see section Root Group Settings, section Schedules, Dependencies, and Maintenance Window (default).
For more information, see section Root Group Settings, section Access Rights.
Which 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.
For more information, see section Root Group Settings, section Channel Unit Configuration.
Which 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 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'. |
KNOWLEDGE 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?