email

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

 

Synopsis

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

 

address

  • Value type is string
  • Default value is "localhost"

The address used to connect to the mail server

attachments

  • Value type is array
  • Default value is []

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

authentication

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

Authentication method used when identifying with the server

body

  • Value type is string
  • Default value is ""

Body for the email - plain text only.

cc

  • 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

  • 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.

contenttype

  • Value type is string
  • Default value is "text/html; charset=UTF-8"

contenttype : for multipart messages, set the content-type and/or charset of the HTML part. NOTE: this may not be functional (KH)

debug

  • Value type is boolean
  • Default value is false

Run the mail relay in debug mode

domain

  • Value type is string
  • Default value is "localhost"

Domain used to send the email messages

from

  • Value type is string
  • Default value is "logstash.alert@nowhere.com"

The fully-qualified email address for the From: field in the email.

htmlbody

  • Value type is string
  • Default value is ""

HTML Body for the email, which may contain HTML markup.

password

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

Password to authenticate with the server

port

  • Value type is number
  • Default value is 25

Port used to communicate with the mail server

replyto

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

The fully qualified email address for the Reply-To: field.

subject

  • Value type is string
  • Default value is ""

Subject: for the email.

to

  • This is a required setting.
  • Value type is string
  • There is no default value for this setting.

The fully-qualified email address to send the email to.

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

You can also use dynamic fields from the event with the %{fieldname} syntax.

use_tls

  • Value type is boolean
  • Default value is false

Enables TLS when communicating with the server

username

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

Username to authenticate with the server

via

  • Value type is string
  • Default value is "smtp"

How Logstash should send the email, either via SMTP or by invoking sendmail.

workers

  • Value type is number
  • Default value is 1

The number of workers to use for this output. Note that this setting may not be useful for all outputs.