logstash-input-imap 3.2.0 → 3.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61f403ebf9de18a49ba8f7f930ea04484670701909dd70f8d5e67a31706c0806
-  data.tar.gz: 1ec42dda0d258f515c8e2cb67e0ef3f3bd5e7fe61dc16b5916bb3afa020d1dab
+  metadata.gz: 9aa1c16fcc248a5258d5fc8e8b7b726dfde45c5ad57b4b627e8d6b4028f60b93
+  data.tar.gz: 3985ebfce8743fcd664a80e92854f7c02a6a5767735b494f8e239590e925e49c
 SHA512:
-  metadata.gz: e588b5e14d17cc88139fd5a869102a47e42f17f9d0777f59808c2f599bbdf0d76ff4566f21a8ebe4e8761a0665ec10b68c69071beda4be8e40ce541c9de245b3
-  data.tar.gz: baf7c0d8f3ee32cd367c2537b9ede816a1aa2d39741edbf80ffec53792bd80b4395864afc4cd4645e796069f2a79a73dac44551bd6e35553cec4685ee6b7f368
+  metadata.gz: c7d50142174b288474dd2d0c36d1ac1884369f2588bd485814cc749fd534de34bc2bbd4d37a187d53f309f73aa280d7f332e7f513282193948a16663aa75025d
+  data.tar.gz: 5c745ef7f8836481e35c7fdf8f424530a082bf22e3a50b2de06fa667031976d91abf460b2fead7526c0414e2d196951feb09e475d92fef61fcd1be8c13916031

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 3.2.2
+  - Require `mail` dependency 2.9 or greater [#65](https://github.com/logstash-plugins/logstash-input-imap/pull/65)
+    - Fix attachment data encoding regressed by mail upgrade
+
+## 3.2.1
+  - Upgrade `email` dependency so that supports Ruby 3.1. This also fixes the `net-smtp` load regression [#60](https://github.com/logstash-plugins/logstash-input-imap/pull/60)
+
 ## 3.2.0
   - Feat: ECS compatibility [#55](https://github.com/logstash-plugins/logstash-input-imap/pull/55)
     * added (optional) `headers_target` configuration option

data/README.md

@@ -1,6 +1,6 @@
 # Logstash Plugin
 
-[![Travis Build Status](https://travis-ci.com/logstash-plugins/logstash-input-imap.svg)](https://travis-ci.com/logstash-plugins/logstash-input-imap)
+[![Unit Tests](https://github.com/logstash-plugins/logstash-input-imap/actions/workflows/unit-tests.yml/badge.svg?branch=main)](https://github.com/logstash-plugins/logstash-input-imap/actions/workflows/unit-tests.yml)
 
 This is a plugin for [Logstash](https://github.com/elastic/logstash).
 

data/lib/logstash/inputs/imap.rb

@@ -197,7 +197,7 @@ class LogStash::Inputs::IMAP < LogStash::Inputs::Base
     attachments = []
     mail.attachments.each do |attachment|
       if @save_attachments
-        attachments << { "filename" => attachment.filename, "data" => attachment.body.encoded }
+        attachments << { "filename" => attachment.filename, "data" => encode_attachment_data(attachment) }
       else
         attachments << { "filename" => attachment.filename}
       end
@@ -205,6 +205,22 @@ class LogStash::Inputs::IMAP < LogStash::Inputs::Base
     return attachments
   end
 
+  # Re-applies the attachment's transfer encoding ourselves (via Mail::Encodings,
+  # the same encoders `mail` uses internally) instead of relying on Mail::Body#encoded,
+  # whose return value (encoded vs. already-decoded) has varied across `mail` gem versions.
+  # Note: 'binary' is the in-memory default the `mail` gem assigns to non-text
+  # attachments before they've been serialized/re-parsed, so it's treated like 'base64'.
+  def encode_attachment_data(attachment)
+    case attachment.content_transfer_encoding.to_s.downcase
+    when 'base64', 'binary'
+      Mail::Encodings::Base64.encode(attachment.body.decoded)
+    when 'quoted-printable'
+      Mail::Encodings::QuotedPrintable.encode(attachment.body.decoded)
+    else
+      attachment.body.decoded
+    end
+  end
+
   def parse_mail(mail)
     # Add a debug message so we can track what message might cause an error later
     @logger.debug? && @logger.debug("Processing mail", message_id: mail.message_id)

data/logstash-input-imap.gemspec

@@ -1,17 +1,17 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-input-imap'
-  s.version         = '3.2.0'
+  s.version         = ::File.read('version').split("\n").first
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Reads mail from an IMAP server"
   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"]
   s.email           = 'info@elastic.co'
-  s.homepage        = "http://www.elastic.co/guide/en/logstash/current/index.html"
+  s.homepage        = "https://www.elastic.co/logstash"
   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/**/*"]
+  s.files = Dir["lib/**/*","spec/**/*","*.gemspec","*.md","CONTRIBUTORS","Gemfile","LICENSE","NOTICE.TXT", "vendor/jar-dependencies/**/*.jar", "vendor/jar-dependencies/**/*.rb", "VERSION", "version", "docs/**/*"]
 
   # Tests
   s.test_files = s.files.grep(%r{^(test|spec|features)/})
@@ -24,8 +24,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'logstash-mixin-ecs_compatibility_support', '~> 1.3'
   s.add_runtime_dependency 'logstash-mixin-validator_support', '~> 1.0'
   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 'mail', '~> 2.9'
   s.add_runtime_dependency 'stud', '~> 0.0.22'
 
   s.add_development_dependency 'logstash-devutils'

data/spec/inputs/imap_spec.rb

@@ -260,6 +260,33 @@ describe LogStash::Inputs::IMAP, :ecs_compatibility_support do
                                                 {"data"=> msg_unencoded, "filename"=>"unencoded.data"}
                                             ]
       end
+
+      context "with a quoted-printable attachment" do
+        let(:msg_qp) { "café résumé naïve" }
+
+        # round-trip through raw source, same as `check_mail` does via `Mail.read_from_string`,
+        # so the attachment's `content_transfer_encoding` reflects what a real server would send
+        let(:mail) do
+          qp_content = msg_qp
+          raw_mail = 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 => "note.txt", :content => qp_content, :content_transfer_encoding => "quoted-printable"
+          end
+          Mail.read_from_string(raw_mail.encoded)
+        end
+
+        it "should extract the quoted-printable-decoded content re-encoded as quoted-printable" do
+          event = input.parse_mail(mail)
+          target = ecs_compatibility? ? '[@metadata][input][imap][attachments]' : 'attachments'
+          expect( event.get(target) ).to eql [
+                                                  {"data"=> Mail::Encodings::QuotedPrintable.encode(msg_qp), "filename"=>"note.txt"}
+                                              ]
+        end
+      end
     end
 
   end

data/version

@@ -0,0 +1 @@
+3.2.2

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-imap
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.2.2
 platform: ruby
 authors:
 - Elastic
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-06 00:00:00.000000000 Z
+date: 2026-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
+  name: logstash-core-plugin-api
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -19,9 +19,8 @@ dependencies:
     - - "<="
       - !ruby/object:Gem::Version
         version: '2.99'
-  name: logstash-core-plugin-api
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -31,98 +30,84 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.99'
 - !ruby/object:Gem::Dependency
+  name: logstash-mixin-ecs_compatibility_support
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
-  name: logstash-mixin-ecs_compatibility_support
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
+  name: logstash-mixin-validator_support
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-  name: logstash-mixin-validator_support
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
+  name: logstash-codec-plain
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  name: logstash-codec-plain
-  prerelease: false
   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
-  name: mail
-  prerelease: false
+        version: '2.9'
   type: :runtime
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.6.3
-- !ruby/object:Gem::Dependency
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 2.6.2
-  name: mime-types
   prerelease: false
-  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.6.2
+        version: '2.9'
 - !ruby/object:Gem::Dependency
+  name: stud
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.0.22
-  name: stud
-  prerelease: false
   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'
-  name: logstash-devutils
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -146,13 +131,13 @@ files:
 - lib/logstash/inputs/imap.rb
 - logstash-input-imap.gemspec
 - spec/inputs/imap_spec.rb
-homepage: http://www.elastic.co/guide/en/logstash/current/index.html
+- version
+homepage: https://www.elastic.co/logstash
 licenses:
 - Apache License (2.0)
 metadata:
   logstash_plugin: 'true'
   logstash_group: input
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -167,8 +152,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key:
+rubygems_version: 3.6.3
 specification_version: 4
 summary: Reads mail from an IMAP server
 test_files: