﻿---
title: Imap input plugin v3.2.1
description: Plugin version: v3.2.1, Released on: 2023-10-03, 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/v3-2-1-plugins-inputs-imap
---

# Imap input plugin v3.2.1
- Plugin version: v3.2.1
- Released on: 2023-10-03
- [Changelog](https://github.com/logstash-plugins/logstash-input-imap/blob/v3.2.1/CHANGELOG.md)

For other versions, see the [overview list](https://docs-v3-preview.elastic.dev/elastic/logstash-docs-md/tree/main/vpr/input-imap-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-input-imap). For the list of Elastic supported plugins, please consult the [Elastic Support Matrix](https://www.elastic.co/support/matrix#matrix_logstash_plugins).

## Description

Read mails from IMAP server
Periodically scan an IMAP folder (`INBOX` by default) and move any read messages to the trash.

## Compatibility with the Elastic Common Schema (ECS)

The plugin includes sensible defaults that change based on [ECS compatibility mode](#v3.2.1-plugins-inputs-imap-ecs_compatibility). When ECS compatibility is disabled, mail headers and attachments are targeted at the root level. When targeting an ECS version, headers and attachments target `@metadata` sub-fields unless configured otherwise in order to avoid conflict with ECS fields. See [`headers_target`](#v3.2.1-plugins-inputs-imap-headers_target), and [`attachments_target`](#v3.2.1-plugins-inputs-imap-attachments_target).

## Imap Input Configuration Options

This plugin supports the following configuration options plus the [Common options](#v3.2.1-plugins-inputs-imap-common-options) described later.

| Setting                                                                                    | Input type                                                                       | Required |
|--------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------|----------|
| [`attachments_target`](#v3.2.1-plugins-inputs-imap-attachments_target)`attachments_target` | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string       | No       |
| [`check_interval`](#v3.2.1-plugins-inputs-imap-check_interval)`check_interval`             | [number](/elastic/logstash-docs-md/tree/main/lsr/value-types#number)number       | No       |
| [`content_type`](#v3.2.1-plugins-inputs-imap-content_type)`content_type`                   | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string       | No       |
| [`delete`](#v3.2.1-plugins-inputs-imap-delete)`delete`                                     | [boolean](/elastic/logstash-docs-md/tree/main/lsr/value-types#boolean)boolean    | No       |
| [`ecs_compatibility`](#v3.2.1-plugins-inputs-imap-ecs_compatibility)`ecs_compatibility`    | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string       | No       |
| [`expunge`](#v3.2.1-plugins-inputs-imap-expunge)`expunge`                                  | [boolean](/elastic/logstash-docs-md/tree/main/lsr/value-types#boolean)boolean    | No       |
| [`fetch_count`](#v3.2.1-plugins-inputs-imap-fetch_count)`fetch_count`                      | [number](/elastic/logstash-docs-md/tree/main/lsr/value-types#number)number       | No       |
| [`folder`](#v3.2.1-plugins-inputs-imap-folder)`folder`                                     | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string       | No       |
| [`headers_target`](#v3.2.1-plugins-inputs-imap-headers_target)`headers_target`             | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string       | No       |
| [`host`](#v3.2.1-plugins-inputs-imap-host)`host`                                           | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string       | Yes      |
| [`lowercase_headers`](#v3.2.1-plugins-inputs-imap-lowercase_headers)`lowercase_headers`    | [boolean](/elastic/logstash-docs-md/tree/main/lsr/value-types#boolean)boolean    | No       |
| [`password`](#v3.2.1-plugins-inputs-imap-password)`password`                               | [password](/elastic/logstash-docs-md/tree/main/lsr/value-types#password)password | Yes      |
| [`port`](#v3.2.1-plugins-inputs-imap-port)`port`                                           | [number](/elastic/logstash-docs-md/tree/main/lsr/value-types#number)number       | No       |
| [`save_attachments`](#v3.2.1-plugins-inputs-imap-save_attachments)`save_attachments`       | [boolean](/elastic/logstash-docs-md/tree/main/lsr/value-types#boolean)boolean    | No       |
| [`secure`](#v3.2.1-plugins-inputs-imap-secure)`secure`                                     | [boolean](/elastic/logstash-docs-md/tree/main/lsr/value-types#boolean)boolean    | No       |
| [`sincedb_path`](#v3.2.1-plugins-inputs-imap-sincedb_path)`sincedb_path`                   | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string       | No       |
| [`strip_attachments`](#v3.2.1-plugins-inputs-imap-strip_attachments)`strip_attachments`    | [boolean](/elastic/logstash-docs-md/tree/main/lsr/value-types#boolean)boolean    | No       |
| [`uid_tracking`](#v3.2.1-plugins-inputs-imap-uid_tracking)`uid_tracking`                   | [boolean](/elastic/logstash-docs-md/tree/main/lsr/value-types#boolean)boolean    | No       |
| [`user`](#v3.2.1-plugins-inputs-imap-user)`user`                                           | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string       | Yes      |
| [`verify_cert`](#v3.2.1-plugins-inputs-imap-verify_cert)`verify_cert`                      | [boolean](/elastic/logstash-docs-md/tree/main/lsr/value-types#boolean)boolean    | No       |

Also see [Common options](#v3.2.1-plugins-inputs-imap-common-options) for a list of options supported by all input plugins.

### `attachments_target`

- Value type is [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)
- Default value depends on whether [`ecs_compatibility`](#v3.2.1-plugins-inputs-imap-ecs_compatibility) is enabled:
  - ECS Compatibility disabled: `"[attachments]"`
- ECS Compatibility enabled: `"[@metadata][input]imap][attachments]"

The name of the field under which mail attachments information will be added, if [`save_attachments`](#v3.2.1-plugins-inputs-imap-save_attachments) is set.

### `check_interval`

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


### `content_type`

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

For multipart messages, use the first part that has this content-type as the event message.

### `delete`

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


### `ecs_compatibility`

- Value type is [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)
- Supported values are:
  - `disabled`: does not use ECS-compatible field names (for example, `From` header field is added to the event)
- `v1`, `v8`: avoids field names that might conflict with Elastic Common Schema (for example, the `From` header is added as metadata)
- Default value depends on which version of Logstash is running:
  - When Logstash provides a `pipeline.ecs_compatibility` setting, its value is used as the default
- Otherwise, the default value is `disabled`.

Controls this plugin’s compatibility with the [Elastic Common Schema (ECS)](https://www.elastic.co/guide/en/ecs/current). The value of this setting affects the *default* value of [`headers_target`](#v3.2.1-plugins-inputs-imap-headers_target) and [`attachments_target`](#v3.2.1-plugins-inputs-imap-attachments_target).

### `expunge`

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


### `fetch_count`

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


### `folder`

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


### `headers_target`

- Value type is [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)
- Default value depends on whether [`ecs_compatibility`](#v3.2.1-plugins-inputs-imap-ecs_compatibility) is enabled:
  - ECS Compatibility disabled: no default value (for example, the subject header is stored under the `"subject"` name)
- ECS Compatibility enabled: `"[@metadata][input][imap][headers]"`

The name of the field under which mail headers will be added.
Setting `headers_target => ''` skips headers processing and no header is added to the event. Except the date header, if present, which is always used as the event’s `@timestamp`.

### `host`

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


### `lowercase_headers`

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


### `password`

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


### `port`

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


### `save_attachments`

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

When set to true the content of attachments will be included in the `attachments.data` field.

### `secure`

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


### `sincedb_path`

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

Path of the sincedb database file (keeps track of the UID of the last processed mail) that will be written to disk. The default will write sincedb file to `<path.data>/plugins/inputs/imap` directory. NOTE: it must be a file path and not a directory path.

### `strip_attachments`

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


### `uid_tracking`

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

When the IMAP input plugin connects to the mailbox for the first time and the UID of the last processed mail is not yet known, the unread mails are first downloaded and the UID of the last processed mail is saved. From this point on, if `uid_tracking` is set to `true`, all new mail will be downloaded regardless of whether they are marked as read or unread. This allows users or other services to use the mailbox simultaneously with the IMAP input plugin. UID of the last processed mail is always saved regardles of the `uid_tracking` value, so you can switch its value as needed. In transition from the previous IMAP input plugin version, first process at least one mail with `uid_tracking` set to `false` to save the UID of the last processed mail and then switch `uid_tracking` to `true`.

### `user`

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


### `verify_cert`

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


## Common options

These configuration options are supported by all input plugins:

| Setting                                                                     | Input type                                                                    | Required |
|-----------------------------------------------------------------------------|-------------------------------------------------------------------------------|----------|
| [`add_field`](#v3.2.1-plugins-inputs-imap-add_field)`add_field`             | [hash](/elastic/logstash-docs-md/tree/main/lsr/value-types#hash)hash          | No       |
| [`codec`](#v3.2.1-plugins-inputs-imap-codec)`codec`                         | [codec](/elastic/logstash-docs-md/tree/main/lsr/value-types#codec)codec       | No       |
| [`enable_metric`](#v3.2.1-plugins-inputs-imap-enable_metric)`enable_metric` | [boolean](/elastic/logstash-docs-md/tree/main/lsr/value-types#boolean)boolean | No       |
| [`id`](#v3.2.1-plugins-inputs-imap-id)`id`                                  | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string    | No       |
| [`tags`](#v3.2.1-plugins-inputs-imap-tags)`tags`                            | [array](/elastic/logstash-docs-md/tree/main/lsr/value-types#array)array       | No       |
| [`type`](#v3.2.1-plugins-inputs-imap-type)`type`                            | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string    | No       |


### `add_field`

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

Add a field to an event

### `codec`

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

The codec used for input data. Input codecs are a convenient method for decoding your data before it enters the input, 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 imap inputs. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.
```
input {
  imap {
    id => "my_plugin_id"
  }
}
```


### `tags`

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

Add any number of arbitrary tags to your event.
This can help with processing later.

### `type`

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

Add a `type` field to all events handled by this input.
Types are used mainly for filter activation.
The type is stored as part of the event itself, so you can also use the type to search for it in Kibana.
If you try to set a type on an event that already has one (for example when you send an event from a shipper to an indexer) then a new input will not override the existing type. A type set at the shipper stays with that event for its life even when sent to another Logstash server.