Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mbovo/imapindexer
A cli tool to index IMAP mailboxes into Elasticsearch / Zincsearch
https://github.com/mbovo/imapindexer
elasticsearch imap imap-client index mailbox search searxng zincsearch
Last synced: 17 days ago
JSON representation
A cli tool to index IMAP mailboxes into Elasticsearch / Zincsearch
- Host: GitHub
- URL: https://github.com/mbovo/imapindexer
- Owner: mbovo
- License: gpl-3.0
- Created: 2023-08-15T11:30:39.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-11T23:04:36.000Z (about 1 year ago)
- Last Synced: 2024-10-20T09:19:45.475Z (2 months ago)
- Topics: elasticsearch, imap, imap-client, index, mailbox, search, searxng, zincsearch
- Language: Go
- Homepage:
- Size: 77.1 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# IMAP Indexer
A simple cli tool to index IMAP mailboxes into a ZincSearch / Elasticsearch.
[](https://asciinema.org/a/T09JMxz2qxDqMU6oh73QGBx0c)
## Usage
```
$ imapindexer --help
imapindexer Copyright (C) 2023 Manuel Bovo
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
See .
Index all emails messages of your IMAP mailboxes and store
them into a ZincSearch/Elasticsearch to made them fully searchable.
Usage:
imapindexer [flags]
Flags:
-c, --config string config file (default is $HOME/.imapindexer.yaml)
-d, --debug Enable debug mode
-h, --help help for imapindexer
--imap.address string IMAP server address
--imap.mailbox string IMAP mailbox pattern (default "INBOX")
--imap.password string IMAP password
--imap.username string IMAP username
--indexer.batch int Number of message to send to ZincSearch in a single batch (default 100)
--indexer.buffer int Size of buffer for messages channel (default 100)
--indexer.workers int Number of imap workers to use (default 1)
--zinc.address string ZincSearch server address
--zinc.index string ZincSearch index name (default "mail_index")
--zinc.password string ZincSearch password
--zinc.username string ZincSearch username
```
## Configuration
The configuration file is a YAML file with the following structure:
Default configuration file is `$HOME/.imapindexer.yaml` or you can specify a custom one with the `--config` flag.
```yaml
imap:
address: imap.server.tld:993
username: [email protected]
password: imap_password
mailbox: INBOX # IMAP mailbox pattern (eg: INBOX, INBOX/Spam, INBOX/Spam/* etc)
zinc:
password: Complexpass#123
username: admin
address: http://localhost:4080
index: mail_index # ZincSearch index name
indexer:
batch: 50 # number of message to send to ZincSearch in a single batch
buffer: 100 # size of buffer for messages channel
workers: 10 # number of imap threads to use
```
## Build
It uses [Task](https://taskfile.dev) and [GoReleaser](https://goreleaser.com) to build the binary.
```bash
$ task build
```
## License
This project is licensed under the terms of the GPLv3 license.
## Development
You will need a ZincSearch instance running on your machine to run the tests.
You can setup local development using `task setup`
### Dependencies
- [Task](https://taskfile.dev)
- [GoReleaser](https://goreleaser.com)
- [Go](https://golang.org)
- [pre-commit](https://pre-commit.com)