Imap input plugin v3.1.0edit

  • Plugin version: v3.1.0
  • Released on: 2020-05-27
  • Changelog

For other versions, see the overview list.

To learn more about Logstash, see the Logstash Reference.

Getting Helpedit

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.

Descriptionedit

Read mails from IMAP server

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

Imap Input Configuration Optionsedit

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

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

 

check_intervaledit

  • Value type is number
  • Default value is 300

content_typeedit

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

deleteedit

  • Value type is boolean
  • Default value is false

expungeedit

  • Value type is boolean
  • Default value is false

fetch_countedit

  • Value type is number
  • Default value is 50

folderedit

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

hostedit

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

lowercase_headersedit

  • Value type is boolean
  • Default value is true

passwordedit

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

portedit

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

save_attachmentsedit

  • Value type is boolean
  • Default value is false

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

secureedit

  • Value type is boolean
  • Default value is true

sincedb_pathedit

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

  • Value type is boolean
  • Default value is false

uid_trackingedit

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

useredit

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

verify_certedit

  • Value type is boolean
  • Default value is true

Common Optionsedit

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

Detailsedit

 

add_fieldedit

  • Value type is hash
  • Default value is {}

Add a field to an event

codecedit

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

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

idedit

  • 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"
  }
}

tagsedit

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

typeedit

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