logstash-input-imapraw 1.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 54b85a06d69130945966fee8803084ca26eaa72224f43cf7ef93b2fe4e9383a5
+  data.tar.gz: 555a734875551afcfdbb5efe5c5b5bd2df2e1b329e8fca452cde20200d5ed506
+SHA512:
+  metadata.gz: c51a852d01d6796620f4b448c20ae4926bf2cc86d192642800e90e0503b71d314db24890f8bf98fa85d699978c61295b3237b012cdda3c29e3995340751e2f4c
+  data.tar.gz: 86def1fa25c92ed4dfadd1195daf8d5f6626c855c4152cdf67de80a67c3b3f3710800482e8cae1f88b77ddfca155a0ba99f0895021cee032498145c93d6731ce

data/CHANGELOG.md

@@ -0,0 +1,35 @@
+## 3.1.0
+  - Adds an option to recursively search the message parts for attachment and inline attachment filenames. If the save_attachments option is set to true, the content of attachments is included in the `attachments.data` field. The attachment data can then be used by the Elasticsearch Ingest Attachment Processor Plugin.
+  [#48](https://github.com/logstash-plugins/logstash-input-imap/pull/48)
+
+## 3.0.7
+  - Added facility to use IMAP uid to retrieve new mails instead of "NOT SEEN" [#36](https://github.com/logstash-plugins/logstash-input-imap/pull/36)
+
+## 3.0.6
+  - Docs: Set the default_codec doc attribute.
+
+## 3.0.5
+  - Update gemspec summary
+
+## 3.0.4
+  - Fix some documentation issues
+
+## 3.0.2
+  - Relax constraint on logstash-core-plugin-api to >= 1.60 <= 2.99
+
+## 3.0.1
+  - Republish all the gems under jruby.
+## 3.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
+# 2.0.5
+  - Depend on logstash-core-plugin-api instead of logstash-core, removing the need to mass update plugins on major releases of logstash
+# 2.0.4
+  - New dependency requirements for logstash-core for the 5.0 release
+## 2.0.3
+ - Fixed fields assignments
+
+## 2.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
+

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:
+* Aaron Mildenstein (untergeek)
+* Bernd Ahlers (bernd)
+* Brad Fritz (bfritz)
+* Colin Surprenant (colinsurprenant)
+* Jason Kendall (coolacid)
+* Jonathan Van Eenwyk (jdve)
+* Jordan Sissel (jordansissel)
+* Philippe Weber (wiibaa)
+* Pier-Hugues Pellerin (ph)
+* Raffael Schmid (luxflux)
+* Richard Pijnenburg (electrical)
+* Sam Doran (samdoran)
+* Sverre Bakke (sbakke)
+* herver (herver)
+
+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 @@
+This is a fork of the logstash plugin that adds a new boolean configuration parameter `save_full_message`, which will not attempt to parse the body of the message and instead save the content without alteration, and the raw bytes to `raw`

data/docs/index.asciidoc

@@ -0,0 +1,215 @@
+:plugin: imap
+:type: input
+: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}"]
+
+=== Imap input plugin
+
+include::{include_path}/plugin_header.asciidoc[]
+
+==== Description
+
+Read mails from IMAP server
+
+Periodically scan an IMAP folder (`INBOX` by default) and move any read messages
+to the trash.
+
+[id="plugins-{type}s-{plugin}-options"]
+==== Imap Input 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}-check_interval>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-content_type>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-delete>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-expunge>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-fetch_count>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-folder>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-host>> |<<string,string>>|Yes
+| <<plugins-{type}s-{plugin}-lowercase_headers>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-password>> |<<password,password>>|Yes
+| <<plugins-{type}s-{plugin}-port>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-save_attachments>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-secure>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-sincedb_path>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-strip_attachments>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-uid_tracking>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-user>> |<<string,string>>|Yes
+| <<plugins-{type}s-{plugin}-verify_cert>> |<<boolean,boolean>>|No
+|=======================================================================
+
+Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
+input plugins.
+
+&nbsp;
+
+[id="plugins-{type}s-{plugin}-check_interval"]
+===== `check_interval`
+
+  * Value type is <<number,number>>
+  * Default value is `300`
+
+
+
+[id="plugins-{type}s-{plugin}-content_type"]
+===== `content_type`
+
+  * Value type is <<string,string>>
+  * Default value is `"text/plain"`
+
+For multipart messages, use the first part that has this
+content-type as the event message.
+
+[id="plugins-{type}s-{plugin}-delete"]
+===== `delete`
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `false`
+
+
+
+[id="plugins-{type}s-{plugin}-expunge"]
+===== `expunge`
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `false`
+
+
+
+[id="plugins-{type}s-{plugin}-fetch_count"]
+===== `fetch_count`
+
+  * Value type is <<number,number>>
+  * Default value is `50`
+
+
+
+[id="plugins-{type}s-{plugin}-folder"]
+===== `folder`
+
+  * Value type is <<string,string>>
+  * Default value is `"INBOX"`
+
+
+
+[id="plugins-{type}s-{plugin}-host"]
+===== `host`
+
+  * This is a required setting.
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+
+
+[id="plugins-{type}s-{plugin}-lowercase_headers"]
+===== `lowercase_headers`
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `true`
+
+
+
+[id="plugins-{type}s-{plugin}-password"]
+===== `password`
+
+  * This is a required setting.
+  * Value type is <<password,password>>
+  * There is no default value for this setting.
+
+
+
+[id="plugins-{type}s-{plugin}-port"]
+===== `port`
+
+  * Value type is <<number,number>>
+  * There is no default value for this setting.
+
+[id="plugins-{type}s-{plugin}-save_attachments"]
+===== `save_attachments`
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `false`
+
+When set to true the content of attachments will be included in the `attachments.data` field.
+
+[id="plugins-{type}s-{plugin}-secure"]
+===== `secure`
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `true`
+
+[id="plugins-{type}s-{plugin}-sincedb_path"]
+===== `sincedb_path`
+
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+Path of the sincedb database file (keeps track of the UID of the last processed
+mail) that will be written to disk. The default will write sincedb file to
+`<path.data>/plugins/inputs/imap` directory.
+NOTE: it must be a file path and not a directory path.
+
+[id="plugins-{type}s-{plugin}-strip_attachments"]
+===== `strip_attachments`
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `false`
+
+
+
+[id="plugins-{type}s-{plugin}-uid_tracking"]
+===== `uid_tracking`
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `false`
+
+When the IMAP input plugin connects to the mailbox for the first time and
+the UID of the last processed mail is not yet known, the unread mails are
+first downloaded and the UID of the last processed mail is saved. From
+this point on, if `uid_tracking` is set to `true`, all new mail will be
+downloaded regardless of whether they are marked as read or unread. This
+allows users or other services to use the mailbox simultaneously with the
+IMAP input plugin. UID of the last processed mail is always saved regardles
+of the `uid_tracking` value, so you can switch its value as needed. In
+transition from the previous IMAP input plugin version, first process at least
+one mail with `uid_tracking` set to `false` to save the UID of the last
+processed mail and then switch `uid_tracking` to `true`.
+
+[id="plugins-{type}s-{plugin}-user"]
+===== `user`
+
+  * This is a required setting.
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+
+
+[id="plugins-{type}s-{plugin}-verify_cert"]
+===== `verify_cert`
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `true`
+
+
+
+
+
+[id="plugins-{type}s-{plugin}-common-options"]
+include::{include_path}/{type}.asciidoc[]
+
+:default_codec!:

data/lib/logstash/inputs/imap.rb

@@ -0,0 +1,245 @@
+# encoding: utf-8
+require "logstash/inputs/base"
+require "logstash/namespace"
+require "logstash/timestamp"
+require "stud/interval"
+require "socket" # for Socket.gethostname
+
+# Read mails from IMAP server
+#
+# Periodically scan an IMAP folder (`INBOX` by default) and move any read messages
+# to the trash.
+class LogStash::Inputs::IMAPRAW < LogStash::Inputs::Base
+  config_name "imap"
+
+  default :codec, "plain"
+
+  config :host, :validate => :string, :required => true
+  config :port, :validate => :number
+
+  config :user, :validate => :string, :required => true
+  config :password, :validate => :password, :required => true
+  config :secure, :validate => :boolean, :default => true
+  config :verify_cert, :validate => :boolean, :default => true
+
+  config :folder, :validate => :string, :default => 'INBOX'
+  config :fetch_count, :validate => :number, :default => 50
+  config :lowercase_headers, :validate => :boolean, :default => true
+  config :check_interval, :validate => :number, :default => 300
+  config :delete, :validate => :boolean, :default => false
+  config :expunge, :validate => :boolean, :default => false
+  config :strip_attachments, :validate => :boolean, :default => false
+  config :save_attachments, :validate => :boolean, :default => false
+  config :save_full_message, :validate => :boolean, :default => false
+
+  # For multipart messages, use the first part that has this
+  # content-type as the event message.
+  config :content_type, :validate => :string, :default => "text/plain"
+
+  # Whether to use IMAP uid to track last processed message
+  config :uid_tracking, :validate => :boolean, :default => false
+
+  # Path to file with last run time metadata
+  config :sincedb_path, :validate => :string, :required => false
+
+  def register
+    require "net/imap" # in stdlib
+    require "mail" # gem 'mail'
+
+    if @secure and not @verify_cert
+      @logger.warn("Running IMAP without verifying the certificate may grant attackers unauthorized access to your mailbox or data")
+    end
+
+    if @port.nil?
+      if @secure
+        @port = 993
+      else
+        @port = 143
+      end
+    end
+
+    # Load last processed IMAP uid from file if exists
+    if @sincedb_path.nil?
+      datapath = File.join(LogStash::SETTINGS.get_value("path.data"), "plugins", "inputs", "imap")
+      # Ensure that the filepath exists before writing, since it's deeply nested.
+      FileUtils::mkdir_p datapath
+      @sincedb_path = File.join(datapath, ".sincedb_" + Digest::MD5.hexdigest("#{@user}_#{@host}_#{@port}_#{@folder}"))
+    end
+    if File.directory?(@sincedb_path)
+      raise ArgumentError.new("The \"sincedb_path\" argument must point to a file, received a directory: \"#{@sincedb_path}\"")
+    end
+    @logger.info("Using \"sincedb_path\": \"#{@sincedb_path}\"")
+    if File.exist?(@sincedb_path)
+      @uid_last_value = File.read(@sincedb_path).to_i
+      @logger.info("Loading \"uid_last_value\": \"#{@uid_last_value}\"")
+    end
+
+    @content_type_re = Regexp.new("^" + @content_type)
+  end # def register
+
+  def connect
+    sslopt = @secure
+    if @secure and not @verify_cert
+        sslopt = { :verify_mode => OpenSSL::SSL::VERIFY_NONE }
+    end
+    imap = Net::IMAP.new(@host, :port => @port, :ssl => sslopt)
+    imap.login(@user, @password.value)
+    return imap
+  end
+
+  def run(queue)
+    @run_thread = Thread.current
+    Stud.interval(@check_interval) do
+      check_mail(queue)
+    end
+  end
+
+  def check_mail(queue)
+    # TODO(sissel): handle exceptions happening during runtime:
+    # EOFError, OpenSSL::SSL::SSLError
+    imap = connect
+    imap.select(@folder)
+    if @uid_tracking && @uid_last_value
+      # If there are no new messages, uid_search returns @uid_last_value
+      # because it is the last message, so we need to delete it.
+      ids = imap.uid_search(["UID", (@uid_last_value+1..-1)]).delete_if { |uid|
+        uid <= @uid_last_value
+      }
+    else
+      ids = imap.uid_search("NOT SEEN")
+    end
+
+    ids.each_slice(@fetch_count) do |id_set|
+      items = imap.uid_fetch(id_set, ["BODY.PEEK[]", "UID"])
+      items.each do |item|
+        next unless item.attr.has_key?("BODY[]")
+        mail = Mail.read_from_string(item.attr["BODY[]"])
+        if @strip_attachments
+          queue << parse_mail(mail.without_attachments!, item)
+        elsif @save_full_message
+          queue << parse_mail(mail, item)
+        else
+          queue << parse_mail(mail, item)
+        end
+        # Mark message as processed
+        @uid_last_value = item.attr["UID"]
+        imap.uid_store(@uid_last_value, '+FLAGS', @delete || @expunge ? :Deleted : :Seen)
+
+        # Stop message processing if it is requested
+        break if stop?
+      end
+
+      # Expunge deleted messages
+      imap.expunge() if @expunge
+
+      # Stop message fetching if it is requested
+      break if stop?
+    end
+
+  rescue => e
+    @logger.error("Encountered error #{e.class}", :message => e.message, :backtrace => e.backtrace)
+    # Do not raise error, check_mail will be invoked in the next run time
+
+  ensure
+    # Close the connection (and ignore errors)
+    imap.close rescue nil
+    imap.disconnect rescue nil
+
+    # Always save @uid_last_value so when tracking is switched from
+    # "NOT SEEN" to "UID" we will continue from first unprocessed message
+    if @uid_last_value
+      @logger.info("Saving \"uid_last_value\": \"#{@uid_last_value}\"")
+      File.write(@sincedb_path, @uid_last_value)
+    end
+  end
+
+  def parse_attachments(mail)
+    attachments = []
+    mail.attachments.each do |attachment|
+      if @save_attachments
+        attachments << { "filename" => attachment.filename, "data" => attachment.body.encoded }
+      else
+        attachments << { "filename" => attachment.filename}
+      end
+    end
+    return attachments
+  end
+
+  def parse_mail(mail, item)
+    # Add a debug message so we can track what message might cause an error later
+    @logger.debug? && @logger.debug("Working with message_id", :message_id => mail.message_id)
+    # TODO(sissel): What should a multipart message look like as an event?
+    # For now, just take the plain-text part and set it as the message.
+    if mail.parts.count == 0
+      # No multipart message, just use the body as the event text
+      message = mail.body.decoded
+    else
+      # Multipart message; use the first text/plain part we find
+      part = mail.parts.find { |p| p.content_type.match @content_type_re } || mail.parts.first
+      message = part.decoded
+
+      # Parse attachments
+      attachments = parse_attachments(mail)
+    end
+
+    @codec.decode(message) do |event|
+      # Use the 'Date' field as the timestamp
+      event.timestamp = LogStash::Timestamp.new(mail.date.to_time)
+
+      # Add fields: Add message.header_fields { |h| h.name=> h.value }
+      mail.header_fields.each do |header|
+        # 'header.name' can sometimes be a Mail::Multibyte::Chars, get it in String form
+        name = @lowercase_headers ? header.name.to_s.downcase : header.name.to_s
+        # Call .decoded on the header in case it's in encoded-word form.
+        # Details at:
+        #   https://github.com/mikel/mail/blob/master/README.md#encodings
+        #   http://tools.ietf.org/html/rfc2047#section-2
+        value = transcode_to_utf8(header.decoded.to_s)
+
+        # Assume we already processed the 'date' above.
+        next if name == "Date"
+
+        case (field = event.get(name))
+        when String
+          # promote string to array if a header appears multiple times
+          # (like 'received')
+          event.set(name, [field, value])
+        when Array
+          field << value
+          event.set(name, field)
+        when nil
+          event.set(name, value)
+        end
+      end
+
+      # Add attachments
+      if attachments && attachments.length > 0
+        event.set('attachments', attachments)
+      end
+
+      #Add Raw Body if configured
+      if @save_full_message
+        event.set('raw_message_body',item.attr["BODY[]"])
+      end
+
+      decorate(event)
+      event
+    end
+  end
+
+  def stop
+    Stud.stop!(@run_thread)
+    $stdin.close
+  end
+
+  private
+
+  # transcode_to_utf8 is meant for headers transcoding.
+  # the mail gem will set the correct encoding on header strings decoding
+  # and we want to transcode it to utf8
+  def transcode_to_utf8(s)
+    unless s.nil?
+      s.encode(Encoding::UTF_8, :invalid => :replace, :undef => :replace)
+    end
+  end
+end

data/logstash-input-imapraw.gemspec

@@ -0,0 +1,31 @@
+Gem::Specification.new do |s|
+
+  s.name            = 'logstash-input-imapraw'
+  s.version         = '1.0.5'
+  s.licenses        = ['Apache License (2.0)']
+  s.summary         = "Reads mail from an IMAP server and publishes the raw body as well as the decoded body"
+  s.description     = "This is a fork with added functionality - 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         = ["Dustin Hawkins"]
+  s.email           = 'dhawkins@resultsgeneration.com'
+  s.homepage        = "http://github.com/dustin-hawkins/logstash-input-imapraw"
+  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" => "input" }
+
+  # Gem dependencies
+  s.add_runtime_dependency "logstash-core-plugin-api", ">= 1.60", "<= 2.99"
+  s.add_runtime_dependency 'logstash-codec-plain'
+  s.add_runtime_dependency 'mail', '~> 2.6.3'
+  s.add_runtime_dependency 'mime-types', '2.6.2'
+  s.add_runtime_dependency 'stud', '~> 0.0.22'
+
+  s.add_development_dependency 'logstash-devutils'
+  s.add_development_dependency 'insist'
+end

data/spec/inputs/imap_spec.rb

@@ -0,0 +1,173 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"
+require "insist"
+require "logstash/devutils/rspec/shared_examples"
+require "logstash/inputs/imap"
+require "mail"
+require "net/imap"
+require "base64"
+
+
+describe LogStash::Inputs::IMAPRAW do
+
+  context "when interrupting the plugin" do
+    it_behaves_like "an interruptible input plugin" do
+      let(:config) do
+        { "type" => "imap",
+          "host" => "localhost",
+          "user" => "logstash",
+          "password" => "secret" }
+      end
+      let(:imap) { double("imap") }
+      let(:ids)  { double("ids") }
+      before(:each) do
+        allow(imap).to receive(:login)
+        allow(imap).to receive(:select)
+        allow(imap).to receive(:close)
+        allow(imap).to receive(:disconnect)
+        allow(imap).to receive(:store)
+        allow(ids).to receive(:each_slice).and_return([])
+
+        allow(imap).to receive(:uid_search).with("NOT SEEN").and_return(ids)
+        allow(Net::IMAP).to receive(:new).and_return(imap)
+      end
+    end
+  end
+
+end
+
+describe LogStash::Inputs::IMAPRAW do
+  user = "logstash"
+  password = "secret"
+  msg_time = Time.new
+  msg_text = "foo\nbar\nbaz"
+  msg_html = "<p>a paragraph</p>\n\n"
+  msg_binary = "\x42\x43\x44"
+  msg_unencoded = "raw text 🐐"
+
+  subject do
+    Mail.new do
+      from     "me@example.com"
+      to       "you@example.com"
+      subject  "logstash imap input test"
+      date     msg_time
+      body     msg_text
+      add_file :filename => "some.html", :content => msg_html
+      add_file :filename => "image.png", :content => msg_binary
+      add_file :filename => "unencoded.data", :content => msg_unencoded, :content_transfer_encoding => "7bit"
+    end
+  end
+
+  context "with both text and html parts" do
+    context "when no content-type selected" do
+      it "should select text/plain part" do
+        config = {"type" => "imap", "host" => "localhost",
+                  "user" => "#{user}", "password" => "#{password}"}
+
+        input = LogStash::Inputs::IMAPRAW.new config
+        input.register
+        event = input.parse_mail(subject, nil)
+        insist { event.get("message") } == msg_text
+      end
+    end
+
+    context "when text/html content-type selected" do
+      it "should select text/html part" do
+        config = {"type" => "imap", "host" => "localhost",
+                  "user" => "#{user}", "password" => "#{password}",
+                  "content_type" => "text/html"}
+
+        input = LogStash::Inputs::IMAPRAW.new config
+        input.register
+        event = input.parse_mail(subject, nil)
+        insist { event.get("message") } == msg_html
+      end
+    end
+  end
+
+  context "when subject is in RFC 2047 encoded-word format" do
+    it "should be decoded" do
+      subject.subject = "=?iso-8859-1?Q?foo_:_bar?="
+      config = {"type" => "imap", "host" => "localhost",
+                "user" => "#{user}", "password" => "#{password}"}
+
+      input = LogStash::Inputs::IMAPRAW.new config
+      input.register
+      event = input.parse_mail(subject, nil)
+      insist { event.get("subject") } == "foo : bar"
+    end
+  end
+
+  context "with multiple values for same header" do
+    it "should add 2 values as array in event" do
+      subject.received = "test1"
+      subject.received = "test2"
+
+      config = {"type" => "imap", "host" => "localhost",
+                "user" => "#{user}", "password" => "#{password}"}
+
+      input = LogStash::Inputs::IMAPRAW.new config
+      input.register
+      event = input.parse_mail(subject, nil)
+      insist { event.get("received") } == ["test1", "test2"]
+    end
+
+    it "should add more than 2 values as array in event" do
+      subject.received = "test1"
+      subject.received = "test2"
+      subject.received = "test3"
+
+      config = {"type" => "imap", "host" => "localhost",
+                "user" => "#{user}", "password" => "#{password}"}
+
+      input = LogStash::Inputs::IMAPRAW.new config
+      input.register
+      event = input.parse_mail(subject, nil)
+      insist { event.get("received") } == ["test1", "test2", "test3"]
+    end
+  end
+
+  context "when a header field is nil" do
+    it "should parse mail" do
+      subject.header['X-Custom-Header'] = nil
+      config = {"type" => "imap", "host" => "localhost",
+                "user" => "#{user}", "password" => "#{password}"}
+
+      input = LogStash::Inputs::IMAPRAW.new config
+      input.register
+      event = input.parse_mail(subject, nil)
+      insist { event.get("message") } == msg_text
+    end
+  end
+
+  context "with attachments" do
+    it "should extract filenames" do
+      config = {"type" => "imap", "host" => "localhost",
+                "user" => "#{user}", "password" => "#{password}"}
+
+      input = LogStash::Inputs::IMAPRAW.new config
+      input.register
+      event = input.parse_mail(subject, nil)
+      insist { event.get("attachments") } == [
+        {"filename"=>"some.html"},
+        {"filename"=>"image.png"},
+        {"filename"=>"unencoded.data"}
+      ]
+    end
+
+    it "should extract the encoded content" do
+      config = {"type" => "imap", "host" => "localhost",
+        "user" => "#{user}", "password" => "#{password}",
+        "save_attachments" => true}
+
+      input = LogStash::Inputs::IMAPRAW.new config
+      input.register
+      event = input.parse_mail(subject, nil)
+      insist { event.get("attachments") } == [
+        {"data"=> Base64.encode64(msg_html).encode(crlf_newline: true), "filename"=>"some.html"},
+        {"data"=> Base64.encode64(msg_binary).encode(crlf_newline: true), "filename"=>"image.png"},
+        {"data"=> msg_unencoded, "filename"=>"unencoded.data"}
+      ]
+      end
+  end
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: logstash-input-imapraw
+version: !ruby/object:Gem::Version
+  version: 1.0.5
+platform: ruby
+authors:
+- Dustin Hawkins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-06-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logstash-core-plugin-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.60'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '2.99'
+  type: :runtime
+  prerelease: false
+  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
+  name: logstash-codec-plain
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.3
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.6.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.6.2
+- !ruby/object:Gem::Dependency
+  name: stud
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.22
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.22
+- !ruby/object:Gem::Dependency
+  name: logstash-devutils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: insist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This is a fork with added functionality - 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: dhawkins@resultsgeneration.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTORS
+- Gemfile
+- LICENSE
+- NOTICE.TXT
+- README.md
+- docs/index.asciidoc
+- lib/logstash/inputs/imap.rb
+- logstash-input-imapraw.gemspec
+- spec/inputs/imap_spec.rb
+homepage: http://github.com/dustin-hawkins/logstash-input-imapraw
+licenses:
+- Apache License (2.0)
+metadata:
+  logstash_plugin: 'true'
+  logstash_group: input
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Reads mail from an IMAP server and publishes the raw body as well as the
+  decoded body
+test_files:
+- spec/inputs/imap_spec.rb