Email output plugin
editEmail output plugin
edit- Plugin version: v4.1.1
- Released on: 2018-04-06
- Changelog
For other versions, see the Versioned plugin docs.
Getting Help
editFor questions about the plugin, open a topic in the Discuss forums. For bugs or feature requests, open an issue in Github. For the list of Elastic supported plugins, please consult the Elastic Support Matrix.
Description
editSends email when an output is received. Alternatively, you may include or exclude the email output execution using conditionals.
Usage Example
editoutput { if "shouldmail" in [tags] { email { to => 'technical@example.com' from => 'monitor@example.com' subject => 'Alert - %{title}' body => "Tags: %{tags}\\n\\Content:\\n%{message}" template_file => "/tmp/email_template.mustache" domain => 'mail.example.com' port => 25 } } }
Email Output Configuration Options
editThis plugin supports the following configuration options plus the Common Options described later.
Setting | Input type | Required |
---|---|---|
No |
||
No |
||
No |
||
No |
||
No |
||
No |
||
No |
||
No |
||
No |
||
No |
||
No |
||
No |
||
No |
||
No |
||
No |
||
Yes |
||
No |
||
No |
||
No |
||
No |
Also see Common Options for a list of options supported by all output plugins.
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:
"me@example.com, you@example.com"
bcc
edit- Value type is string
- There is no default value for this setting.
The fully-qualified email address(es) to include as bcc: address(es).
This field accepts several addresses like cc.
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)
domain
edit- Value type is string
-
Default value is
"localhost"
The HELO/EHLO domain name used in the greeting message when connecting to a remote SMTP server. Some servers require this name to match the actual hostname of the connecting client.
from
edit- Value type is string
-
Default value is
"logstash.alert@example.com"
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.
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:
"me@example.com, you@example.com"
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
via
edit- Value type is string
-
Default value is
"smtp"
How Logstash should send the email, either via SMTP or by invoking sendmail.
template_file
edit- Value type is path
- There is no default value for this setting.
Path of a [Mustache templating](https://mustache.github.io/) file used for email templating. See example in test fixture.
Can be used with body
to send multi-part emails. Takes precedence over htmlBody
.
Common Options
editThe following configuration options are supported by all output plugins:
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.
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.
id
edit- Value type is string
- There is no default value for this setting.
Add a unique ID
to the plugin configuration. If no ID is specified, Logstash will generate one.
It is strongly recommended to set this ID in your configuration. This is particularly useful
when you have two or more plugins of the same type. For example, if you have 2 email outputs.
Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.
output { email { id => "my_plugin_id" } }