For other versions, see theVersioned plugin docs.
For 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.
Sends email when an output is received. Alternatively, you may include orexclude the email output execution using conditionals.
output { 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 } }}
This 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 alloutput plugins.
"localhost"The address used to connect to the mail server
[]Attachments - specify the name(s) and location(s) of the files.
Authentication method used when identifying with the server
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"
The fully-qualified email address(es) to include as bcc: address(es).
This field accepts several addresses like cc.
"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)
"localhost"The HELO/EHLO domain name used in the greeting message when connectingto a remote SMTP server. Some servers require this name to match theactual hostname of the connecting client.
"logstash.alert@example.com"The fully-qualified email address for the From: field in the email.
""HTML Body for the email, which may contain HTML markup.
Password to authenticate with the server
The fully qualified email address for the Reply-To: field.
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.
Username to authenticate with the server
"smtp"How Logstash should send the email, either via SMTP or by invoking sendmail.
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.
The following configuration options are supported by all output plugins:
"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.
trueDisable or enable metric logging for this specific plugin instance.By default we record all the metrics we can, but you can disable metrics collectionfor a specific plugin.
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 usefulwhen 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" }}