IMAP Sensor

<< Click to Display Table of Contents >>

Navigation:  Sensors > Email Sensors >

IMAP Sensor

The IMAP Sensor checks the proper function of IMAP services.

 

Sensor Tasks

Test Sensor

Tests the current sensor settings.

Get Help

Opens the ServerSentinel online help for the current sensor.

Basic Settings

Name

The name of the sensor (max. 100 characters). Choose a meaningful name to clearly identify the sensor.

Sensor is Active

Toggles the sensor ON/OFF.

Check Interval

The interval or times at which which the sensor should perform its checks.

Simple

The sensor performs its checks every x time units, e.g. every 10 minutes.

Daily

The sensor performs its checks daily at one or more (max. 4) fixed times, e.g. daily at 0 and 12 o'clock.

Weekly

The sensor performs its checks at certain days of the weeks at one or more (max. 4) fixed times, e.g. monday to friday at 12 o'clock.

Monthly

The sensor performs its checks at certain days of the month at one or more (max. 4) fixed times, e.g. every 1st of the month at 12 o'clock.

Only check if this Sensor didn't fail

This sensor will only be checked, if the sensor in the drop down list didn't fail.

Further Information

Comment

Short additional information to the sensor (max. 255 characters).

IMAP Options

Host

The IP address or DNS name of the incoming mail server. (max. 1024 characters)

Port

Port of the incoming mail server.

Encryption

Encryption to use for the communication.

Check the mailbox

If this checkbox is checked, the sensor will try to access the mailbox. If it is unchecked, the sensor will just try to establish a connection.

Credentials

Here you can either select an existing credential set or create a new one by inserting a display name, an username and a password.

IMAP Folder

IMAP Folder which should be watched (max. 255 characters).

 

Meta Data Values

Data Value

Data Type

Description

Checktime

Date

The time the dataset has been created.

Exception Message

String

The message of the error if any occurred.

Response Time

Integer

The response time needed to perform the check.

Status

String

A status string that may contain arbitrary information that was collected by the sensor (max. 255 characters). Per default this value is empty.

Status Flag

Enum

The status of the sensor after the check has been performed.

Data Values

Data Value

Data Type

Description

Folter Quota Root

String

Quota root name. This value is not saved to the database.

Max. Messages for Folder

Integer

Gets maximum allowed messages count. Return -1 if maximum messages quota is not defined.

Max. Storage for Folder

Integer

Gets maximum allowed storage. Return -1 if maximum storage quota is not defined.

Messages in Folder

Integer

Gets current message count.

No. of unread Messages

Integer

The number of unseen messages in the selected folder.

Storage used for Folder

Integer

Gets current storage.

Subscribed Folders

String

List of folders that the account is subscribed to. (max. 512 chars)

Total Size of Messages

Integer

The total size of the messages in the selected folder.