› ›

电子邮件输出插件

编辑

电子邮件输出插件

编辑

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

对于其他版本，请参阅版本化插件文档。

获取帮助

编辑

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

描述

编辑

当收到输出时发送电子邮件。或者，您可以使用条件来包含或排除电子邮件输出的执行。

使用示例

编辑

output {
  if "shouldmail" in [tags] {
    email {
      to => '[email protected]'
      from => '[email protected]'
      subject => 'Alert - %{title}'
      body => "Tags: %{tags}\\n\\Content:\\n%{message}"
      template_file => "/tmp/email_template.mustache"
      domain => 'mail.example.com'
      port => 25
    }
  }
}

电子邮件输出配置选项

编辑

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

设置	输入类型	必需
`address`	字符串	否
`attachments`	数组	否
`authentication`	字符串	否
`body`	字符串	否
`cc`	字符串	否
`bcc`	字符串	否
`contenttype`	字符串	否
`debug`	布尔值	否
`domain`	字符串	否
`from`	字符串	否
`htmlbody`	字符串	否
`password`	password	否
`port`	数字	否
`replyto`	字符串	否
`subject`	字符串	否
`to`	字符串	是
`use_tls`	布尔值	否
`username`	字符串	否
`via`	字符串	否
`template_file`	路径	否

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

`address`

编辑

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

用于连接到邮件服务器的地址

`attachments`

编辑

值类型为数组
默认值为[]

附件 - 指定文件的名称和位置。

`authentication`

编辑

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

与服务器标识时使用的身份验证方法

`body`

编辑

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

电子邮件的正文 - 仅限纯文本。

`cc`

编辑

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

要包含为抄送：地址的完全限定的电子邮件地址。

此字段也接受逗号分隔的地址字符串，例如："[email protected], [email protected]"

`bcc`

编辑

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

要包含为密件抄送：地址的完全限定的电子邮件地址。

此字段接受多个地址，如抄送。

`contenttype`

编辑

值类型为字符串
默认值为"text/html; charset=UTF-8"

contenttype：对于多部分消息，设置HTML部分的内容类型和/或字符集。注意：这可能无法正常工作（KH）

`debug`

编辑

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

以调试模式运行邮件中继

`domain`

编辑

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

连接到远程SMTP服务器时，在问候消息中使用的HELO/EHLO域名。某些服务器要求此名称与连接客户端的实际主机名匹配。

`from`

编辑

值类型为字符串
默认值为"[email protected]"

电子邮件中“发件人：”字段的完全限定的电子邮件地址。

`htmlbody`

编辑

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

电子邮件的HTML正文，其中可能包含HTML标记。

`password`

编辑

值类型为密码
此设置没有默认值。

用于向服务器进行身份验证的密码

`port`

编辑

值类型为数字
默认值为25

用于与邮件服务器通信的端口

`replyto`

编辑

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

“回复至：”字段的完全限定的电子邮件地址。

`subject`

编辑

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

电子邮件的“主题：”。

`to`

编辑

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

要将电子邮件发送到的完全限定的电子邮件地址。

此字段也接受逗号分隔的地址字符串，例如："[email protected], [email protected]"

您还可以使用带有%{fieldname}语法的事件中的动态字段。

`use_tls`

编辑

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

在与服务器通信时启用TLS

`username`

编辑

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

用于向服务器进行身份验证的用户名

`via`

编辑

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

Logstash应如何发送电子邮件，通过SMTP或调用sendmail。

`template_file`

编辑

值类型为路径
此设置没有默认值。

用于电子邮件模板的[Mustache模板](https://mustache.github.io/)文件的路径。请参阅测试装置中的示例。可以与body一起使用以发送多部分电子邮件。优先于htmlBody。

常用选项

编辑

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

设置	输入类型	必需
`codec`	codec	否
`enable_metric`	布尔值	否
`id`	字符串	否

`codec`

编辑

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

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

`enable_metric`

编辑

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

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

`id`

编辑

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

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

output {
  email {
    id => "my_plugin_id"
  }
}

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

« Elasticsearch 输出插件 Exec 输出插件 »