# email — SeisComP Release documentation

6.9.0

# 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 `filter`.

## Plugin

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

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

    plugins = ${plugins}, memailplugin

## Examples

An example configuration looks like this:

    # 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

## Module Configuration

memailplugin.recipients

  Type: list:string

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

memailplugin.template

  Type: string

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

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.

memailplugin.requiredClients

  Type: list:string

  No description available

memailplugin.reportSilentClients

  Default: `true`

  Type: boolean

  No description available

memailplugin.reportSilentClientsTimeSpan

  Default: `1`

  Type: double

  Unit: min

  No description available

memailplugin.reportRequiredClients

  Default: `10`

  Type: double

  Unit: min

  No description available

memailplugin.filterMeanInterval

  Default: `10`

  Type: double

  Unit: min

  No description available

memailplugin.sendEmail

  Default: `false`

  Type: boolean

  Enables sending of emails using mailx shell command.