survivor: Mailbe Check Module

SURVIVOR: `mailbe` Check Module
About `mailbe` Dependencies Arguments Description Examples
About `mailbe`
basics |
Module Type | Scheduler | Remote
check | Yes | No
syntax |
         module mailbe {
           username <string>
           password <password>
           smtphost <string>
           [imapprot (imap | imaps)]
           [wait <number>]
           [expunge <boolean>]
         }
### Dependencies Perl Modules `Mail::IMAPClent` `Mail::Send` ### Arguments
Name | Type | Value
username | string | Username for IMAP login.
password | password | Password for IMAP login.
smtphost | string | Hostname through which to send mail.
imapprot | optional string, either 'imap' or 'imaps', default is 'imaps' | Whether to use IMAP over port 143 or IMAP-SSL over port 993.
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.
1. ### Description The `mailbe` module sends an email through an SMTP host, waits a specified time, connects to an IMAP server on the host being checked (the "backend"), logs in, and attempts to receive the message, in order to determine if the mail system is working as desired. 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 `mailfe` check module. ### Examples To relay through the host `send` and check via IMAP-SSL:
            module mailbe {
              username bob
              password pw
              smtphost send
            }
2. To relay through the host `smtp4`, wait 5 seconds, then check via IMAP:
            module mailbe {
              username alice
              password pw
              smtphost smtp4
              wait 5
              imapprot imap
            }
$Date: 2006/11/19 20:02:56 $ $Revision: 0.3 $ | keywords expunge imapprot password smtphost username wait