logstash-input-imap 3.0.3 → 3.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/CHANGELOG.md +16 -0
- data/LICENSE +199 -10
- data/docs/index.asciidoc +55 -16
- data/lib/logstash/inputs/imap.rb +80 -15
- data/logstash-input-imap.gemspec +3 -2
- data/spec/inputs/imap_spec.rb +39 -1
- metadata +21 -5
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
|
-
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
2
|
+
SHA256:
|
|
3
|
+
metadata.gz: 3660e0f1f79393223c4350026f3702f6c755b374bd1fcd8d9ca64fe60be0b17d
|
|
4
|
+
data.tar.gz: c65caa46e847c7471f67272e569a122d6939a11274a743d7c587afe177503c66
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 21f6ab147a10aba0648f9257f22a6d7eb0d78ec7026529aed2196cfc0c0c5560ab7b220c0f3ab01e96203752a5aaf8ca72b9af0363a478797f4c198de5c4497d
|
|
7
|
+
data.tar.gz: 8396ea0d0196edec2b346bfb6a0a375c55961465f4dac5f4738f243058024a0fe179b02caf6bbf8b5c71ab8e9c7e2bd6371a25b7c1c69f0fe3b7a8e99303660b
|
data/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,19 @@
|
|
|
1
|
+
## 3.1.0
|
|
2
|
+
- 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.
|
|
3
|
+
[#48](https://github.com/logstash-plugins/logstash-input-imap/pull/48)
|
|
4
|
+
|
|
5
|
+
## 3.0.7
|
|
6
|
+
- 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)
|
|
7
|
+
|
|
8
|
+
## 3.0.6
|
|
9
|
+
- Docs: Set the default_codec doc attribute.
|
|
10
|
+
|
|
11
|
+
## 3.0.5
|
|
12
|
+
- Update gemspec summary
|
|
13
|
+
|
|
14
|
+
## 3.0.4
|
|
15
|
+
- Fix some documentation issues
|
|
16
|
+
|
|
1
17
|
## 3.0.2
|
|
2
18
|
- Relax constraint on logstash-core-plugin-api to >= 1.60 <= 2.99
|
|
3
19
|
|
data/LICENSE
CHANGED
|
@@ -1,13 +1,202 @@
|
|
|
1
|
-
Copyright (c) 2012–2016 Elasticsearch <http://www.elastic.co>
|
|
2
1
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
6
5
|
|
|
7
|
-
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
8
7
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright 2020 Elastic and contributors
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
data/docs/index.asciidoc
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
:plugin: imap
|
|
2
2
|
:type: input
|
|
3
|
+
:default_codec: plain
|
|
3
4
|
|
|
4
5
|
///////////////////////////////////////////
|
|
5
6
|
START - GENERATED VARIABLES, DO NOT EDIT!
|
|
@@ -12,7 +13,7 @@ START - GENERATED VARIABLES, DO NOT EDIT!
|
|
|
12
13
|
END - GENERATED VARIABLES, DO NOT EDIT!
|
|
13
14
|
///////////////////////////////////////////
|
|
14
15
|
|
|
15
|
-
[id="plugins-{type}-{plugin}"]
|
|
16
|
+
[id="plugins-{type}s-{plugin}"]
|
|
16
17
|
|
|
17
18
|
=== Imap input plugin
|
|
18
19
|
|
|
@@ -43,8 +44,11 @@ This plugin supports the following configuration options plus the < |
|
|
43
44
|
| <<plugins-{type}s-{plugin}-lowercase_headers>> |<<boolean,boolean>>|No
|
|
44
45
|
| <<plugins-{type}s-{plugin}-password>> |<<password,password>>|Yes
|
|
45
46
|
| <<plugins-{type}s-{plugin}-port>> |<<number,number>>|No
|
|
47
|
+
| <<plugins-{type}s-{plugin}-save_attachments>> |<<boolean,boolean>>|No
|
|
46
48
|
| <<plugins-{type}s-{plugin}-secure>> |<<boolean,boolean>>|No
|
|
49
|
+
| <<plugins-{type}s-{plugin}-sincedb_path>> |<<string,string>>|No
|
|
47
50
|
| <<plugins-{type}s-{plugin}-strip_attachments>> |<<boolean,boolean>>|No
|
|
51
|
+
| <<plugins-{type}s-{plugin}-uid_tracking>> |<<boolean,boolean>>|No
|
|
48
52
|
| <<plugins-{type}s-{plugin}-user>> |<<string,string>>|Yes
|
|
49
53
|
| <<plugins-{type}s-{plugin}-verify_cert>> |<<boolean,boolean>>|No
|
|
50
54
|
|=======================================================================
|
|
@@ -55,7 +59,7 @@ input plugins.
|
|
|
55
59
|
|
|
56
60
|
|
|
57
61
|
[id="plugins-{type}s-{plugin}-check_interval"]
|
|
58
|
-
===== `check_interval`
|
|
62
|
+
===== `check_interval`
|
|
59
63
|
|
|
60
64
|
* Value type is <<number,number>>
|
|
61
65
|
* Default value is `300`
|
|
@@ -63,7 +67,7 @@ input plugins.
|
|
|
63
67
|
|
|
64
68
|
|
|
65
69
|
[id="plugins-{type}s-{plugin}-content_type"]
|
|
66
|
-
===== `content_type`
|
|
70
|
+
===== `content_type`
|
|
67
71
|
|
|
68
72
|
* Value type is <<string,string>>
|
|
69
73
|
* Default value is `"text/plain"`
|
|
@@ -72,7 +76,7 @@ For multipart messages, use the first part that has this
|
|
|
72
76
|
content-type as the event message.
|
|
73
77
|
|
|
74
78
|
[id="plugins-{type}s-{plugin}-delete"]
|
|
75
|
-
===== `delete`
|
|
79
|
+
===== `delete`
|
|
76
80
|
|
|
77
81
|
* Value type is <<boolean,boolean>>
|
|
78
82
|
* Default value is `false`
|
|
@@ -80,7 +84,7 @@ content-type as the event message.
|
|
|
80
84
|
|
|
81
85
|
|
|
82
86
|
[id="plugins-{type}s-{plugin}-expunge"]
|
|
83
|
-
===== `expunge`
|
|
87
|
+
===== `expunge`
|
|
84
88
|
|
|
85
89
|
* Value type is <<boolean,boolean>>
|
|
86
90
|
* Default value is `false`
|
|
@@ -88,7 +92,7 @@ content-type as the event message.
|
|
|
88
92
|
|
|
89
93
|
|
|
90
94
|
[id="plugins-{type}s-{plugin}-fetch_count"]
|
|
91
|
-
===== `fetch_count`
|
|
95
|
+
===== `fetch_count`
|
|
92
96
|
|
|
93
97
|
* Value type is <<number,number>>
|
|
94
98
|
* Default value is `50`
|
|
@@ -96,7 +100,7 @@ content-type as the event message.
|
|
|
96
100
|
|
|
97
101
|
|
|
98
102
|
[id="plugins-{type}s-{plugin}-folder"]
|
|
99
|
-
===== `folder`
|
|
103
|
+
===== `folder`
|
|
100
104
|
|
|
101
105
|
* Value type is <<string,string>>
|
|
102
106
|
* Default value is `"INBOX"`
|
|
@@ -104,7 +108,7 @@ content-type as the event message.
|
|
|
104
108
|
|
|
105
109
|
|
|
106
110
|
[id="plugins-{type}s-{plugin}-host"]
|
|
107
|
-
===== `host`
|
|
111
|
+
===== `host`
|
|
108
112
|
|
|
109
113
|
* This is a required setting.
|
|
110
114
|
* Value type is <<string,string>>
|
|
@@ -113,7 +117,7 @@ content-type as the event message.
|
|
|
113
117
|
|
|
114
118
|
|
|
115
119
|
[id="plugins-{type}s-{plugin}-lowercase_headers"]
|
|
116
|
-
===== `lowercase_headers`
|
|
120
|
+
===== `lowercase_headers`
|
|
117
121
|
|
|
118
122
|
* Value type is <<boolean,boolean>>
|
|
119
123
|
* Default value is `true`
|
|
@@ -121,7 +125,7 @@ content-type as the event message.
|
|
|
121
125
|
|
|
122
126
|
|
|
123
127
|
[id="plugins-{type}s-{plugin}-password"]
|
|
124
|
-
===== `password`
|
|
128
|
+
===== `password`
|
|
125
129
|
|
|
126
130
|
* This is a required setting.
|
|
127
131
|
* Value type is <<password,password>>
|
|
@@ -130,31 +134,64 @@ content-type as the event message.
|
|
|
130
134
|
|
|
131
135
|
|
|
132
136
|
[id="plugins-{type}s-{plugin}-port"]
|
|
133
|
-
===== `port`
|
|
137
|
+
===== `port`
|
|
134
138
|
|
|
135
139
|
* Value type is <<number,number>>
|
|
136
140
|
* There is no default value for this setting.
|
|
137
141
|
|
|
142
|
+
[id="plugins-{type}s-{plugin}-save_attachments"]
|
|
143
|
+
===== `save_attachments`
|
|
138
144
|
|
|
145
|
+
* Value type is <<boolean,boolean>>
|
|
146
|
+
* Default value is `false`
|
|
147
|
+
|
|
148
|
+
When set to true the content of attachments will be included in the `attachments.data` field.
|
|
139
149
|
|
|
140
150
|
[id="plugins-{type}s-{plugin}-secure"]
|
|
141
|
-
===== `secure`
|
|
151
|
+
===== `secure`
|
|
142
152
|
|
|
143
153
|
* Value type is <<boolean,boolean>>
|
|
144
154
|
* Default value is `true`
|
|
145
155
|
|
|
156
|
+
[id="plugins-{type}s-{plugin}-sincedb_path"]
|
|
157
|
+
===== `sincedb_path`
|
|
158
|
+
|
|
159
|
+
* Value type is <<string,string>>
|
|
160
|
+
* There is no default value for this setting.
|
|
146
161
|
|
|
162
|
+
Path of the sincedb database file (keeps track of the UID of the last processed
|
|
163
|
+
mail) that will be written to disk. The default will write sincedb file to
|
|
164
|
+
`<path.data>/plugins/inputs/imap` directory.
|
|
165
|
+
NOTE: it must be a file path and not a directory path.
|
|
147
166
|
|
|
148
167
|
[id="plugins-{type}s-{plugin}-strip_attachments"]
|
|
149
|
-
===== `strip_attachments`
|
|
168
|
+
===== `strip_attachments`
|
|
150
169
|
|
|
151
170
|
* Value type is <<boolean,boolean>>
|
|
152
171
|
* Default value is `false`
|
|
153
172
|
|
|
154
173
|
|
|
155
174
|
|
|
175
|
+
[id="plugins-{type}s-{plugin}-uid_tracking"]
|
|
176
|
+
===== `uid_tracking`
|
|
177
|
+
|
|
178
|
+
* Value type is <<boolean,boolean>>
|
|
179
|
+
* Default value is `false`
|
|
180
|
+
|
|
181
|
+
When the IMAP input plugin connects to the mailbox for the first time and
|
|
182
|
+
the UID of the last processed mail is not yet known, the unread mails are
|
|
183
|
+
first downloaded and the UID of the last processed mail is saved. From
|
|
184
|
+
this point on, if `uid_tracking` is set to `true`, all new mail will be
|
|
185
|
+
downloaded regardless of whether they are marked as read or unread. This
|
|
186
|
+
allows users or other services to use the mailbox simultaneously with the
|
|
187
|
+
IMAP input plugin. UID of the last processed mail is always saved regardles
|
|
188
|
+
of the `uid_tracking` value, so you can switch its value as needed. In
|
|
189
|
+
transition from the previous IMAP input plugin version, first process at least
|
|
190
|
+
one mail with `uid_tracking` set to `false` to save the UID of the last
|
|
191
|
+
processed mail and then switch `uid_tracking` to `true`.
|
|
192
|
+
|
|
156
193
|
[id="plugins-{type}s-{plugin}-user"]
|
|
157
|
-
===== `user`
|
|
194
|
+
===== `user`
|
|
158
195
|
|
|
159
196
|
* This is a required setting.
|
|
160
197
|
* Value type is <<string,string>>
|
|
@@ -163,7 +200,7 @@ content-type as the event message.
|
|
|
163
200
|
|
|
164
201
|
|
|
165
202
|
[id="plugins-{type}s-{plugin}-verify_cert"]
|
|
166
|
-
===== `verify_cert`
|
|
203
|
+
===== `verify_cert`
|
|
167
204
|
|
|
168
205
|
* Value type is <<boolean,boolean>>
|
|
169
206
|
* Default value is `true`
|
|
@@ -173,4 +210,6 @@ content-type as the event message.
|
|
|
173
210
|
|
|
174
211
|
|
|
175
212
|
[id="plugins-{type}s-{plugin}-common-options"]
|
|
176
|
-
include::{include_path}/{type}.asciidoc[]
|
|
213
|
+
include::{include_path}/{type}.asciidoc[]
|
|
214
|
+
|
|
215
|
+
:default_codec!:
|
data/lib/logstash/inputs/imap.rb
CHANGED
|
@@ -29,11 +29,18 @@ class LogStash::Inputs::IMAP < LogStash::Inputs::Base
|
|
|
29
29
|
config :delete, :validate => :boolean, :default => false
|
|
30
30
|
config :expunge, :validate => :boolean, :default => false
|
|
31
31
|
config :strip_attachments, :validate => :boolean, :default => false
|
|
32
|
-
|
|
32
|
+
config :save_attachments, :validate => :boolean, :default => false
|
|
33
|
+
|
|
33
34
|
# For multipart messages, use the first part that has this
|
|
34
35
|
# content-type as the event message.
|
|
35
36
|
config :content_type, :validate => :string, :default => "text/plain"
|
|
36
37
|
|
|
38
|
+
# Whether to use IMAP uid to track last processed message
|
|
39
|
+
config :uid_tracking, :validate => :boolean, :default => false
|
|
40
|
+
|
|
41
|
+
# Path to file with last run time metadata
|
|
42
|
+
config :sincedb_path, :validate => :string, :required => false
|
|
43
|
+
|
|
37
44
|
def register
|
|
38
45
|
require "net/imap" # in stdlib
|
|
39
46
|
require "mail" # gem 'mail'
|
|
@@ -50,6 +57,22 @@ class LogStash::Inputs::IMAP < LogStash::Inputs::Base
|
|
|
50
57
|
end
|
|
51
58
|
end
|
|
52
59
|
|
|
60
|
+
# Load last processed IMAP uid from file if exists
|
|
61
|
+
if @sincedb_path.nil?
|
|
62
|
+
datapath = File.join(LogStash::SETTINGS.get_value("path.data"), "plugins", "inputs", "imap")
|
|
63
|
+
# Ensure that the filepath exists before writing, since it's deeply nested.
|
|
64
|
+
FileUtils::mkdir_p datapath
|
|
65
|
+
@sincedb_path = File.join(datapath, ".sincedb_" + Digest::MD5.hexdigest("#{@user}_#{@host}_#{@port}_#{@folder}"))
|
|
66
|
+
end
|
|
67
|
+
if File.directory?(@sincedb_path)
|
|
68
|
+
raise ArgumentError.new("The \"sincedb_path\" argument must point to a file, received a directory: \"#{@sincedb_path}\"")
|
|
69
|
+
end
|
|
70
|
+
@logger.info("Using \"sincedb_path\": \"#{@sincedb_path}\"")
|
|
71
|
+
if File.exist?(@sincedb_path)
|
|
72
|
+
@uid_last_value = File.read(@sincedb_path).to_i
|
|
73
|
+
@logger.info("Loading \"uid_last_value\": \"#{@uid_last_value}\"")
|
|
74
|
+
end
|
|
75
|
+
|
|
53
76
|
@content_type_re = Regexp.new("^" + @content_type)
|
|
54
77
|
end # def register
|
|
55
78
|
|
|
@@ -75,34 +98,68 @@ class LogStash::Inputs::IMAP < LogStash::Inputs::Base
|
|
|
75
98
|
# EOFError, OpenSSL::SSL::SSLError
|
|
76
99
|
imap = connect
|
|
77
100
|
imap.select(@folder)
|
|
78
|
-
|
|
101
|
+
if @uid_tracking && @uid_last_value
|
|
102
|
+
# If there are no new messages, uid_search returns @uid_last_value
|
|
103
|
+
# because it is the last message, so we need to delete it.
|
|
104
|
+
ids = imap.uid_search(["UID", (@uid_last_value+1..-1)]).delete_if { |uid|
|
|
105
|
+
uid <= @uid_last_value
|
|
106
|
+
}
|
|
107
|
+
else
|
|
108
|
+
ids = imap.uid_search("NOT SEEN")
|
|
109
|
+
end
|
|
79
110
|
|
|
80
111
|
ids.each_slice(@fetch_count) do |id_set|
|
|
81
|
-
items = imap.
|
|
112
|
+
items = imap.uid_fetch(id_set, ["BODY.PEEK[]", "UID"])
|
|
82
113
|
items.each do |item|
|
|
83
|
-
next unless item.attr.has_key?("
|
|
84
|
-
mail = Mail.read_from_string(item.attr["
|
|
114
|
+
next unless item.attr.has_key?("BODY[]")
|
|
115
|
+
mail = Mail.read_from_string(item.attr["BODY[]"])
|
|
85
116
|
if @strip_attachments
|
|
86
117
|
queue << parse_mail(mail.without_attachments!)
|
|
87
118
|
else
|
|
88
119
|
queue << parse_mail(mail)
|
|
89
120
|
end
|
|
121
|
+
# Mark message as processed
|
|
122
|
+
@uid_last_value = item.attr["UID"]
|
|
123
|
+
imap.uid_store(@uid_last_value, '+FLAGS', @delete || @expunge ? :Deleted : :Seen)
|
|
124
|
+
|
|
125
|
+
# Stop message processing if it is requested
|
|
126
|
+
break if stop?
|
|
90
127
|
end
|
|
91
128
|
|
|
92
|
-
|
|
93
|
-
|
|
129
|
+
# Expunge deleted messages
|
|
130
|
+
imap.expunge() if @expunge
|
|
131
|
+
|
|
132
|
+
# Stop message fetching if it is requested
|
|
133
|
+
break if stop?
|
|
94
134
|
end
|
|
95
135
|
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
#
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
136
|
+
rescue => e
|
|
137
|
+
@logger.error("Encountered error #{e.class}", :message => e.message, :backtrace => e.backtrace)
|
|
138
|
+
# Do not raise error, check_mail will be invoked in the next run time
|
|
139
|
+
|
|
140
|
+
ensure
|
|
141
|
+
# Close the connection (and ignore errors)
|
|
142
|
+
imap.close rescue nil
|
|
143
|
+
imap.disconnect rescue nil
|
|
144
|
+
|
|
145
|
+
# Always save @uid_last_value so when tracking is switched from
|
|
146
|
+
# "NOT SEEN" to "UID" we will continue from first unprocessed message
|
|
147
|
+
if @uid_last_value
|
|
148
|
+
@logger.info("Saving \"uid_last_value\": \"#{@uid_last_value}\"")
|
|
149
|
+
File.write(@sincedb_path, @uid_last_value)
|
|
102
150
|
end
|
|
151
|
+
end
|
|
103
152
|
|
|
104
|
-
|
|
105
|
-
|
|
153
|
+
def parse_attachments(mail)
|
|
154
|
+
attachments = []
|
|
155
|
+
mail.attachments.each do |attachment|
|
|
156
|
+
if @save_attachments
|
|
157
|
+
attachments << { "filename" => attachment.filename, "data" => attachment.body.encoded }
|
|
158
|
+
else
|
|
159
|
+
attachments << { "filename" => attachment.filename}
|
|
160
|
+
end
|
|
161
|
+
end
|
|
162
|
+
return attachments
|
|
106
163
|
end
|
|
107
164
|
|
|
108
165
|
def parse_mail(mail)
|
|
@@ -117,6 +174,9 @@ class LogStash::Inputs::IMAP < LogStash::Inputs::Base
|
|
|
117
174
|
# Multipart message; use the first text/plain part we find
|
|
118
175
|
part = mail.parts.find { |p| p.content_type.match @content_type_re } || mail.parts.first
|
|
119
176
|
message = part.decoded
|
|
177
|
+
|
|
178
|
+
# Parse attachments
|
|
179
|
+
attachments = parse_attachments(mail)
|
|
120
180
|
end
|
|
121
181
|
|
|
122
182
|
@codec.decode(message) do |event|
|
|
@@ -149,6 +209,11 @@ class LogStash::Inputs::IMAP < LogStash::Inputs::Base
|
|
|
149
209
|
end
|
|
150
210
|
end
|
|
151
211
|
|
|
212
|
+
# Add attachments
|
|
213
|
+
if attachments && attachments.length > 0
|
|
214
|
+
event.set('attachments', attachments)
|
|
215
|
+
end
|
|
216
|
+
|
|
152
217
|
decorate(event)
|
|
153
218
|
event
|
|
154
219
|
end
|
data/logstash-input-imap.gemspec
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
Gem::Specification.new do |s|
|
|
2
2
|
|
|
3
3
|
s.name = 'logstash-input-imap'
|
|
4
|
-
s.version = '3.0
|
|
4
|
+
s.version = '3.1.0'
|
|
5
5
|
s.licenses = ['Apache License (2.0)']
|
|
6
|
-
s.summary = "
|
|
6
|
+
s.summary = "Reads mail from an IMAP server"
|
|
7
7
|
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"
|
|
8
8
|
s.authors = ["Elastic"]
|
|
9
9
|
s.email = 'info@elastic.co'
|
|
@@ -27,4 +27,5 @@ Gem::Specification.new do |s|
|
|
|
27
27
|
s.add_runtime_dependency 'stud', '~> 0.0.22'
|
|
28
28
|
|
|
29
29
|
s.add_development_dependency 'logstash-devutils'
|
|
30
|
+
s.add_development_dependency 'insist'
|
|
30
31
|
end
|
data/spec/inputs/imap_spec.rb
CHANGED
|
@@ -1,8 +1,11 @@
|
|
|
1
1
|
# encoding: utf-8
|
|
2
2
|
require "logstash/devutils/rspec/spec_helper"
|
|
3
|
+
require "insist"
|
|
4
|
+
require "logstash/devutils/rspec/shared_examples"
|
|
3
5
|
require "logstash/inputs/imap"
|
|
4
6
|
require "mail"
|
|
5
7
|
require "net/imap"
|
|
8
|
+
require "base64"
|
|
6
9
|
|
|
7
10
|
|
|
8
11
|
describe LogStash::Inputs::IMAP do
|
|
@@ -25,7 +28,7 @@ describe LogStash::Inputs::IMAP do
|
|
|
25
28
|
allow(imap).to receive(:store)
|
|
26
29
|
allow(ids).to receive(:each_slice).and_return([])
|
|
27
30
|
|
|
28
|
-
allow(imap).to receive(:
|
|
31
|
+
allow(imap).to receive(:uid_search).with("NOT SEEN").and_return(ids)
|
|
29
32
|
allow(Net::IMAP).to receive(:new).and_return(imap)
|
|
30
33
|
end
|
|
31
34
|
end
|
|
@@ -39,6 +42,8 @@ describe LogStash::Inputs::IMAP do
|
|
|
39
42
|
msg_time = Time.new
|
|
40
43
|
msg_text = "foo\nbar\nbaz"
|
|
41
44
|
msg_html = "<p>a paragraph</p>\n\n"
|
|
45
|
+
msg_binary = "\x42\x43\x44"
|
|
46
|
+
msg_unencoded = "raw text 🐐"
|
|
42
47
|
|
|
43
48
|
subject do
|
|
44
49
|
Mail.new do
|
|
@@ -48,6 +53,8 @@ describe LogStash::Inputs::IMAP do
|
|
|
48
53
|
date msg_time
|
|
49
54
|
body msg_text
|
|
50
55
|
add_file :filename => "some.html", :content => msg_html
|
|
56
|
+
add_file :filename => "image.png", :content => msg_binary
|
|
57
|
+
add_file :filename => "unencoded.data", :content => msg_unencoded, :content_transfer_encoding => "7bit"
|
|
51
58
|
end
|
|
52
59
|
end
|
|
53
60
|
|
|
@@ -132,4 +139,35 @@ describe LogStash::Inputs::IMAP do
|
|
|
132
139
|
insist { event.get("message") } == msg_text
|
|
133
140
|
end
|
|
134
141
|
end
|
|
142
|
+
|
|
143
|
+
context "with attachments" do
|
|
144
|
+
it "should extract filenames" do
|
|
145
|
+
config = {"type" => "imap", "host" => "localhost",
|
|
146
|
+
"user" => "#{user}", "password" => "#{password}"}
|
|
147
|
+
|
|
148
|
+
input = LogStash::Inputs::IMAP.new config
|
|
149
|
+
input.register
|
|
150
|
+
event = input.parse_mail(subject)
|
|
151
|
+
insist { event.get("attachments") } == [
|
|
152
|
+
{"filename"=>"some.html"},
|
|
153
|
+
{"filename"=>"image.png"},
|
|
154
|
+
{"filename"=>"unencoded.data"}
|
|
155
|
+
]
|
|
156
|
+
end
|
|
157
|
+
|
|
158
|
+
it "should extract the encoded content" do
|
|
159
|
+
config = {"type" => "imap", "host" => "localhost",
|
|
160
|
+
"user" => "#{user}", "password" => "#{password}",
|
|
161
|
+
"save_attachments" => true}
|
|
162
|
+
|
|
163
|
+
input = LogStash::Inputs::IMAP.new config
|
|
164
|
+
input.register
|
|
165
|
+
event = input.parse_mail(subject)
|
|
166
|
+
insist { event.get("attachments") } == [
|
|
167
|
+
{"data"=> Base64.encode64(msg_html).encode(crlf_newline: true), "filename"=>"some.html"},
|
|
168
|
+
{"data"=> Base64.encode64(msg_binary).encode(crlf_newline: true), "filename"=>"image.png"},
|
|
169
|
+
{"data"=> msg_unencoded, "filename"=>"unencoded.data"}
|
|
170
|
+
]
|
|
171
|
+
end
|
|
172
|
+
end
|
|
135
173
|
end
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: logstash-input-imap
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 3.0
|
|
4
|
+
version: 3.1.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Elastic
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date:
|
|
11
|
+
date: 2020-05-27 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -100,7 +100,23 @@ dependencies:
|
|
|
100
100
|
- - ">="
|
|
101
101
|
- !ruby/object:Gem::Version
|
|
102
102
|
version: '0'
|
|
103
|
-
|
|
103
|
+
- !ruby/object:Gem::Dependency
|
|
104
|
+
requirement: !ruby/object:Gem::Requirement
|
|
105
|
+
requirements:
|
|
106
|
+
- - ">="
|
|
107
|
+
- !ruby/object:Gem::Version
|
|
108
|
+
version: '0'
|
|
109
|
+
name: insist
|
|
110
|
+
prerelease: false
|
|
111
|
+
type: :development
|
|
112
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
113
|
+
requirements:
|
|
114
|
+
- - ">="
|
|
115
|
+
- !ruby/object:Gem::Version
|
|
116
|
+
version: '0'
|
|
117
|
+
description: This gem is a Logstash plugin required to be installed on top of the
|
|
118
|
+
Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This
|
|
119
|
+
gem is not a stand-alone program
|
|
104
120
|
email: info@elastic.co
|
|
105
121
|
executables: []
|
|
106
122
|
extensions: []
|
|
@@ -138,9 +154,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
138
154
|
version: '0'
|
|
139
155
|
requirements: []
|
|
140
156
|
rubyforge_project:
|
|
141
|
-
rubygems_version: 2.
|
|
157
|
+
rubygems_version: 2.6.13
|
|
142
158
|
signing_key:
|
|
143
159
|
specification_version: 4
|
|
144
|
-
summary:
|
|
160
|
+
summary: Reads mail from an IMAP server
|
|
145
161
|
test_files:
|
|
146
162
|
- spec/inputs/imap_spec.rb
|