docs/index.asciidoc in logstash-output-email-4.0.6 vs docs/index.asciidoc in logstash-output-email-4.1.0

- old
+ new

@@ -31,10 +31,11 @@ email { to => 'technical@example.com' from => 'monitor@example.com' subject => 'Alert - %{title}' body => "Tags: %{tags}\\n\\Content:\\n%{message}" + template_file => "/tmp/email_template.mustache" domain => 'mail.example.com' port => 25 } } } @@ -51,10 +52,11 @@ | <<plugins-{type}s-{plugin}-address>> |<<string,string>>|No | <<plugins-{type}s-{plugin}-attachments>> |<<array,array>>|No | <<plugins-{type}s-{plugin}-authentication>> |<<string,string>>|No | <<plugins-{type}s-{plugin}-body>> |<<string,string>>|No | <<plugins-{type}s-{plugin}-cc>> |<<string,string>>|No +| <<plugins-{type}s-{plugin}-bcc>> |<<string,string>>|No | <<plugins-{type}s-{plugin}-contenttype>> |<<string,string>>|No | <<plugins-{type}s-{plugin}-debug>> |<<boolean,boolean>>|No | <<plugins-{type}s-{plugin}-domain>> |<<string,string>>|No | <<plugins-{type}s-{plugin}-from>> |<<string,string>>|No | <<plugins-{type}s-{plugin}-htmlbody>> |<<string,string>>|No @@ -64,10 +66,11 @@ | <<plugins-{type}s-{plugin}-subject>> |<<string,string>>|No | <<plugins-{type}s-{plugin}-to>> |<<string,string>>|Yes | <<plugins-{type}s-{plugin}-use_tls>> |<<boolean,boolean>>|No | <<plugins-{type}s-{plugin}-username>> |<<string,string>>|No | <<plugins-{type}s-{plugin}-via>> |<<string,string>>|No +| <<plugins-{type}s-{plugin}-template_file>> |<<path,path>>|No |======================================================================= Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all output plugins. @@ -114,10 +117,20 @@ The fully-qualified email address(es) to include as cc: address(es). This field also accepts a comma-separated string of addresses, for example: `"me@example.com, you@example.com"` +[id="plugins-{type}s-{plugin}-bcc"] +===== `bcc` + + * Value type is <<string,string>> + * There is no default value for this setting. + +The fully-qualified email address(es) to include as bcc: address(es). + +This field accepts several addresses like cc. + [id="plugins-{type}s-{plugin}-contenttype"] ===== `contenttype` * Value type is <<string,string>> * Default value is `"text/html; charset=UTF-8"` @@ -227,9 +240,17 @@ * Value type is <<string,string>> * Default value is `"smtp"` How Logstash should send the email, either via SMTP or by invoking sendmail. +[id="plugins-{type}s-{plugin}-template_file"] +===== `template_file` + + * Value type is <<path,path>> + * There is no default value for this setting. + +Path of a [Mustache templating](https://mustache.github.io/) file used for email templating. See example in test fixture. +Can be used with `body` to send multi-part emails. Takes precedence over `htmlBody`. [id="plugins-{type}s-{plugin}-common-options"] include::{include_path}/{type}.asciidoc[]