PRTG Manual: SMTP&IMAP Round Trip Sensor

The SMTP&IMAP Round Trip sensor monitors the time it takes for an email to reach an Internet Message Access Protocol (IMAP) mailbox using the Simple Mail Transfer Protocol (SMTP). It sends an email via the parent device (an SMTP server) and then scans a dedicated IMAP mailbox until the email arrives.

i_round_blueThe SMTP&IMAP Round Trip sensor automatically deletes these emails from the mailbox as soon as PRTG retrieves them. The emails only remain in the mailbox if a timeout or a restart of the PRTG core server occurs during sensor runtime.

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

SMTP&IMAP Round Trip Sensor

SMTP&IMAP Round Trip Sensor

Sensor in Other Languages

  • Dutch: SMTP & IMAP Round Trip
  • French: Durée de boucle SMTP&IMAP
  • German: SMTP&IMAP-Übermittlung
  • Japanese: SMTP & IMAP ラウンドトリップ
  • Portuguese: Percurso de ida e volta SMTP&IMAP
  • Russian: Цикл SMTP&IMAP
  • Simplified Chinese: SMTP 和 IMAP 往返
  • Spanish: Ida y vuelta SMTP&IMAP

Remarks

  • This sensor has a high performance impact. Use it with care. We recommend that you use no more than 200 sensors of this sensor type on each probe.
  • The parent device must be an SMTP server.
  • This sensor does not support Secure Remote Password (SRP) ciphers.
  • Use dedicated email accounts with this sensor. If you use more sensors of this type, make sure that each sensor uses its own email accounts.

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. Therefore, you do not see all settings in this dialog. You can change nearly all settings on the sensor's Settings tab after creation.

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

i_round_blueIf 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

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:

  • imapsensor
  • roundtrip
  • mailsensor

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

Email Settings

Email Settings

Email Settings

Setting

Description

From

Specify the email address of the email's sender. Enter a valid email address.

To

Specify the address that PRTG sends the emails to. Enter a valid email address.

i_round_blueYou can only enter one email address.

HELO Ident

Enter a server name for the HELO part of the mail protocol. For some mail servers, the HELO identifier must be the valid principal host domain name for the client host. For more information, see SMTP RFC 2821.

Step 1: Send Email Using Parent Device (SMTP Server)

i_round_blueIn this step, you configure how the sensor sends the emails. The sensor uses the IP Address/DNS Name of the parent device (an SMTP server).

Step 1: Send Email Using Parent Device (SMTP Server)

Step 1: Send Email Using Parent Device (SMTP Server)

Setting

Description

Port

Enter the number of the port that the sensor uses to send an email via SMTP. The default port for unsecure connections is 25 and the default ports for secure connections are 465 or 587. The actual setting depends on the server that you connect to. Enter an integer value.

i_round_blueWe recommend that you use the default value.

i_round_blueIf the connection is unsuccessful, try a different port number.

Timeout for SMTP Connection (Sec.)

Enter a timeout in seconds for the request. Enter an integer value. The maximum timeout value is 900 seconds (15 minutes).

i_round_blueIf the reply takes longer than this value, the sensor cancels the request and shows a corresponding error message.

SMTP Authentication Method

Define if you want to use authentication for the SMTP connection:

  • None: Do not use any authentication method.
  • User name and password: Authenticate against the SMTP server via user name and password.

User Name

This setting is only visible if you select User name and password above. Enter a user name for SMTP authentication. Enter a string.

Password

This setting is only visible if you select User name and password above. Enter a password for SMTP authentication. Enter a string.

Additional Text for Email Subject

PRTG automatically creates the subject part of the round trip email. The subject consists of the string PRTG Roundtrip Mail:, followed by a unique globally unique identifier (GUID) to correctly identify the email in the IMAP mailbox, for example, PRTG Roundtrip Mail: {5E858D9C-AC70-466A-9B2A-55630165D276}.

Use this field to place your custom text before the automatically created text.

Connection Security

Connection Security

Connection Security

Setting

Description

Transport-Level Security

Define how the sensor handles the security of the connection:

  • Use transport-level security if available using StartTLS (default): Try to connect to the server via a Secure Sockets Layer (SSL)/Transport Layer Security (TLS) secured connection and StartTLS. If the server does not support this, the sensor tries to connect without connection security.
  • Use transport-level security if available: Try to connect to the server via an SSL/TLS-secured connection. If the server does not support this, the sensor tries to connect without connection security.
  • Enforce transport-level security using StartTLS: Try to connect to the server via an SSL/TLS-secured connection and StartTLS. If the server does not support this, the sensor shows the Down status.
  • Enforce transport-level security: Try to connect to the server via an SSL/TLS-secured connection. If the server does not support this, the sensor shows the Down status.

i_round_blueIf the sensor connects to a server via StartTLS, the connection is first established without connection security. After the connection has been established, the sensor sends a certain command (StartTLS) over the unsecured connection to negotiate a secure connection via SSL/TLS.

i_round_blueIf the sensor does not use StartTLS, the negotiation of a secure connection happens immediately (implicitly) so that no commands are sent in unencrypted plain text. If no secure connection is possible, no communication takes place.

Step 2: Check an IMAP Mailbox until Email Arrives

i_round_blueIn this step, you configure how to receive the emails that the sensor sends.

Step 2: Check an IMAP Mailbox Until Email Arrives

Step 2: Check an IMAP Mailbox Until Email Arrives

Setting

Description

IP Address/DNS Name

Specify the IMAP server. Enter a valid IP address or Domain Name System (DNS) name.

Mailbox

Specify the IMAP mailbox that you want to check. Enter the IMAP mailbox or folder name, for example INBOX.

i_round_redThe IMAP mailbox or folder name must not match the sender of the email in the From field. Otherwise, the sensor might incorrectly interpret unsuccessful round trips as successful.

Port

Specify the port that the sensor uses for the IMAP connection. The default port for unsecure connections is 143 and the default port for secure connections is 993. The actual setting depends on the server you connect to.. Enter an integer value.

i_round_blueWe recommend that you use the default value.

i_round_blueIf the connection is unsuccessful, try a different port number.

Connection Interval (Sec.)

Enter the number of seconds the sensor waits between two connections to the IMAP server. PRTG repeatedly checks the mailbox in this scanning interval until the email arrives. Enter an integer value.

Maximum Trip Time (Sec.)

Enter the number of seconds an email may take to arrive in the IMAP mailbox. PRTG continuously checks the mailbox in this scanning interval until the email arrives. If it does not arrive within the maximum trip time, the sensor shows an error message. Enter an integer value.

User Name

Enter a user name for IMAP authentication. Enter a string.

Password

Enter a password for IMAP authentication. Enter a string.

i_round_redThe password must not contain spaces, percent signs (%), or the character combination !*.

Search Method

Define how to search for the round trip email in the mailbox:

  • Search for the email directly (default): Send a SEARCH command to directly find the round trip email on the IMAP server.
  • Search through all available emails: Search through all available emails in the mailbox locally to find the round trip email. This might take some time if you have many emails in your mailbox.

Connection Security

Connection Security

Connection Security

Setting

Description

Transport-Level Security

Define how the sensor handles the security of the connection:

  • Use transport-level security if available using StartTLS (default): Try to connect to the server via a Secure Sockets Layer (SSL)/Transport Layer Security (TLS) secured connection and StartTLS. If the server does not support this, the sensor tries to connect without connection security.
  • Use transport-level security if available: Try to connect to the server via an SSL/TLS-secured connection. If the server does not support this, the sensor tries to connect without connection security.
  • Enforce transport-level security using StartTLS: Try to connect to the server via an SSL/TLS-secured connection and StartTLS. If the server does not support this, the sensor shows the Down status.
  • Enforce transport-level security: Try to connect to the server via an SSL/TLS-secured connection. If the server does not support this, the sensor shows the Down status.

i_round_blueIf the sensor connects to a server via StartTLS, the connection is first established without connection security. After the connection has been established, the sensor sends a certain command (StartTLS) over the unsecured connection to negotiate a secure connection via SSL/TLS.

i_round_blueIf the sensor does not use StartTLS, the negotiation of a secure connection happens immediately (implicitly) so that no commands are sent in unencrypted plain text. If no secure connection is possible, no communication takes place.

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 names are Result of Sensor [ID].txt and Result of Sensor [ID].Data.txt. This setting is for debugging purposes. PRTG overwrites these files 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.

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.

Inherited Settings

By default, all of the following 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

Click b_inherited_enabled to interrupt the inheritance.

Scanning Interval

Scanning Interval

Setting

Description

Scanning Interval

Select a scanning interval from the dropdown list. The scanning interval determines the amount of time that the sensor waits between two scans. Choose from:

  • 30 seconds
  • 60 seconds
  • 5 minutes
  • 10 minutes
  • 15 minutes
  • 30 minutes
  • 1 hour
  • 4 hours
  • 6 hours
  • 12 hours
  • 24 hours

i_round_blueYou can change the available intervals in the system administration on PRTG on premises installations.

If a Sensor Query Fails

Select the number of scanning intervals that the sensor has time to reach and to check a device again if a sensor query fails. Depending on the option that you select, the sensor can try to reach and to check a device again several times before the sensor shows the Down status. This can avoid false alarms if the monitored device only has temporary issues. For previous scanning intervals with failed requests, the sensor shows the Warning status. Choose from:

  • Set sensor to down immediately: Set the sensor to the Down status immediately after the first request fails.
  • Set sensor to warning for 1 interval, then set to down (recommended): Set the sensor to the Warning status after the first request fails. If the second request also fails, the sensor shows the Down status.
  • Set sensor to warning for 2 intervals, then set to down: Set the sensor to the Down status only after the third request fails.
  • Set sensor to warning for 3 intervals, then set to down: Set the sensor to the Down status only after the fourth request fails.
  • Set sensor to warning for 4 intervals, then set to down: Set the sensor to the Down status only after the fifth request fails.
  • Set sensor to warning for 5 intervals, then set to down: Set the sensor to the Down status only after the sixth request fails.

