index.asciidoc in logstash-output-email-4.0.6

- old
+ new

@@ -10,37 +10,37 @@
 :include_path: ../../../../logstash/docs/include
 ///////////////////////////////////////////
 END - GENERATED VARIABLES, DO NOT EDIT!
 ///////////////////////////////////////////
 
-[id="plugins-{type}-{plugin}"]
+[id="plugins-{type}s-{plugin}"]
 
 === Email output plugin
 
 include::{include_path}/plugin_header.asciidoc[]
 
 ==== Description
 
+Sends email when an output is received. Alternatively, you may include or
+exclude the email output execution using conditionals.
 
 ==== Usage Example
 [source,ruby]
 ----------------------------------
 output {
   if "shouldmail" in [tags] {
     email {
-      to => 'technical@logstash.net'
-      from => 'monitor@logstash.net'
+      to => 'technical@example.com'
+      from => 'monitor@example.com'
       subject => 'Alert - %{title}'
       body => "Tags: %{tags}\\n\\Content:\\n%{message}"
-      domain => 'mail.logstash.net'
+      domain => 'mail.example.com'
       port => 25
     }
   }
 }
 ----------------------------------
-Send email when an output is received. Alternatively, you may include or
-exclude the email output execution using conditionals.
 
 [id="plugins-{type}s-{plugin}-options"]
 ==== Email Output Configuration Options
 
 This plugin supports the following configuration options plus the <<plugins-{type}s-{plugin}-common-options>> described later.
@@ -112,11 +112,11 @@
   * There is no default value for this setting.
 
 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@host.com, you@host.com"`
+`"me@example.com, you@example.com"`
 
 [id="plugins-{type}s-{plugin}-contenttype"]
 ===== `contenttype` 
 
   * Value type is <<string,string>>
@@ -137,17 +137,19 @@
 ===== `domain` 
 
   * Value type is <<string,string>>
   * Default value is `"localhost"`
 
-Domain used to send the email messages
+The HELO/EHLO domain name used in the greeting message when connecting
+to a remote SMTP server. Some servers require this name to match the
+actual hostname of the connecting client.
 
 [id="plugins-{type}s-{plugin}-from"]
 ===== `from` 
 
   * Value type is <<string,string>>
-  * Default value is `"logstash.alert@nowhere.com"`
+  * Default value is `"logstash.alert@example.com"`
 
 The fully-qualified email address for the From: field in the email.
 
 [id="plugins-{type}s-{plugin}-htmlbody"]
 ===== `htmlbody` 
@@ -197,11 +199,11 @@
   * There is no default value for this setting.
 
 The fully-qualified email address to send the email to.
 
 This field also accepts a comma-separated string of addresses, for example:
-`"me@host.com, you@host.com"`
+`"me@example.com, you@example.com"`
 
 You can also use dynamic fields from the event with the `%{fieldname}` syntax.
 
 [id="plugins-{type}s-{plugin}-use_tls"]
 ===== `use_tls` 
@@ -228,6 +230,6 @@
 How Logstash should send the email, either via SMTP or by invoking sendmail.
 
 
 
 [id="plugins-{type}s-{plugin}-common-options"]
-include::{include_path}/{type}.asciidoc[]
\ No newline at end of file
+include::{include_path}/{type}.asciidoc[]