logstash-output-email 4.0.3 → 4.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8a9af05ddd631994d6459e2e81b377d70c28c377
-  data.tar.gz: aa7238cb8ca5431f546bd847cad28d18b8e3ed30
+  metadata.gz: 3a21e40d5ec3c92d44dcbf6c5973fa5086d534e5
+  data.tar.gz: b3890fd8f5117f846d25a247f52c8dbad1f7b28e
 SHA512:
-  metadata.gz: 01a65e93dd3a3cb5cc4a80e6dfff8c55973c1750166d98b8bb5c7e51332c2800e088ebfe65315fdb5d06d4d05c3f483c1bc1f43f78aca6ea5ef466cba0fe2d24
-  data.tar.gz: 3a7a870a18f54a19b2401d295cdbf2a953663cf40d61453d2e008c24285462745acf465e771de3f081b178f9f02f69bad2faeee5397bc40276d5e70076e62f64
+  metadata.gz: 64c18054a7e49fb7c40d89a758bcc1e158e8d715610396a61844809b891d1e48e719a811bbf52df704c87f31f1b4f1ff7e591c35ae516147e3f281c0d4355e66
+  data.tar.gz: 7761cc2a9fd55506c70c5a05a483003c0c717a24612125905019d6fba9750e6d52ff204637cd507d3e5f701bc731c00c7cafc5d2800deef753fcc52261f1550f

data/Gemfile

@@ -1,4 +1,11 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in logstash-mass_effect.gemspec
 gemspec
+
+logstash_path = ENV["LOGSTASH_PATH"] || "../../logstash"
+use_logstash_source = ENV["LOGSTASH_SOURCE"] && ENV["LOGSTASH_SOURCE"].to_s == "1"
+
+if Dir.exist?(logstash_path) && use_logstash_source
+  gem 'logstash-core', :path => "#{logstash_path}/logstash-core"
+  gem 'logstash-core-plugin-api', :path => "#{logstash_path}/logstash-core-plugin-api"
+end

data/docs/index.asciidoc

@@ -0,0 +1,233 @@
+:plugin: email
+:type: output
+
+///////////////////////////////////////////
+START - GENERATED VARIABLES, DO NOT EDIT!
+///////////////////////////////////////////
+:version: %VERSION%
+:release_date: %RELEASE_DATE%
+:changelog_url: %CHANGELOG_URL%
+:include_path: ../../../../logstash/docs/include
+///////////////////////////////////////////
+END - GENERATED VARIABLES, DO NOT EDIT!
+///////////////////////////////////////////
+
+[id="plugins-{type}-{plugin}"]
+
+=== Email output plugin
+
+include::{include_path}/plugin_header.asciidoc[]
+
+==== Description
+
+
+==== Usage Example
+[source,ruby]
+----------------------------------
+output {
+  if "shouldmail" in [tags] {
+    email {
+      to => 'technical@logstash.net'
+      from => 'monitor@logstash.net'
+      subject => 'Alert - %{title}'
+      body => "Tags: %{tags}\\n\\Content:\\n%{message}"
+      domain => 'mail.logstash.net'
+      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.
+
+[cols="<,<,<",options="header",]
+|=======================================================================
+|Setting |Input type|Required
+| <<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}-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
+| <<plugins-{type}s-{plugin}-password>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-port>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-replyto>> |<<string,string>>|No
+| <<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
+|=======================================================================
+
+Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
+output plugins.
+
+&nbsp;
+
+[id="plugins-{type}s-{plugin}-address"]
+===== `address` 
+
+  * Value type is <<string,string>>
+  * Default value is `"localhost"`
+
+The address used to connect to the mail server
+
+[id="plugins-{type}s-{plugin}-attachments"]
+===== `attachments` 
+
+  * Value type is <<array,array>>
+  * Default value is `[]`
+
+Attachments - specify the name(s) and location(s) of the files.
+
+[id="plugins-{type}s-{plugin}-authentication"]
+===== `authentication` 
+
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+Authentication method used when identifying with the server
+
+[id="plugins-{type}s-{plugin}-body"]
+===== `body` 
+
+  * Value type is <<string,string>>
+  * Default value is `""`
+
+Body for the email - plain text only.
+
+[id="plugins-{type}s-{plugin}-cc"]
+===== `cc` 
+
+  * Value type is <<string,string>>
+  * 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"`
+
+[id="plugins-{type}s-{plugin}-contenttype"]
+===== `contenttype` 
+
+  * Value type is <<string,string>>
+  * Default value is `"text/html; charset=UTF-8"`
+
+contenttype : for multipart messages, set the content-type and/or charset of the HTML part.
+NOTE: this may not be functional (KH)
+
+[id="plugins-{type}s-{plugin}-debug"]
+===== `debug` 
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `false`
+
+Run the mail relay in debug mode
+
+[id="plugins-{type}s-{plugin}-domain"]
+===== `domain` 
+
+  * Value type is <<string,string>>
+  * Default value is `"localhost"`
+
+Domain used to send the email messages
+
+[id="plugins-{type}s-{plugin}-from"]
+===== `from` 
+
+  * Value type is <<string,string>>
+  * Default value is `"logstash.alert@nowhere.com"`
+
+The fully-qualified email address for the From: field in the email.
+
+[id="plugins-{type}s-{plugin}-htmlbody"]
+===== `htmlbody` 
+
+  * Value type is <<string,string>>
+  * Default value is `""`
+
+HTML Body for the email, which may contain HTML markup.
+
+[id="plugins-{type}s-{plugin}-password"]
+===== `password` 
+
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+Password to authenticate with the server
+
+[id="plugins-{type}s-{plugin}-port"]
+===== `port` 
+
+  * Value type is <<number,number>>
+  * Default value is `25`
+
+Port used to communicate with the mail server
+
+[id="plugins-{type}s-{plugin}-replyto"]
+===== `replyto` 
+
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+The fully qualified email address for the Reply-To: field.
+
+[id="plugins-{type}s-{plugin}-subject"]
+===== `subject` 
+
+  * Value type is <<string,string>>
+  * Default value is `""`
+
+Subject: for the email.
+
+[id="plugins-{type}s-{plugin}-to"]
+===== `to` 
+
+  * This is a required setting.
+  * Value type is <<string,string>>
+  * 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"`
+
+You can also use dynamic fields from the event with the `%{fieldname}` syntax.
+
+[id="plugins-{type}s-{plugin}-use_tls"]
+===== `use_tls` 
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `false`
+
+Enables TLS when communicating with the server
+
+[id="plugins-{type}s-{plugin}-username"]
+===== `username` 
+
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+Username to authenticate with the server
+
+[id="plugins-{type}s-{plugin}-via"]
+===== `via` 
+
+  * 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}-common-options"]
+include::{include_path}/{type}.asciidoc[]

data/lib/logstash/outputs/email.rb

@@ -1,16 +1,35 @@
+#
+# ==== Usage Example
+
+# [source,ruby]
+# ----------------------------------
+# output {
+#   if "shouldmail" in [tags] {
+#     email {
+#       to => 'technical@logstash.net'
+#       from => 'monitor@logstash.net'
+#       subject => 'Alert - %{title}'
+#       body => "Tags: %{tags}\\n\\Content:\\n%{message}"
+#       domain => 'mail.logstash.net'
+#       port => 25
+#     }
+#   }
+# }
+# ----------------------------------
+
 # encoding: utf-8
 require "logstash/outputs/base"
 require "logstash/namespace"
 
 # Send email when an output is received. Alternatively, you may include or
-# exclude the email output execution using conditionals. 
+# exclude the email output execution using conditionals.
 class LogStash::Outputs::Email < LogStash::Outputs::Base
 
   config_name "email"
 
   # The fully-qualified email address to send the email to.
   #
-  # This field also accepts a comma-separated string of addresses, for example: 
+  # This field also accepts a comma-separated string of addresses, for example:
   # `"me@host.com, you@host.com"`
   #
   # You can also use dynamic fields from the event with the `%{fieldname}` syntax.
@@ -24,7 +43,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: 
+  # This field also accepts a comma-separated string of addresses, for example:
   # `"me@host.com, you@host.com"`
   config :cc, :validate => :string
 
@@ -104,7 +123,7 @@ class LogStash::Outputs::Email < LogStash::Outputs::Base
 
   public
   def receive(event)
-    
+
 
       @logger.debug? and @logger.debug("Creating mail with these settings : ", :via => @via, :options => @options, :from => @from, :to => @to, :cc => @cc, :subject => @subject, :body => @body, :content_type => @contenttype, :htmlbody => @htmlbody, :attachments => @attachments, :to => to, :to => to)
       formatedSubject = event.sprintf(@subject)

data/logstash-output-email.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-output-email'
-  s.version         = '4.0.3'
+  s.version         = '4.0.4'
   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"
@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   # Files
-  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
+  s.files = Dir["lib/**/*","spec/**/*","*.gemspec","*.md","CONTRIBUTORS","Gemfile","LICENSE","NOTICE.TXT", "vendor/jar-dependencies/**/*.jar", "vendor/jar-dependencies/**/*.rb", "VERSION", "docs/**/*"]
 
   # Tests
   s.test_files = s.files.grep(%r{^(test|spec|features)/})

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-output-email
 version: !ruby/object:Gem::Version
-  version: 4.0.3
+  version: 4.0.4
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-08-04 00:00:00.000000000 Z
+date: 2017-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -112,6 +112,7 @@ files:
 - LICENSE
 - NOTICE.TXT
 - README.md
+- docs/index.asciidoc
 - lib/logstash/outputs/email.rb
 - logstash-output-email.gemspec
 - spec/outputs/email_spec.rb