logstash-output-email 4.0.4 → 4.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3a21e40d5ec3c92d44dcbf6c5973fa5086d534e5
-  data.tar.gz: b3890fd8f5117f846d25a247f52c8dbad1f7b28e
+  metadata.gz: 796bc0c80400fcd45375ea26449505f08d81d038
+  data.tar.gz: a5c5434cfa5c1151c45d5360e3e7ed0733344303
 SHA512:
-  metadata.gz: 64c18054a7e49fb7c40d89a758bcc1e158e8d715610396a61844809b891d1e48e719a811bbf52df704c87f31f1b4f1ff7e591c35ae516147e3f281c0d4355e66
-  data.tar.gz: 7761cc2a9fd55506c70c5a05a483003c0c717a24612125905019d6fba9750e6d52ff204637cd507d3e5f701bc731c00c7cafc5d2800deef753fcc52261f1550f
+  metadata.gz: 529802062bddd74474e4ac650325f11b4a3faf9c761cb12650fafe75893c829b3eaa228e81733d8591cae27508633101f362d88d7896408d208efce2663d9faf
+  data.tar.gz: 59d87114214f143c85ca720a8f7e74395ef29729a1cf81cb975c0f5e317552cbabfa16b391512cc1412a444f5dfa1df4e7522dece82d8aea14415ed4fc5533c9

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 4.0.6
+  - Fix some documentation issues
+
+## 4.0.5
+  - Docs: Add plugin description
+
+## 4.0.4
+  - Docs: Fix plugin title
+
 ## 4.0.3
   - Properly constrain mime types deps to be < 3.0 due to ruby 2.0+ requirement
   - Uncap mail gem deps to play nicely with other plugins

data/docs/index.asciidoc

@@ -12,7 +12,7 @@ START - GENERATED VARIABLES, DO NOT EDIT!
 END - GENERATED VARIABLES, DO NOT EDIT!
 ///////////////////////////////////////////
 
-[id="plugins-{type}-{plugin}"]
+[id="plugins-{type}s-{plugin}"]
 
 === Email output plugin
 
@@ -20,6 +20,8 @@ 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]
@@ -27,18 +29,16 @@ include::{include_path}/plugin_header.asciidoc[]
 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
@@ -114,7 +114,7 @@ Body for the email - plain text only.
 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` 
@@ -139,13 +139,15 @@ Run the mail relay in debug mode
   * 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.
 
@@ -199,7 +201,7 @@ Subject: for the email.
 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.
 
@@ -230,4 +232,4 @@ 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[]
+include::{include_path}/{type}.asciidoc[]

data/lib/logstash/outputs/email.rb

@@ -6,11 +6,11 @@
 # 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
 #     }
 #   }
@@ -30,13 +30,13 @@ class LogStash::Outputs::Email < LogStash::Outputs::Base
   # 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.
   config :to, :validate => :string, :required => true
 
   # The fully-qualified email address for the From: field in the email.
-  config :from, :validate => :string, :default => "logstash.alert@nowhere.com"
+  config :from, :validate => :string, :default => "logstash.alert@example.com"
 
   # The fully qualified email address for the Reply-To: field.
   config :replyto, :validate => :string
@@ -44,7 +44,7 @@ class LogStash::Outputs::Email < LogStash::Outputs::Base
   # 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"`
   config :cc, :validate => :string
 
   # How Logstash should send the email, either via SMTP or by invoking sendmail.
@@ -56,7 +56,7 @@ class LogStash::Outputs::Email < LogStash::Outputs::Base
   # Port used to communicate with the mail server
   config :port, :validate => :number, :default => 25
 
-  # Domain used to send the email messages
+  # HELO/EHLO domain name
   config :domain, :validate => :string, :default => "localhost"
 
   # Username to authenticate with the server

data/logstash-output-email.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-output-email'
-  s.version         = '4.0.4'
+  s.version         = '4.0.6'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Send email when an output is received."
   s.description     = "This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-output-email
 version: !ruby/object:Gem::Version
-  version: 4.0.4
+  version: 4.0.6
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-06-23 00:00:00.000000000 Z
+date: 2017-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement