survivor: Mailfe Check Module

SURVIVOR: `mailfe` Check Module
About `mailfe` Dependencies Arguments Description Examples
About `mailfe`
basics |
Module Type | Scheduler | Remote
check | Yes | No
syntax |
         module mailfe {
           [protocol (imap | imaps)]
           username <relation>
           password <password>
           [wait <number>]
           [expunge <boolean>]
           [imaphost <string>]
         }
### Dependencies Perl Modules `Mail::IMAPClent` `Mail::Send` ### Arguments
Name | Type | Value
protocol | optional string, either 'imap' or 'imaps', default is 'imaps' | Whether to use IMAP over port 143 or IMAP-SSL over port 993.
username | string | Username for IMAP login.
password | password | Password for IMAP login.
wait | optional number, default is 2 | Time in seconds to wait after the message is sent before checking that it was delivered.
expunge | optional boolean, default is true | Whether or not to permanently delete test messages after retrieval.
imaphost | optional string, default is host being checked | The IMAP host from which to retrieve the test message, if different from the host being checked.
1. ### Description The `mailfe` module module sends an email through the host being checked (the "frontend") and waits a specified time. It then connects to an IMAP server (through the same server, unless an IMAP host is passed in the optional parameter), logs in, and attempts to receive the message, in order to determine if the frontend is operating as expected. It will also expunge the received message, if desired. Only IMAP and IMAP-SSL are supported currently. IMAP-TLS is not supported. See also the `mailbe` check module. ### Examples To retrieve from the host being cheked and not expunge after retrieval:
            module mailfe {
              username bob
              password pw
              expunge false
            }
2. To retrieve from `imap.example.com` over non-SSL IMAP:
            module mailfe {
              protocol imap
              username alice
              password pw
              imaphost imap.example.com
            }
$Date: 2006/11/19 20:19:46 $ $Revision: 0.3 $ | keywords expunge imaphost password protocol username wait