Service Response Monitor › Test Management › Create Tests › IMAP Tests

IMAP Tests

The IMAP test monitors the amount of time required to log into a user account and download messages from the IMAP server. The IMAP protocol enables selective filtering and searching through mailboxes by using the SEARCH command.

Options and Arguments

IMAP tests require the following specific options and arguments:

• IMAP Server. The hostname of the IMAP mail server.

  Note: As of Service Availability r2.1 IPv6 addresses can be used, but they must be embedded in brackets, for example [0aff::230:6eff:fe4b:51db]:8080. Here 0aff::230:6eff:fe4b:51db represents the IPv6 address and 8080 represents the port number.

• IMAP Port. (Optional) The port on which the IMAP service is running. The default is 143.
• User Name. A valid user name for a test IMAP account on this server. Do not use an active mailbox; create a test account instead.
• Password. A valid password for the user account. SRM stores the password in encrypted form.
• Download. Select one of the following:
  • Download First Message – This option downloads only the first message for this user account.
  • Download All Messages – This option downloads all messages for this user account.
• Delete Downloaded Messages. (Optional) Select the check box to delete the messages that were downloaded during the test, or leave it blank to leave the messages on the test system.

  Note: If you use the Download All Messages option and if the download fails, delete some portion of the number of messages in the test mailbox and try the test again.

Specify these options and arguments when you create or modify tests.

Example

Use this example to create a test that downloads all messages for the IMAPuser account at imapserver.yourdomain once every 300 seconds and deletes them after downloading them. The test waits up to 10 seconds for a successful response and calculates response time and availability statistics over the last 7200 seconds (2 hours).

To create a new test in a policy

1. Click + (New) on the Test Monitors toolbar.

   The New test pane appears.

2. From the Test Type list, select IMAP.
3. In the Description field, specify IMAP_Test.
4. In the Test Name field, specify Test IMAP Service.
5. In the Test Interval field, specify 300.
6. In the Test Timeout field, specify 10.
7. In the Samples Per Interval field, specify 1.
8. In the Statistics Window field, specify 7200.
9. In the IMAP Server field, enter imapserver.yourdomain.
10. In the IMAP Port field, accept the default of 143.
11. In the User Name field, specify IMAPuser@server.domain.
12. In the Password field, specify IMAP123.
13. In the Download field, select Download All Messages.
14. Select Delete Downloaded Messages.
15. Accept defaults for all other fields.
16. Click Save Test.

When you commit your changes, SRM adds an entry similar to the following to the svcrsp.cf file:

{ 
index=60 
type=imap
desc="IMAP_Test." 
dest="imapserver.yourdomain.com:143" 
args="download=Download All Messages&delete=true" 
username="IMAPuser@server.domain" 
encoded=yes 
password="c4nrxzw" 
interval=300 
samples=1 
timeout=10 
window=7200 
tos=0 
limit=0 
status=active 
name="Test IMAP Service"
class=""
context=""
flags="1"
loglevel=1
}

For information about errors you may encounter when running IMAP tests, see IMAP Test Error Codes.