Imap input plugin

  • Plugin version: v3.0.6
  • Released on: 2018-04-06
  • Changelog

For other versions, see theVersioned plugin docs.

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 messagesto the trash.

Imap Input Configuration Options

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

Also see Common Options for a list of options supported by allinput plugins.

 

check_interval

  • 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 thiscontent-type as the event message.

delete

  • Value type is boolean
  • Default value is false

expunge

  • Value type is boolean
  • Default value is false

fetch_count

  • Value type is number
  • Default value is 50

folder

  • Value type is string
  • Default value is "INBOX"

host

  • This is a required setting.
  • Value type is string
  • There is no default value for this setting.

lowercase_headers

  • Value type is boolean
  • Default value is true

password

  • This is a required setting.
  • Value type is password
  • There is no default value for this setting.

port

  • Value type is number
  • There is no default value for this setting.

secure

  • Value type is boolean
  • Default value is true

strip_attachments

  • Value type is boolean
  • Default value is false

user

  • This is a required setting.
  • Value type is string
  • There is no default value for this setting.

verify_cert

  • Value type is boolean
  • Default value is true

Common Options

The following 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

Details

 

add_field

  • Value type is hash
  • Default value is {}

Add a field to an event

codec

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

enable_metric

  • Value type is boolean
  • Default value is true

Disable or enable metric logging for this specific plugin instanceby default we record all the metrics we can, but you can disable metrics collectionfor a specific plugin.

id

  • 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 usefulwhen 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
  • 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
  • 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 canalso use the type to search for it in Kibana.

If you try to set a type on an event that already has one (forexample when you send an event from a shipper to an indexer) thena new input will not override the existing type. A type set atthe shipper stays with that event for its life evenwhen sent to another Logstash server.