IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

› ›

email

edit

email

edit

Send email when an output is received. Alternatively, you may include or exclude the email output execution using conditionals.

Synopsis

edit

This plugin supports the following configuration options:

Required configuration options:

email {
    to => ...
}

Available configuration options:

Setting	Input type	Required	Default value
`address`	string	No	`"localhost"`
`attachments`	array	No	`[]`
`authentication`	string	No
`body`	string	No	`""`
`cc`	string	No
`codec`	codec	No	`"plain"`
`contenttype`	string	No	`"text/html; charset=UTF-8"`
`debug`	boolean	No	`false`
`domain`	string	No	`"localhost"`
`from`	string	No	`"logstash.alert@nowhere.com"`
`htmlbody`	string	No	`""`
`password`	string	No
`port`	number	No	`25`
`replyto`	string	No
`subject`	string	No	`""`
`to`	string	Yes
`use_tls`	boolean	No	`false`
`username`	string	No
`via`	string	No	`"smtp"`
`workers`	number	No	`1`

Details

edit

`address`

edit

Value type is string
Default value is "localhost"

The address used to connect to the mail server

`attachments`

edit

Value type is array
Default value is []

Attachments - specify the name(s) and location(s) of the files.

`authentication`

edit

Value type is string
There is no default value for this setting.

Authentication method used when identifying with the server

`body`

edit

Value type is string
Default value is ""

Body for the email - plain text only.

`cc`

edit

Value type is string
There is no default value for this setting.

The fully-qualified email address(es) to include as cc: address(es).

This field also accepts a comma-separated string of addresses, for example: "me@host.com, you@host.com"

`codec`

edit

Value type is codec
Default value is "plain"

The codec used for output data. Output codecs are a convenient method for encoding your data before it leaves the output, without needing a separate filter in your Logstash pipeline.