﻿---
title: Email output plugin v4.1.0
description: Plugin version: v4.1.0, Released on: 2018-01-15, Changelog. For other versions, see the overview list. To learn more about Logstash, see the Logstash...
url: https://docs-v3-preview.elastic.dev/elastic/logstash-docs-md/tree/main/vpr/v4-1-0-plugins-outputs-email
---

# Email output plugin v4.1.0
- Plugin version: v4.1.0
- Released on: 2018-01-15
- [Changelog](https://github.com/logstash-plugins/logstash-output-email/blob/v4.1.0/CHANGELOG.md)

For other versions, see the [overview list](https://docs-v3-preview.elastic.dev/elastic/logstash-docs-md/tree/main/vpr/output-email-index).
To learn more about Logstash, see the [Logstash Reference](https://www.elastic.co/guide/en/logstash/current/index.html).

## Getting help

For questions about the plugin, open a topic in the [Discuss](http://discuss.elastic.co) forums. For bugs or feature requests, open an issue in [Github](https://github.com/logstash-plugins/logstash-output-email). For the list of Elastic supported plugins, please consult the [Elastic Support Matrix](https://www.elastic.co/support/matrix#matrix_logstash_plugins).

## Description

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

## Usage Example

```
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
    }
  }
}
```


## Email Output Configuration Options

This plugin supports the following configuration options plus the [Common options](#v4.1.0-plugins-outputs-email-common-options) described later.

| Setting                                                                          | Input type                                                                    | Required |
|----------------------------------------------------------------------------------|-------------------------------------------------------------------------------|----------|
| [`address`](#v4.1.0-plugins-outputs-email-address)`address`                      | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string    | No       |
| [`attachments`](#v4.1.0-plugins-outputs-email-attachments)`attachments`          | [array](/elastic/logstash-docs-md/tree/main/lsr/value-types#array)array       | No       |
| [`authentication`](#v4.1.0-plugins-outputs-email-authentication)`authentication` | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string    | No       |
| [`body`](#v4.1.0-plugins-outputs-email-body)`body`                               | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string    | No       |
| [`cc`](#v4.1.0-plugins-outputs-email-cc)`cc`                                     | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string    | No       |
| [`bcc`](#v4.1.0-plugins-outputs-email-bcc)`bcc`                                  | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string    | No       |
| [`contenttype`](#v4.1.0-plugins-outputs-email-contenttype)`contenttype`          | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string    | No       |
| [`debug`](#v4.1.0-plugins-outputs-email-debug)`debug`                            | [boolean](/elastic/logstash-docs-md/tree/main/lsr/value-types#boolean)boolean | No       |
| [`domain`](#v4.1.0-plugins-outputs-email-domain)`domain`                         | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string    | No       |
| [`from`](#v4.1.0-plugins-outputs-email-from)`from`                               | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string    | No       |
| [`htmlbody`](#v4.1.0-plugins-outputs-email-htmlbody)`htmlbody`                   | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string    | No       |
| [`password`](#v4.1.0-plugins-outputs-email-password)`password`                   | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string    | No       |
| [`port`](#v4.1.0-plugins-outputs-email-port)`port`                               | [number](/elastic/logstash-docs-md/tree/main/lsr/value-types#number)number    | No       |
| [`replyto`](#v4.1.0-plugins-outputs-email-replyto)`replyto`                      | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string    | No       |
| [`subject`](#v4.1.0-plugins-outputs-email-subject)`subject`                      | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string    | No       |
| [`to`](#v4.1.0-plugins-outputs-email-to)`to`                                     | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string    | Yes      |
| [`use_tls`](#v4.1.0-plugins-outputs-email-use_tls)`use_tls`                      | [boolean](/elastic/logstash-docs-md/tree/main/lsr/value-types#boolean)boolean | No       |
| [`username`](#v4.1.0-plugins-outputs-email-username)`username`                   | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string    | No       |
| [`via`](#v4.1.0-plugins-outputs-email-via)`via`                                  | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string    | No       |
| [`template_file`](#v4.1.0-plugins-outputs-email-template_file)`template_file`    | [path](/elastic/logstash-docs-md/tree/main/lsr/value-types#path)path          | No       |

Also see [Common options](#v4.1.0-plugins-outputs-email-common-options) for a list of options supported by all output plugins.

### `address`

- Value type is [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)
- Default value is `"localhost"`

The address used to connect to the mail server

### `attachments`

- Value type is [array](/elastic/logstash-docs-md/tree/main/lsr/value-types#array)
- Default value is `[]`

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

### `authentication`

- Value type is [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)
- There is no default value for this setting.

Authentication method used when identifying with the server

### `body`

- Value type is [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)
- Default value is `""`

Body for the email - plain text only.

### `cc`

- Value type is [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#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`

- Value type is [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#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`

- Value type is [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#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](/elastic/logstash-docs-md/tree/main/lsr/value-types#boolean)
- Default value is `false`

Run the mail relay in debug mode

### `domain`

- Value type is [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#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`

- Value type is [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)
- Default value is `"logstash.alert@example.com"`

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

### `htmlbody`

- Value type is [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)
- Default value is `""`

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

### `password`

- Value type is [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)
- There is no default value for this setting.

Password to authenticate with the server

### `port`

- Value type is [number](/elastic/logstash-docs-md/tree/main/lsr/value-types#number)
- Default value is `25`

Port used to communicate with the mail server

### `replyto`

- Value type is [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)
- There is no default value for this setting.

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

### `subject`

- Value type is [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)
- Default value is `""`

Subject: for the email.

### `to`

- This is a required setting.
- Value type is [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#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`

- Value type is [boolean](/elastic/logstash-docs-md/tree/main/lsr/value-types#boolean)
- Default value is `false`

Enables TLS when communicating with the server

### `username`

- Value type is [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)
- There is no default value for this setting.

Username to authenticate with the server

### `via`

- Value type is [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)
- Default value is `"smtp"`

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

### `template_file`

- Value type is [path](/elastic/logstash-docs-md/tree/main/lsr/value-types#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

These configuration options are supported by all output plugins:

| Setting                                                                       | Input type                                                                    | Required |
|-------------------------------------------------------------------------------|-------------------------------------------------------------------------------|----------|
| [`codec`](#v4.1.0-plugins-outputs-email-codec)`codec`                         | [codec](/elastic/logstash-docs-md/tree/main/lsr/value-types#codec)codec       | No       |
| [`enable_metric`](#v4.1.0-plugins-outputs-email-enable_metric)`enable_metric` | [boolean](/elastic/logstash-docs-md/tree/main/lsr/value-types#boolean)boolean | No       |
| [`id`](#v4.1.0-plugins-outputs-email-id)`id`                                  | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string    | No       |


### `codec`

- Value type is [codec](/elastic/logstash-docs-md/tree/main/lsr/value-types#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`

- Value type is [boolean](/elastic/logstash-docs-md/tree/main/lsr/value-types#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`

- Value type is [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#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"
  }
}
```