.. _scm_email:

#####
email
#####

Email plugin for scm which sends emails based on client status.

Description
===========

The email plugin sends emails to configured receipients if a client status
messages passes the configured :confval:`filter <memailplugin.filter>`.

Plugin
======

The email plugin is installed under :file:`share/plugins/monitor/memailplugin.so`.

To add the plugin to :ref:`scm`, add it to the plugin list:

.. code-block:: sh

   plugins = ${plugins}, memailplugin


Examples
========

An example configuration looks like this:

.. code-block:: sh

   # Send notification is a clients CPU usage exceeds 100 percent
   memailplugin.filter = "cpuusage>100"

   # Send emails, yes
   memailplugin.sendEmail = true

   # Send emails to this address(es)
   memailplugin.recipients = operator@my-agency.org, operator2@my-agency.org

   memailplugin.reportSilentClients = false

   # Minutes before report missing clients
   memailplugin.reportRequiredClients = 1

   # Interval to calculate mean of the message values for (in minutes)
   memailplugin.filterMeanInterval = 1

   # List of clients we definitely require to be operative
   memailplugin.requiredClients = scautopick, scautoloc, scevent, scamp,\
                                  scmag, scqc, scevtlog

.. _scm_email_configuration:

Configuration
=============


.. confval:: memailplugin.recipients

   Type: *list:string*

   Defines a comma separated list of email addresses to send
   notifications to.


.. confval:: memailplugin.template

   Type: *string*

   Configures a custom message text that is appended to each message
   when clients passed the filter.


.. confval:: memailplugin.filter

   Type: *string*

   Defines the filter for each client status. A filter is an expression
   that can be constructed with all available status tags \(scm \-\-print\-tags\)
   and logical and numerical operators. See scm for more information.


.. confval:: memailplugin.requiredClients

   Type: *list:string*

   *No description available*

.. confval:: memailplugin.reportSilentClients

   Type: *boolean*

   Default is ``true``.

.. confval:: memailplugin.reportSilentClientsTimeSpan

   Type: *double*

   Unit: *min*

   Default is ``1``.

.. confval:: memailplugin.reportRequiredClients

   Type: *double*

   Unit: *min*

   Default is ``10``.

.. confval:: memailplugin.filterMeanInterval

   Type: *double*

   Unit: *min*

   Default is ``10``.

.. confval:: memailplugin.sendEmail

   Type: *boolean*

   Enables sending of emails using mailx shell command.
   Default is ``false``.