imap

This is a community-maintained plugin!

Read mails from IMAP server

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

 

Synopsis

This plugin supports the following configuration options:

Required configuration options:

imap {
    host => ...
    password => ...
    user => ...
}

Available configuration options:

Setting Input type Required Default value

add_field

hash

No

{}

check_interval

number

No

300

codec

codec

No

"plain"

content_type

string

No

"text/plain"

delete

boolean

No

false

fetch_count

number

No

50

folder

string

No

"INBOX"

host

string

Yes

lowercase_headers

boolean

No

true

password

password

Yes

port

number

No

secure

boolean

No

true

tags

array

No

type

string

No

user

string

Yes

verify_cert

boolean

No

true

Details

 

add_field

  • Value type is hash
  • Default value is {}

Add a field to an event

check_interval

  • Value type is number
  • Default value is 300

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.

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.

delete

  • 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

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

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