While PvMail is the name of the Python package, the executable installed in <python>/bin is called pvMail using a command line such as:
PvMail was built to watch (monitor) an EPICS PV and send an email when the value of that PV changes from 0 to 1.
The PV being watched (that triggers the sending of the email) can be any EPICS record type or field that results in a value of 0 (zero) that changes to 1 (one). This includes these EPICS records (and possibly more): ai, ao, bi, bo, calcout, scalcout, swait, ...
When an event causes an email to be triggered, PvMail will retrieve the value of another PV that is the first part of the message to be sent. Additional metadata will be appended to the message.
Email is sent using a call to the sendmail program on the native OS. This almost certainly precludes its use on Windows systems. The GUI or command-line versions will operate but likely no email is sent. Also, the host computer must allow and be configured for sending email to the intended recipients.
PvMail provides either a command-line interface or a graphical user interface. Both are accessed from the same command, using different command-line options. The command-line version is intended to run as a background program, it has no user interaction but logs all its output into a log file. The GUI version provides a screen to edit each of the parameters before the background process is started. It also provides buttons to start and stop the background process.
This documentation was built: October 18, 2013