logstash-docs-md
Loading

Imap input plugin v3.0.4

  • Plugin version: v3.0.4
  • Released on: 2017-08-15
  • Changelog

For other versions, see the overview list.

To learn more about Logstash, see the Logstash Reference.

Getting help

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.

Description

Read mails from IMAP server

Periodically scan an IMAP folder (INBOX by default) and move any read messages to the trash.

This plugin supports the following configuration options plus the Common options described later.

Setting Input type Required
check_interval number No
content_type string No
delete boolean No
expunge boolean No
fetch_count number No
folder string No
host string Yes
lowercase_headers boolean No
password password Yes
port number No
secure boolean No
strip_attachments boolean No
user string Yes
verify_cert boolean No

Also see Common options for a list of options supported by all input plugins.

  • Value type is number
  • Default value is 300

content_type

  • Value type is string
  • Default value is "text/plain"

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

  • Value type is boolean
  • Default value is false
  • Value type is boolean
  • Default value is false
  • Value type is number
  • Default value is 50
  • Value type is string
  • Default value is "INBOX"
  • This is a required setting.
  • Value type is string
  • There is no default value for this setting.
  • Value type is boolean
  • Default value is true
  • This is a required setting.
  • Value type is password
  • There is no default value for this setting.
  • Value type is number
  • There is no default value for this setting.
  • Value type is boolean
  • Default value is true
  • Value type is boolean
  • Default value is false
  • This is a required setting.
  • Value type is string
  • There is no default value for this setting.
  • Value type is boolean
  • Default value is true

These configuration options are supported by all input plugins:

Setting Input type Required
add_field hash No
codec codec No
enable_metric boolean No
id string No
tags array No
type string No
  • Value type is hash
  • Default value is {}

Add a field to an event

  • Value type is 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.

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

  • 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 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"
  }
}
  • Value type is array
  • There is no default value for this setting.

Add any number of arbitrary tags to your event.

This can help with processing later.

  • Value type is 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.