IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« http_poller irc »

› ›

imap

edit

imap

edit

Version: 3.0.2
Released on: 2016-07-14
Changelog
Compatible: 5.1.1.1, 5.0.0, 2.4.1, 2.4.0, 2.3.4

Read mails from IMAP server

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

Synopsis

edit

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`
`enable_metric`	boolean	No	`true`
`expunge`	boolean	No	`false`
`fetch_count`	number	No	`50`
`folder`	string	No	`"INBOX"`
`host`	string	Yes
`id`	string	No
`lowercase_headers`	boolean	No	`true`
`password`	password	Yes
`port`	number	No
`secure`	boolean	No	`true`
`strip_attachments`	boolean	No	`false`
`tags`	array	No
`type`	string	No
`user`	string	Yes
`verify_cert`	boolean	No	`true`

Details

edit

`add_field`

edit

Value type is hash
Default value is {}

Add a field to an event

`check_interval`

edit

Value type is number
Default value is 300

`codec`

edit

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`

edit

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`

edit

Value type is boolean
Default value is false

`enable_metric`

edit

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.

`expunge`

edit

Value type is boolean
Default value is false

`fetch_count`

edit

Value type is number
Default value is 50

`folder`

edit

Value type is string
Default value is "INBOX"

`host`

edit

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

`id`

edit

Value type is string
There is no default value for this setting.

Add a unique ID to the plugin instance, this ID is used for tracking information for a specific configuration of the plugin.

output {
 stdout {
   id => "ABC"
 }
}

If you don’t explicitely set this variable Logstash will generate a unique name.

`lowercase_headers`

edit

Value type is boolean
Default value is true

`password`

edit

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

`port`

edit

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

`secure`

edit

Value type is boolean
Default value is true

`strip_attachments`

edit

Value type is boolean
Default value is false

`tags`

edit

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`

edit

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`

edit

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

`verify_cert`

edit

Value type is boolean
Default value is true

« http_poller irc »