› ›

Imap 输入插件

编辑

Imap 输入插件

编辑

插件版本：v3.2.1
发布日期：2023-10-03
更新日志

有关其他版本，请参阅版本化插件文档。

获取帮助

编辑

有关插件的问题，请在Discuss论坛中打开一个主题。对于错误或功能请求，请在Github中打开一个问题。有关 Elastic 支持的插件列表，请查阅Elastic 支持矩阵。

描述

编辑

从 IMAP 服务器读取邮件

定期扫描 IMAP 文件夹（默认为 INBOX），并将任何已读邮件移动到垃圾箱。

与 Elastic Common Schema (ECS) 的兼容性

编辑

该插件包含根据ECS 兼容模式更改的合理默认值。禁用 ECS 兼容性时，邮件头和附件将定位在根级别。当以 ECS 版本为目标时，除非另行配置以避免与 ECS 字段冲突，否则标头和附件将以 @metadata 子字段为目标。请参阅 headers_target 和 attachments_target。

Imap 输入配置选项

编辑

此插件支持以下配置选项以及稍后描述的通用选项。

设置	输入类型	必需
`attachments_target`	字符串	否
`check_interval`	数字	否
`content_type`	字符串	否
`delete`	布尔值	否
`ecs_compatibility`	字符串	否
`expunge`	布尔值	否
`fetch_count`	数字	否
`folder`	字符串	否
`headers_target`	字符串	否
`host`	字符串	是
`lowercase_headers`	布尔值	否
`password`	password	是
`port`	数字	否
`save_attachments`	布尔值	否
`secure`	布尔值	否
`sincedb_path`	字符串	否
`strip_attachments`	布尔值	否
`uid_tracking`	布尔值	否
`user`	字符串	是
`verify_cert`	布尔值	否

另请参阅通用选项，了解所有输入插件支持的选项列表。

`attachments_target`

编辑

值类型为字符串
默认值取决于是否启用ecs_compatibility
- 禁用 ECS 兼容性："[attachments]"
- 启用 ECS 兼容性：`"[@metadata][input][imap][attachments]"`

如果设置了save_attachments，将在其中添加邮件附件信息的字段名称。

`check_interval`

编辑

值类型为数字
默认值为300

`content_type`

编辑

值类型为字符串
默认值为"text/plain"

对于多部分消息，请使用具有此内容类型的第一个部分作为事件消息。

`delete`

编辑

值类型为布尔值
默认值为false

`ecs_compatibility`

编辑

值类型为字符串
支持的值为
- disabled：不使用与 ECS 兼容的字段名称（例如，From 标头字段将添加到事件中）
- v1、v8：避免可能与 Elastic Common Schema 冲突的字段名称（例如，From 标头将作为元数据添加）
默认值取决于正在运行的 Logstash 版本
- 当 Logstash 提供 pipeline.ecs_compatibility 设置时，其值将用作默认值
- 否则，默认值为 disabled。

控制此插件与Elastic Common Schema (ECS)的兼容性。此设置的值会影响headers_target和attachments_target的 *默认值*。

`expunge`

编辑

值类型为布尔值
默认值为false

`fetch_count`

编辑

值类型为数字
默认值为50

`folder`

编辑

值类型为字符串
默认值为"INBOX"

`headers_target`

编辑

值类型为字符串
默认值取决于是否启用ecs_compatibility
- 禁用 ECS 兼容性：没有默认值（例如，主题标头存储在 "subject" 名称下）
- 启用 ECS 兼容性："[@metadata][input][imap][headers]"

将在其中添加邮件标头的字段名称。

设置 headers_target => '' 会跳过标头处理，并且不会将标头添加到事件中。如果存在日期标头，则例外，它始终用作事件的 @timestamp。

`host`

编辑

这是一个必需的设置。
值类型为字符串
此设置没有默认值。

`lowercase_headers`

编辑

值类型为布尔值
默认值为true

`password`

编辑

这是一个必需的设置。
值类型为密码
此设置没有默认值。

`port`

编辑

值类型为数字
此设置没有默认值。

`save_attachments`

编辑

值类型为布尔值
默认值为false

当设置为 true 时，附件的内容将包含在 attachments.data 字段中。

`secure`

编辑

值类型为布尔值
默认值为true

`sincedb_path`

编辑

值类型为字符串
此设置没有默认值。

sincedb 数据库文件的路径（跟踪上次处理的邮件的 UID），该文件将写入磁盘。默认设置会将 sincedb 文件写入 <path.data>/plugins/inputs/imap 目录。注意：它必须是文件路径，而不是目录路径。

`strip_attachments`

编辑

值类型为布尔值
默认值为false

`uid_tracking`

编辑

值类型为布尔值
默认值为false

当 IMAP 输入插件首次连接到邮箱并且尚未知道上次处理的邮件的 UID 时，首先下载未读邮件，并保存上次处理的邮件的 UID。从那时起，如果 uid_tracking 设置为 true，则无论是否标记为已读或未读，都将下载所有新邮件。这允许用户或其他服务与 IMAP 输入插件同时使用邮箱。上次处理的邮件的 UID 始终保存，而不管 uid_tracking 值如何，因此您可以根据需要切换其值。在从以前的 IMAP 输入插件版本过渡时，首先使用设置为 false 的 uid_tracking 处理至少一封邮件，以保存上次处理的邮件的 UID，然后将 uid_tracking 切换为 true。

`user`

编辑

这是一个必需的设置。
值类型为字符串
此设置没有默认值。

`verify_cert`

编辑

值类型为布尔值
默认值为true

通用选项

编辑

所有输入插件都支持这些配置选项

设置	输入类型	必需
`add_field`	哈希	否
`codec`	codec	否
`enable_metric`	布尔值	否
`id`	字符串	否
`tags`	数组	否
`type`	字符串	否

`add_field`

编辑

值类型为哈希
默认值为{}

向事件添加字段

`codec`

编辑

值类型为编解码器
默认值为"plain"

用于输入数据的编解码器。输入编解码器是一种方便的方法，可以在数据进入输入之前对其进行解码，而无需在 Logstash 管道中使用单独的过滤器。

`enable_metric`

编辑

值类型为布尔值
默认值为true

禁用或启用此特定插件实例的指标日志记录，默认情况下，我们记录所有可以记录的指标，但您可以禁用特定插件的指标收集。

`id`

编辑

值类型为字符串
此设置没有默认值。

向插件配置添加唯一的 ID。如果未指定 ID，Logstash 将生成一个 ID。强烈建议在配置中设置此 ID。当您有两个或多个相同类型的插件时，这尤其有用，例如，如果您有 2 个 imap 输入。在这种情况下添加一个命名 ID 将有助于在使用监控 API 时监控 Logstash。

input {
  imap {
    id => "my_plugin_id"
  }
}

id 字段中的变量替换仅支持环境变量，不支持使用密钥存储中的值。

`tags`

编辑

值类型为数组
此设置没有默认值。

向您的事件添加任意数量的标签。

这有助于以后的处理。

`type`

编辑

值类型为字符串
此设置没有默认值。

向此输入处理的所有事件添加 type 字段。

类型主要用于过滤器激活。

类型存储为事件本身的一部分，因此您还可以使用该类型在 Kibana 中搜索它。

如果您尝试在已具有类型的事件上设置类型（例如，当您将事件从托运人发送到索引器时），则新输入将不会覆盖现有类型。在托运人处设置的类型在该事件的整个生命周期内都会保留，即使发送到另一个 Logstash 服务器也是如此。

« Http_poller 输入插件 Irc 输入插件 »