======
PvMail
======

Watches an EPICS PV and sends email when value changes from 0 to 1.

.. icons: https://fonts.google.com/icons

.. grid:: 2

    .. grid-item-card:: :material-regular:`summarize;3em` :ref:`overview`
      :link: overview
      :link-type: doc

    .. grid-item-card:: :material-regular:`install_desktop;3em` :ref:`install`
      :link: install
      :link-type: doc

    .. grid-item-card:: :material-regular:`api;3em` :ref:`api`
      :link: pvMail/index
      :link-type: doc

    .. grid-item-card:: :material-regular:`school;3em` :ref:`glossary`
      :link: glossary
      :link-type: doc

.. note:: While *PvMail* is the name of the Python package,
   the executable is ``pvMail``.  Use a command line such as::

   $ pvMail

About
#####

:author:    Pete R. Jemian
:email:     jemian@anl.gov
:copyright: 2009-2024, UChicago Argonne, LLC
:license:   ANL OPEN SOURCE LICENSE (see *LICENSE*)
:docs:      https://BCDA-APS.github.io/pvMail/
:git:       https://github.com/BCDA-APS/pvMail
:PyPI:      https://pypi.python.org/pypi/PvMail
:version:   |version|
:release:   |release|
:published: |today|

.. toctree::
   :hidden:

   contents
   overview
   glossary
   install