survivor: Imap Check Module

SURVIVOR: `imap` Check Module
About `imap` Dependencies Arguments Description Examples
About `imap`
basics |
Module Type | Scheduler | Remote
check | Yes | No
syntax |
         module imap {
           [protocol (imap | imaps)]
           username <string>
           password <password>
           [select <boolean>]
         }
### Dependencies Perl Modules `Mail::IMAPClient` Version 2.2.7 is known to work. ### Arguments
Name | Type | Value
protocol | optional string, either 'imap' or 'imaps', default is 'imap' | Whether to use IMAP over port 143 or IMAP-SSL over port 993.
username | string | Username to use for login.
password | password | Password to use for login.
select | optional boolean, default true | Whether or not to `SELECT` INBOX.
1. ### Description The `imap` module connects to an IMAP server, logs in, and, optionally, opens INBOX, in order to determine if the server is returning expected results. Only IMAP and IMAP-SSL are supported currently. IMAP-TLS is not supported. ### Examples To login but not select INBOX:
            module imap {
              username bob
              password pw
              select false
            }
2. To login via IMAP-SSL:
            module imap {
              protocol imaps
              username alice
              password pw
            }
$Date: 2006/11/19 19:10:14 $ $Revision: 0.6 $ | keywords password protocol select username