Imap 输入插件编辑

  • 插件版本:v3.2.1
  • 发布时间:2023-10-03
  • 更新日志

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

获取帮助编辑

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

描述编辑

从 IMAP 服务器读取邮件

定期扫描 IMAP 文件夹(默认为INBOX),并将所有已读邮件移至垃圾箱。

与 Elastic Common Schema (ECS) 的兼容性编辑

该插件包含合理的默认值,这些默认值会根据ECS 兼容性模式而变化。当禁用 ECS 兼容性时,邮件标头和附件的目标级别为根级别。当目标为 ECS 版本时,标头和附件的目标为@metadata子字段(除非另有配置),以避免与 ECS 字段冲突。请参阅headers_targetattachments_target

Imap 输入配置选项编辑

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

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

 

attachments_target编辑

  • 值类型为字符串
  • 默认值取决于是否启用了ecs_compatibility

    • ECS 兼容性已禁用:"[attachments]"
    • ECS 兼容性已启用:`"[@metadata][input][imap][attachments]"

如果设置了save_attachments,则为添加邮件附件信息的字段的名称。

check_interval编辑

  • 值类型为数字
  • 默认值为300

content_type编辑

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

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

delete编辑

ecs_compatibility编辑

  • 值类型为字符串
  • 支持的值为

    • disabled:不使用与 ECS 兼容的字段名称(例如,From标头字段将添加到事件中)
    • v1v8:避免可能与 Elastic Common Schema 冲突的字段名称(例如,From标头将作为元数据添加)
  • 默认值取决于运行的 Logstash 版本

    • 当 Logstash 提供pipeline.ecs_compatibility设置时,其值将用作默认值
    • 否则,默认值为disabled

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

expunge编辑

fetch_count编辑

  • 值类型为数字
  • 默认值为50

folder编辑

headers_target编辑

  • 值类型为字符串
  • 默认值取决于是否启用了ecs_compatibility

    • ECS 兼容性已禁用:无默认值(例如,主题标头存储在"subject"名称下)
    • ECS 兼容性已启用:"[@metadata][input][imap][headers]"

添加邮件标头的字段的名称。

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

host编辑

  • 这是必填设置。
  • 值类型为字符串
  • 此设置没有默认值。

lowercase_headers编辑

password编辑

  • 这是必填设置。
  • 值类型为密码
  • 此设置没有默认值。

port编辑

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

save_attachments编辑

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

secure编辑

sincedb_path编辑

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

将写入磁盘的 sincedb 数据库文件(跟踪最后处理的邮件的 UID)的路径。默认情况下,sincedb 文件将写入<path.data>/plugins/inputs/imap目录。注意:它必须是文件路径,而不是目录路径。

strip_attachments编辑

uid_tracking编辑

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

user编辑

  • 这是必填设置。
  • 值类型为字符串
  • 此设置没有默认值。

verify_cert编辑

通用选项编辑

以下配置选项支持所有输入插件

设置 输入类型 必需

add_field

hash

codec

codec

enable_metric

布尔值

id

字符串

tags

array

type

字符串

详情编辑

 

add_field编辑

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

向事件添加字段

codec编辑

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

enable_metric编辑

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

id编辑

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

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

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

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

tags编辑

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

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

这有助于以后的处理。

type编辑

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

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

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

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

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