/ 
wubot-0.3.1-TRIAL
/ App::Wubot::Plugin::Mbox

NAME

App::Wubot::Plugin::Mbox - monitor an Mbox file

VERSION

version 0.3.1

SYNOPSIS

 ~/wubot/config/plugins/Mbox/inbox.yaml

---
delay: 60
path: /var/mail/wu

DESCRIPTION

This monitor uses Mail::MboxParser to monitor for new emails in an mbox. Each time a new email arrives in the mbox, a message will be sent containing:

subject: the email subject
username: the email 'from' field
cc: the email 'cc' field
to_user: the email 'to' field
date: the email 'date' field

CACHE

The Mbox monitor uses the global cache mechanism, so each time the check runs, it will update a file such as:

~/wubot/cache/Mbox-inbox.yaml

The monitor caches all message IDs in the feed. When a new (previously unseen) message id shows up on the feed, the message will be sent, and the cache will be updated. Removing the cache file will cause all items in the feed to be sent again.

SUBROUTINES/METHODS

check( $inputs )

The standard monitor check() method.