› ›

Imap 输入插件

编辑

Imap 输入插件

编辑

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

其他版本，请参见版本化插件文档。

获取帮助

编辑

如有关于插件的问题，请在 Discuss 论坛中发起讨论。如发现错误或有功能请求，请在 Github 中提交 issue。如需查看 Elastic 支持的插件列表，请参阅 Elastic 支持矩阵。

描述

编辑

从 IMAP 服务器读取邮件

定期扫描 IMAP 文件夹（默认情况下为 INBOX）并将所有已读邮件移动到垃圾箱。

与 Elastic Common Schema (ECS) 的兼容性

编辑

此插件包含基于 ECS 兼容模式而变化的合理默认值。当禁用 ECS 兼容性时，邮件头和附件的目标是根级别。当定位到 ECS 版本时，除非在配置中另有说明，否则邮件头和附件的目标是 @metadata 子字段，以避免与 ECS 字段冲突。请参见 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`	hash	否
`codec`	codec	否
`enable_metric`	布尔值	否
`id`	字符串	否
`tags`	array	否
`type`	字符串	否

`add_field`

编辑

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

向事件添加字段

`codec`

编辑

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

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

`enable_metric`

编辑

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

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

`id`

编辑

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

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

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

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

`tags`

编辑

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

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

这可以帮助以后进行处理。

`type`

编辑

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

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

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

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

如果您尝试在已经具有类型的事件上设置类型（例如，当您将事件从发件人发送到索引器时），则新的输入不会覆盖现有类型。即使发送到另一个 Logstash 服务器，在发件人处设置的类型也会一直保留在该事件中。

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