i_round_blueSensors that monitor via Windows Management Instrumentation (WMI) always wait at least one scanning interval before they show the Down status. It is not possible to immediately set a WMI sensor to the Down status, so the first option does not apply to these sensors. All other options can apply.

i_round_blueIf you define error limits for a sensor's channels, the sensor immediately shows the Down status. None of the interval options apply.

i_round_blueIf a channel uses lookup values, the sensor immediately shows the Down status. None of the interval options apply.

Schedules, Dependencies, and Maintenance Windows

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 Windows

Schedules, Dependencies, and Maintenance Windows

Setting

Description

Schedule

Select a schedule from the list. You can use schedules to monitor during a certain time span (days or hours) every week. Choose from:

  • None
  • Saturdays
  • Sundays
  • Weekdays
  • Weekdays Eight-To-Eight (08:00 - 20:00)
  • Weekdays Nights (17:00 - 09:00)
  • Weekdays Nights (20:00 - 08:00)
  • Weekdays Nine-To-Five (09:00 - 17:00)
  • Weekends

i_round_blueYou can create schedules, edit schedules, or pause monitoring for a specific time span. For more information, see section Schedules.

Maintenance Window

Select if you want to set up a one-time maintenance window. During a maintenance window, monitoring stops for the selected object and all child objects. They show the Paused status instead. Choose between:

  • Do not set up a one-time maintenance window: Do not set up a one-time maintenance window. Monitoring is always active.
  • Set up a one-time maintenance window: Set up a one-time maintenance window and pause monitoring. You can define a time span for the pause below.

i_round_blueTo terminate an active maintenance window before the defined end date, change the time entry in Maintenance Ends to a date in the past.

Maintenance Begins

This setting is only visible if you enable Set up a one-time maintenance window above. Use the date time picker to enter the start date and time of the one-time maintenance window.

Maintenance Ends

This setting is only visible if you enable Set up a one-time maintenance window above. Use the date time picker to enter the end date and time of the one-time maintenance window.

Dependency Type

Select a dependency type. You can use dependencies to pause monitoring for an object depending on the status of a different object. You can choose from:

  • Use parent: Use the dependency type of the parent object.
  • Select a sensor: Use the dependency type of the parent object. Additionally, pause the current object if a specific sensor is in the Down status or in the Paused status because of another dependency.
  • Master sensor for parent: Make this sensor the master object for its parent device. The sensor influences the behavior of its parent device: If the sensor is in the Down status, the device is paused. For example, it is a good idea to make a Ping sensor the master object for its parent device to pause monitoring for all other sensors on the device in case the device cannot even be pinged. Additionally, the sensor is paused if the parent group is paused by another dependency.

i_round_blueTo test your dependencies, select Simulate Error Status from the context menu of an object that other objects depend on. A few seconds later, all dependent objects are paused. You can check all dependencies under Devices | Dependencies in the main menu bar.

Dependency

This setting is only visible if you enable Select a sensor above. Click b_search_light and use the object selector to select a sensor on which the current object will depend.

Dependency Delay (Sec.)

This setting is only visible if you enable Select a sensor above. Define a time span in seconds for the dependency delay.

After the master sensor for this dependency returns to the Up status, PRTG additionally delays the monitoring of the dependent objects by the time span you define. This can prevent false alarms, for example, after a server restart or to give systems more time for all services to start. Enter an integer value.

i_round_redThis setting is not available if you set this sensor to Use parent or to be the Master sensor for parent. In this case, define delays in the parent device settings or in its parent group settings.

Access Rights

Click b_inherited_enabled to interrupt the inheritance.

Access Rights

Access Rights

Setting

Description

User Group Access

Define the user groups that have access to the sensor. You see a table with user groups and group access rights. The table contains all user groups in your setup. For each user group, you can choose from the following group access rights:

  • Inherited: Inherit the access rights settings of the parent object.
  • No access: Users in this user group cannot see or edit the sensor. The sensor neither shows up in lists nor in the device tree.
  • Read access: Users in this group can see the sensor and view its monitoring results. They cannot edit any settings.
  • Write access: Users in this group can see the sensor, view its monitoring results, and edit its settings. They cannot edit its access rights settings.
  • Full access: Users in this group can see the sensor, view its monitoring results, edit its settings, and edit its access rights settings.

i_square_cyanFor more details on access rights, see section Access Rights Management.

Channel List

i_round_blueWhich channels the sensor actually shows might depend on the monitored 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.

Response Time (IMAP)

The response time of the IMAP server in milliseconds (msec)

Response Time (SMTP)

The response time of the SMTP server in msec

Total

The sum of the response time of the IMAP server and the SMTP server in msec

i_round_blueThis channel is the primary channel by default.

More

i_square_blueKNOWLEDGE BASE

What security features does PRTG include?

Sensor Settings Overview

For more information about sensor settings, see the following sections: