logstash-output-email-v2 4.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1d9e648f5a2305ce3f73464845b9dbe00dc8c2b1a38e8f9dcfcf8cac4d0c13a0
+  data.tar.gz: 88cf580b5fddb213b7c06cc1477e9efa6bbfb3c34a34de4a43ab0bc1ab9af2ab
+SHA512:
+  metadata.gz: d4abc8867b2854f30efc6effa5e9f68c532b68c4b1e8a68495f6bec06da607def97dc1ed1f5964ace8e9ea5f28300075c4847adac26dcaf6ca5bb956ac24e02d
+  data.tar.gz: a8340ecf12bd2fc4409388ecb07c683c1bff755156024cc92d10ca11699300d346d65738e6e009cac0c33f83d48c614d8f9825141b99a3456ce47c3798bcd7b8

data/CHANGELOG.md

@@ -0,0 +1,55 @@
+## 4.1.1
+  - Docs: Set the default_codec doc attribute.
+
+## 4.1.0
+  - Update gemspec summary
+  - Add bcc suport #55
+  - Add mustache templating #51
+
+## 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
+
+## 4.0.2
+  - Relax constraint on logstash-core-plugin-api to >= 1.60 <= 2.99
+
+## 4.0.1
+  - Republish all the gems under jruby.
+## 4.0.0
+  - Update the plugin to the version 2.0 of the plugin api, this change is required for Logstash 5.0 compatibility. See https://github.com/elastic/logstash/issues/5141
+# 3.0.5
+  - Depend on logstash-core-plugin-api instead of logstash-core, removing the need to mass update plugins on major releases of logstash
+# 3.0.4
+  - Set the version of Mail to 2.6.3, since 2.6.4 has a dependency incompatible with jruby see https://github.com/elastic/logstash/issues/4883
+  
+# 3.0.3
+  - New dependency requirements for logstash-core for the 5.0 release
+
+# 3.0.0
+ - Plugins were updated to follow the new shutdown semantic, this mainly allows Logstash to instruct input plugins to terminate gracefully, 
+   instead of using Thread.raise on the plugins' threads. Ref: https://github.com/elastic/logstash/pull/3895
+ - Dependency on logstash-core update to 2.0
+
+# 2.0.0
+  - Introduced new configuration options for the smtp server, the
+    options option is gone and now you need to specify each option
+    independetly. This require you to change your previous configuration
+    when updating.
+  - Removed the deprecated option match. This option was deprecatred in
+    favor of using conditionals. This change also require you to change
+    your current cnofiguration if using this option.
+
+# 1.1.0
+  - Make the delivery method more reliable to failure by catching and
+    logging exceptions when happen, like this LS is not going to break
+    if something wrong happen, but is going to log it. Fixes #26 and #7
+  - Randomize port in specs so they can run in parallel.

data/CONTRIBUTORS

@@ -0,0 +1,23 @@
+The following is a list of people who have contributed ideas, code, bug
+reports, or in general have helped logstash along its way.
+
+Contributors:
+* Alexander Fortin (shaftoe)
+* Colin Surprenant (colinsurprenant)
+* Greg Mefford (GregMefford)
+* James Turnbull (jamtur01)
+* John E. Vincent (lusis)
+* Jordan Sissel (jordansissel)
+* Kurt Hurtado (kurtado)
+* Kushal Pisavadia (KushalP)
+* Nick Padilla (NickPadilla)
+* Philippe Weber (wiibaa)
+* Pier-Hugues Pellerin (ph)
+* Richard Pijnenburg (electrical)
+* Stian Mathiassen (smat)
+* Tim Meighen (tmeighen)
+
+Note: If you've sent us patches, bug reports, or otherwise contributed to
+Logstash, and you aren't on the list above and want to be, please let us know
+and we'll make sure you're here. Contributions from folks like you are what make
+open source awesome.

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+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/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2020 Elastic and contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/NOTICE.TXT

@@ -0,0 +1,5 @@
+Elasticsearch
+Copyright 2012-2015 Elasticsearch
+
+This product includes software developed by The Apache Software
+Foundation (http://www.apache.org/).

data/README.md

@@ -0,0 +1,104 @@
+# Logstash Plugin
+
+## Fork
+
+This is a fork of the original [Logstash Mail Plugin](https://github.com/logstash-plugins/logstash-output-email).
+It is published as `logstash-output-email2`.
+
+
+[![Travis Build Status](https://travis-ci.com/kingjan1999/logstash-output-email.svg)](https://travis-ci.com/kingjan1999/logstash-output-email)
+
+This is a plugin for [Logstash](https://github.com/elastic/logstash).
+
+It is fully free and fully open source. The license is Apache 2.0, meaning you are pretty much free to use it however you want in whatever way.
+
+## Documentation
+
+Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one [central location](http://www.elastic.co/guide/en/logstash/current/).
+
+- For formatting code or config example, you can use the asciidoc `[source,ruby]` directive
+- For more asciidoc formatting tips, see the excellent reference here https://github.com/elastic/docs#asciidoc-guide
+
+## Need Help?
+
+Need help? Try #logstash on freenode IRC or the https://discuss.elastic.co/c/logstash discussion forum.
+
+## Developing
+
+### 1. Plugin Developement and Testing
+
+#### Code
+- To get started, you'll need JRuby with the Bundler gem installed.
+
+- Create a new plugin or clone and existing from the GitHub [logstash-plugins](https://github.com/logstash-plugins) organization. We also provide [example plugins](https://github.com/logstash-plugins?query=example).
+
+- Install dependencies
+```sh
+bundle install
+```
+
+#### Test
+
+- Update your dependencies
+
+```sh
+bundle install
+```
+
+- Run tests
+
+```sh
+bundle exec rspec
+```
+
+### 2. Running your unpublished Plugin in Logstash
+
+#### 2.1 Run in a local Logstash clone
+
+- Edit Logstash `Gemfile` and add the local plugin path, for example:
+```ruby
+gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
+```
+- Install plugin
+```sh
+# Logstash 2.3 and higher
+bin/logstash-plugin install --no-verify
+
+# Prior to Logstash 2.3
+bin/plugin install --no-verify
+
+```
+- Run Logstash with your plugin
+```sh
+bin/logstash -e 'filter {awesome {}}'
+```
+At this point any modifications to the plugin code will be applied to this local Logstash setup. After modifying the plugin, simply rerun Logstash.
+
+#### 2.2 Run in an installed Logstash
+
+You can use the same **2.1** method to run your plugin in an installed Logstash by editing its `Gemfile` and pointing the `:path` to your local plugin development directory or you can build the gem and install it using:
+
+- Build your plugin gem
+```sh
+gem build logstash-filter-awesome.gemspec
+```
+- Install the plugin from the Logstash home
+```sh
+# Logstash 2.3 and higher
+bin/logstash-plugin install --no-verify
+
+# Prior to Logstash 2.3
+bin/plugin install --no-verify
+
+```
+- Start Logstash and proceed to test the plugin
+
+## Contributing
+
+All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.
+
+Programming is not a required skill. Whatever you've seen about open source and maintainers or community members  saying "send patches or die" - you will not see that here.
+
+It is more important to the community that you are able to contribute.
+
+For more information about contributing, see the [CONTRIBUTING](https://github.com/elastic/logstash/blob/master/CONTRIBUTING.md) file.

data/docs/index.asciidoc

@@ -0,0 +1,259 @@
+:plugin: email
+:type: output
+:default_codec: plain
+
+///////////////////////////////////////////
+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}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@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
+    }
+  }
+}
+----------------------------------
+
+[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}-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
+| <<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
+| <<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.
+
+&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@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"`
+
+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"`
+
+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@example.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@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` 
+
+  * 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}-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[]
+
+:default_codec!:

data/lib/logstash/outputs/email.rb

@@ -0,0 +1,194 @@
+#
+# ==== Usage Example
+
+# [source,ruby]
+# ----------------------------------
+# output {
+#   if "shouldmail" in [tags] {
+#     email {
+#       to => 'technical@example.com'
+#       from => 'monitor@example.com'
+#       subject => 'Alert - %{title}'
+#       body => "Tags: %{tags}\\n\\Content:\\n%{message}"
+#       domain => 'mail.example.com'
+#       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.
+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:
+  # `"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@example.com"
+
+  # The fully qualified email address for the Reply-To: field.
+  config :replyto, :validate => :string
+
+  # 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"`
+  config :cc, :validate => :string
+ 
+  # Same as cc but in blind carbon
+  config :bcc, :validate => :string
+
+  # How Logstash should send the email, either via SMTP or by invoking sendmail.
+  config :via, :validate => :string, :default => "smtp"
+
+  # The address used to connect to the mail server
+  config :address, :validate => :string, :default => "localhost"
+
+  # Port used to communicate with the mail server
+  config :port, :validate => :number, :default => 25
+
+  # HELO/EHLO domain name
+  config :domain, :validate => :string, :default => "localhost"
+
+  # Username to authenticate with the server
+  config :username, :validate => :string
+
+  # Password to authenticate with the server
+  config :password, :validate => :string
+
+  # Authentication method used when identifying with the server
+  config :authentication, :validate => :string
+
+  # Enables TLS when communicating with the server
+  config :use_tls, :validate => :boolean, :default => false
+
+  # Run the mail relay in debug mode
+  config :debug, :validate => :boolean, :default => false
+
+  # Subject: for the email.
+  config :subject, :validate => :string, :default => ""
+
+  # Body for the email - plain text only.
+  config :body, :validate => :string, :default => ""
+
+  # Email template file to be used - as mustache template.
+  config :template_file, :validate => :path
+
+  # HTML Body for the email, which may contain HTML markup.
+  config :htmlbody, :validate => :string, :default => ""
+
+  # Attachments - specify the name(s) and location(s) of the files.
+  config :attachments, :validate => :array, :default => []
+
+  # contenttype : for multipart messages, set the content-type and/or charset of the HTML part.
+  # NOTE: this may not be functional (KH)
+  config :contenttype, :validate => :string, :default => "text/html; charset=UTF-8"
+
+  # Custom headers to attach to the email
+  config :custom_headers, :validate => :hash, :default => {}
+
+  public
+  def register
+    require "mail"
+    require "mustache"
+
+    options = {
+      :address              => @address,
+      :port                 => @port,
+      :domain               => @domain,
+      :user_name            => @username,
+      :password             => @password,
+      :authentication       => @authentication,
+      :enable_starttls_auto => @use_tls,
+      :debug                => @debug
+    }
+
+    if @via == "smtp"
+      Mail.defaults do
+        delivery_method :smtp, options
+      end
+    elsif @via == 'sendmail'
+      Mail.defaults do
+        delivery_method :sendmail
+      end
+    else
+      Mail.defaults do
+        delivery_method :@via, options
+      end
+    end # @via tests
+    @htmlTemplate = File.open(@template_file, "r").read unless @template_file.nil?
+    @logger.debug("Email Output Registered!", :config => options, :via => @via)
+  end # def register
+
+  public
+  def receive(event)
+
+
+      @logger.debug? and @logger.debug("Creating mail with these settings : ", :via => @via, :options => @options, :from => @from, :to => @to, :cc => @cc, :bcc => @bcc, :subject => @subject, :body => @body, :content_type => @contenttype, :htmlbody => @htmlbody, :attachments => @attachments, :custom_headers => @custom_headers)
+      formatedSubject = event.sprintf(@subject)
+      formattedBody = event.sprintf(@body)
+      formattedHtmlBody = event.sprintf(@htmlbody)
+      
+      mail = Mail.new
+      mail.from = event.sprintf(@from)
+      mail.to = event.sprintf(@to)
+      if @replyto
+        mail.reply_to = event.sprintf(@replyto)
+      end
+      mail.cc = event.sprintf(@cc)
+      mail.bcc = event.sprintf(@bcc)
+      mail.subject = formatedSubject
+
+      @custom_headers.each do |key, value|
+        mail.header[event.sprintf(key)] = event.sprintf(value)
+      end
+
+      if @htmlbody.empty? and @template_file.nil?
+        formattedBody.gsub!(/\\n/, "\n") # Take new line in the email
+        mail.body = formattedBody
+      else
+        # This handles multipart emails
+        # cf: https://github.com/mikel/mail/#writing-and-sending-a-multipartalternative-html-and-text-email
+        mail.text_part = Mail::Part.new do
+          content_type "text/plain; charset=UTF-8"
+          formattedBody.gsub!(/\\n/, "\n") # Take new line in the email
+          body formattedBody
+        end
+        
+        if @template_file.nil?
+          mail.html_part = Mail::Part.new do
+            content_type "text/html; charset=UTF-8"
+            body formattedHtmlBody
+          end
+        else
+          templatedHtmlBody = Mustache.render(@htmlTemplate, event.to_hash)
+          mail.html_part = Mail::Part.new do
+            content_type "text/html; charset=UTF-8"
+            body templatedHtmlBody
+          end
+        end
+      end
+      @attachments.each do |fileLocation|
+        mail.add_file(fileLocation)
+      end # end @attachments.each
+      @logger.debug? and @logger.debug("Sending mail with these values : ", :from => mail.from, :to => mail.to, :cc => mail.cc, :bcc => mail.bcc, :subject => mail.subject)
+      begin
+        mail.deliver!
+      rescue StandardError => e
+        @logger.error("Something happen while delivering an email", :exception => e)
+        @logger.debug? && @logger.debug("Processed event: ", :event => event)
+      end
+  end # def receive
+end # class LogStash::Outputs::Email

data/logstash-output-email.gemspec

@@ -0,0 +1,37 @@
+Gem::Specification.new do |s|
+
+  s.name            = 'logstash-output-email-v2'
+  s.version         = '4.2.0'
+  s.licenses        = ['Apache License (2.0)']
+  s.summary         = "Sends email to a specified address when 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"
+  s.authors         = ["Elastic", "kingjan1999"]
+  s.email           = 'info@elastic.co'
+  s.homepage        = "http://www.elastic.co/guide/en/logstash/current/index.html"
+  s.require_paths = ["lib"]
+
+  # Files
+  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)/})
+
+  # Special flag to let us know this is actually a logstash plugin
+  s.metadata = { "logstash_plugin" => "true", "logstash_group" => "output" }
+
+  # Gem dependencies
+  s.add_runtime_dependency "logstash-core-plugin-api", ">= 1.60", "<= 2.99"
+
+  s.add_runtime_dependency 'mail', '~> 2.7.1'
+  # mime-types >= 3 require ruby 2.0 support
+  s.add_runtime_dependency 'mime-types', '< 3'
+
+  s.add_runtime_dependency 'mustache', '>= 0.99.8'
+
+  s.add_development_dependency 'logstash-devutils'
+  s.add_development_dependency 'rumbster'
+  s.add_development_dependency 'logstash-input-generator'
+  s.add_development_dependency 'gserver'
+
+end
+

data/spec/fixtures/template.mustache

@@ -0,0 +1 @@
+<h1>{{message}}</h1>

data/spec/outputs/email_spec.rb

@@ -0,0 +1,125 @@
+# encoding: utf-8
+require "spec_helper"
+require "rumbster"
+require "message_observers"
+
+describe "outputs/email" do
+
+  let (:port)             { rand(1024..65535) }
+  let (:rumbster)         { Rumbster.new(port) }
+  let (:message_observer) { MailMessageObserver.new }
+  let(:plugin)            { LogStash::Plugin.lookup("output", "email") }
+
+
+  before :each do
+    rumbster.add_observer message_observer
+    rumbster.start
+  end
+
+  after :each do
+    rumbster.stop
+    sleep 0.01 until rumbster.stopped?
+  end
+
+  describe "send email" do
+
+    context  "use a list of email as mail.to (LOGSTASH-827)" do
+
+      it "supports list of emails in to field" do
+        subject = plugin.new("to" => ["email1@host, email2@host"],
+                             "port" => port)
+        subject.register
+        subject.receive(LogStash::Event.new("message" => "hello"))
+        expect(message_observer.messages.size).to eq(1)
+        expect(message_observer.messages[0].to).to eq(["email1@host", "email2@host"])
+      end
+
+      it "multiple *to* addresses in a field" do
+        subject = plugin.new("to" => "%{to_addr}",
+                             "port" => port)
+        subject.register
+        subject.receive(LogStash::Event.new("message" => "hello",
+                                            "to_addr" => ["email1@host", "email2@host"]))
+        expect(message_observer.messages.size).to eq(1)
+        expect(message_observer.messages[0].to).to eq(["email1@host", "email2@host"])
+      end
+
+    end
+
+    context  "multi-lined text body (LOGSTASH-841)" do
+      it "handles multiline messages" do
+        subject = plugin.new("to" => "me@host",
+                             "subject" => "Hello World",
+                             "body" => "Line1\\nLine2\\nLine3",
+                             "port" => port)
+        subject.register
+        subject.receive(LogStash::Event.new("message" => "hello"))
+        expect(message_observer.messages.size).to eq(1)
+        expect(message_observer.messages[0].subject).to eq("Hello World")
+        expect(message_observer.messages[0].body.raw_source).to eq("Line1\r\nLine2\r\nLine3\r\n")
+      end
+
+      context  "use nil authenticationType (LOGSTASH-559)" do
+        it "reads messages correctly" do
+          subject = plugin.new("to" => "me@host",
+                               "subject" => "Hello World",
+                               "body" => "Line1\\nLine2\\nLine3",
+                               "port" => port)
+          subject.register
+          subject.receive(LogStash::Event.new("message" => "hello"))
+          expect(message_observer.messages.size).to eq(1)
+          expect(message_observer.messages[0].subject).to eq("Hello World")
+          expect(message_observer.messages[0].body.raw_source).to eq("Line1\r\nLine2\r\nLine3\r\n")
+        end
+
+
+        context "having no connection to the email server" do
+
+          subject     { plugin.new("to" => "me@host") }
+          let(:event) { LogStash::Event.new("message" => "hello world") }
+
+          before(:each) do
+            subject.register
+          end
+
+          it "should send without throwing an error" do
+            expect { subject.receive(event) }.not_to raise_error
+          end
+        end
+
+      end
+    end
+
+    context  "mustache template for email body" do
+      it "uses the template file" do
+        subject = plugin.new("to" => "me@host",
+                             "subject" => "Hello World",
+                             "template_file" => File.dirname(__FILE__) + "/../fixtures/template.mustache",
+                             "port" => port)
+        subject.register
+        subject.receive(LogStash::Event.new("message" => "hello"))
+
+        expect(message_observer.messages.size).to eq(1)
+        expect(message_observer.messages[0].subject).to eq("Hello World")
+        expect(message_observer.messages[0].body.decoded).to eq(craft_multi_part_email('', '<h1>hello</h1>', message_observer.messages[0].content_type))
+      end
+    end
+
+    context  "custom headers for email" do
+      it "adds custom headers" do
+        headers = { "header_1" => "header_1_value", "header_2" => "header_2_value" } 
+        subject = plugin.new("to" => "me@host",
+                     "subject" => "Hello World",
+                     "body" => "Line1\\nLine2\\nLine3",
+                     "port" => port,
+                     "custom_headers" => headers )
+        subject.register
+        subject.receive(LogStash::Event.new("message" => "hello"))
+        expect(message_observer.messages.size).to eq(1)
+        headers.each do |key, value|
+          expect(message_observer.messages[0].header[key].value).to eq(value)
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+require "logstash/devutils/rspec/spec_helper"
+
+# use a dummy NOOP filter to test Filters::Base
+class LogStash::Filters::NOOP < LogStash::Filters::Base
+  config_name "noop"
+  milestone 2
+
+  def register; end
+
+  def filter(event)
+    
+    filter_matched(event)
+  end
+end
+
+def craft_multi_part_email(body, htmlbody, content_type)
+  charset = "charset=UTF-8"
+  content_encoding = "Content-Transfer-Encoding: 7bit"
+ 
+  # Have to get the generated part of the header, eg:
+  # --==_mimepart_5a462a1fda04b_efe7d032127
+  mimetype = content_type.split('; ')[1][10..-2]
+
+  plain_header = "\n--#{mimetype}\nContent-Type: text/plain;\n #{charset}\n#{content_encoding}\n\n"
+  html_header = "\n--#{mimetype}\nContent-Type: text/html;\n #{charset}\n#{content_encoding}\n\n"
+
+  "#{plain_header}#{body}#{html_header}#{htmlbody}\n\n--#{mimetype}--\n"
+end

metadata

@@ -0,0 +1,180 @@
+--- !ruby/object:Gem::Specification
+name: logstash-output-email-v2
+version: !ruby/object:Gem::Version
+  version: 4.2.0
+platform: ruby
+authors:
+- Elastic
+- kingjan1999
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-10-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.60'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '2.99'
+  name: logstash-core-plugin-api
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.60'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '2.99'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.1
+  name: mail
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.1
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  name: mime-types
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.99.8
+  name: mustache
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.99.8
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: logstash-devutils
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: rumbster
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: logstash-input-generator
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: gserver
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+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
+email: info@elastic.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTORS
+- Gemfile
+- LICENSE
+- NOTICE.TXT
+- README.md
+- docs/index.asciidoc
+- lib/logstash/outputs/email.rb
+- logstash-output-email.gemspec
+- spec/fixtures/template.mustache
+- spec/outputs/email_spec.rb
+- spec/spec_helper.rb
+homepage: http://www.elastic.co/guide/en/logstash/current/index.html
+licenses:
+- Apache License (2.0)
+metadata:
+  logstash_plugin: 'true'
+  logstash_group: output
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.14
+signing_key:
+specification_version: 4
+summary: Sends email to a specified address when output is received
+test_files:
+- spec/fixtures/template.mustache
+- spec/outputs/email_spec.rb
+- spec/spec_helper.rb