Imap 输入插件
编辑Imap 输入插件编辑
- 插件版本:v3.2.1
- 发布时间:2023-10-03
- 更新日志
有关其他版本,请参阅版本化插件文档。
获取帮助编辑
如有关于插件的问题,请在论坛中打开一个主题。如有错误或功能请求,请在Github中打开一个问题。有关 Elastic 支持的插件列表,请参阅Elastic 支持矩阵。
与 Elastic Common Schema (ECS) 的兼容性编辑
该插件包含合理的默认值,这些默认值会根据ECS 兼容性模式而变化。当禁用 ECS 兼容性时,邮件标头和附件的目标级别为根级别。当目标为 ECS 版本时,标头和附件的目标为@metadata
子字段(除非另有配置),以避免与 ECS 字段冲突。请参阅headers_target
和attachments_target
。
Imap 输入配置选项编辑
此插件支持以下配置选项以及稍后描述的通用选项。
设置 | 输入类型 | 必需 |
---|---|---|
否 |
||
否 |
||
否 |
||
否 |
||
否 |
||
否 |
||
否 |
||
否 |
||
否 |
||
是 |
||
否 |
||
是 |
||
否 |
||
否 |
||
否 |
||
否 |
||
否 |
||
否 |
||
是 |
||
否 |
另请参阅通用选项,了解所有输入插件支持的选项列表。
attachments_target
编辑
- 值类型为字符串
-
默认值取决于是否启用了
ecs_compatibility
- ECS 兼容性已禁用:
"[attachments]"
- ECS 兼容性已启用:`"[@metadata][input][imap][attachments]"
- ECS 兼容性已禁用:
如果设置了save_attachments
,则为添加邮件附件信息的字段的名称。
ecs_compatibility
编辑
- 值类型为字符串
-
支持的值为
-
disabled
:不使用与 ECS 兼容的字段名称(例如,From
标头字段将添加到事件中) -
v1
、v8
:避免可能与 Elastic Common Schema 冲突的字段名称(例如,From
标头将作为元数据添加)
-
-
默认值取决于运行的 Logstash 版本
- 当 Logstash 提供
pipeline.ecs_compatibility
设置时,其值将用作默认值 - 否则,默认值为
disabled
。
- 当 Logstash 提供
控制此插件与Elastic Common Schema (ECS)的兼容性。此设置的值会影响headers_target
和attachments_target
的*默认值*。
headers_target
编辑
- 值类型为字符串
-
默认值取决于是否启用了
ecs_compatibility
- ECS 兼容性已禁用:无默认值(例如,主题标头存储在
"subject"
名称下) - ECS 兼容性已启用:
"[@metadata][input][imap][headers]"
- ECS 兼容性已禁用:无默认值(例如,主题标头存储在
添加邮件标头的字段的名称。
设置headers_target => ''
会跳过标头处理,并且不会将任何标头添加到事件中。日期标头(如果存在)除外,它始终用作事件的@timestamp
。
sincedb_path
编辑
- 值类型为字符串
- 此设置没有默认值。
将写入磁盘的 sincedb 数据库文件(跟踪最后处理的邮件的 UID)的路径。默认情况下,sincedb 文件将写入<path.data>/plugins/inputs/imap
目录。注意:它必须是文件路径,而不是目录路径。
uid_tracking
编辑
- 值类型为布尔值
- 默认值为
false
当 IMAP 输入插件首次连接到邮箱且最后处理的邮件的 UID 尚不清楚时,将首先下载未读邮件并保存最后处理的邮件的 UID。从这一点开始,如果uid_tracking
设置为true
,则无论新邮件是否标记为已读或未读,都将下载所有新邮件。这允许用户或其他服务与 IMAP 输入插件同时使用邮箱。无论uid_tracking
值如何,始终保存最后处理的邮件的 UID,因此您可以根据需要切换其值。在从以前的 IMAP 输入插件版本过渡时,首先至少处理一封uid_tracking
设置为false
的邮件以保存最后处理的邮件的 UID,然后将uid_tracking
切换为true
。
通用选项编辑
以下配置选项支持所有输入插件
详情编辑
codec
编辑
- 值类型为 编解码器
- 默认值为
"plain"
用于输入数据的编解码器。输入编解码器是一种方便的方法,可以在数据进入输入之前对其进行解码,而无需在 Logstash 管道中使用单独的过滤器。