- Version: 4.0.3
- Released on: 2016-08-04
- Changelog
- Compatible: 5.1.1.1, 5.0.0, 2.4.1, 2.4.0, 2.3.4
This plugin does not ship with Logstash by default, but it is easy to install by running bin/logstash-plugin install logstash-output-email.
Send email when an output is received. Alternatively, you may include or exclude the email output execution using conditionals.
Synopsis
editThis plugin supports the following configuration options:
Required configuration options:
email {
to => ...
}
Available configuration options:
| Setting | Input type | Required | Default value |
|---|---|---|---|
No |
|
||
No |
|
||
No |
|||
No |
|
||
No |
|||
No |
|
||
No |
|
||
No |
|
||
No |
|
||
No |
|
||
No |
|||
No |
|
||
No |
|||
No |
|||
No |
|
||
No |
|||
No |
|
||
Yes |
|||
No |
|
||
No |
|||
No |
|
||
<<,>> |
No |
|
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
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:
"[email protected], [email protected]"
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.
contenttype
edit- 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)
enable_metric
edit- Value type is boolean
-
Default value is
true
Disable or enable metric logging for this specific plugin instance by default we record all the metrics we can, but you can disable metrics collection for a specific plugin.
from
edit- Value type is string
-
Default value is
"[email protected]"
The fully-qualified email address for the From: field in the email.
htmlbody
edit- Value type is string
-
Default value is
""
HTML Body for the email, which may contain HTML markup.
id
edit- Value type is string
- There is no default value for this setting.
Add a unique ID to the plugin instance, this ID is used for tracking
information for a specific configuration of the plugin.
output {
stdout {
id => "ABC"
}
}
If you don’t explicitely set this variable Logstash will generate a unique name.
password
edit- Value type is string
- There is no default value for this setting.
Password to authenticate with the server
replyto
edit- Value type is string
- There is no default value for this setting.
The fully qualified email address for the Reply-To: field.
to
edit- 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:
"[email protected], [email protected]"
You can also use dynamic fields from the event with the %{fieldname} syntax.
use_tls
edit- Value type is boolean
-
Default value is
false
Enables TLS when communicating with the server
username
edit- Value type is string
- There is no default value for this setting.
Username to authenticate with the server