{"id":15528539,"url":"https://github.com/mbovo/imapindexer","last_synced_at":"2026-05-19T03:32:04.108Z","repository":{"id":188686364,"uuid":"678787681","full_name":"mbovo/imapindexer","owner":"mbovo","description":"A cli tool to index IMAP mailboxes into Elasticsearch / Zincsearch","archived":false,"fork":false,"pushed_at":"2025-05-07T14:20:17.000Z","size":100,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-05-07T15:27:18.391Z","etag":null,"topics":["elasticsearch","imap","imap-client","index","mailbox","search","searxng","zincsearch"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mbovo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null}},"created_at":"2023-08-15T11:30:39.000Z","updated_at":"2025-05-07T14:20:19.000Z","dependencies_parsed_at":null,"dependency_job_id":"88a12b5b-71bb-441a-aa78-6076cd140c93","html_url":"https://github.com/mbovo/imapindexer","commit_stats":{"total_commits":18,"total_committers":1,"mean_commits":18.0,"dds":0.0,"last_synced_commit":"b066419013d0ceee1871db12178d20ed47e97d53"},"previous_names":["mbovo/imapindexer"],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/mbovo/imapindexer","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mbovo%2Fimapindexer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mbovo%2Fimapindexer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mbovo%2Fimapindexer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mbovo%2Fimapindexer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mbovo","download_url":"https://codeload.github.com/mbovo/imapindexer/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mbovo%2Fimapindexer/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264871343,"owners_count":23676425,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["elasticsearch","imap","imap-client","index","mailbox","search","searxng","zincsearch"],"created_at":"2024-10-02T11:14:12.998Z","updated_at":"2026-05-19T03:32:04.056Z","avatar_url":"https://github.com/mbovo.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# IMAP Indexer\n\nA simple cli tool to index IMAP mailboxes into a ZincSearch / Elasticsearch.\n\n[![asciicast](https://asciinema.org/a/T09JMxz2qxDqMU6oh73QGBx0c.svg)](https://asciinema.org/a/T09JMxz2qxDqMU6oh73QGBx0c)\n\n## Usage\n\n```\n$ imapindexer --help\n\nimapindexer  Copyright (C) 2023  Manuel Bovo\nThis program is free software: you can redistribute it and/or modify\nit under the terms of the GNU General Public License as published by\nthe Free Software Foundation, either version 3 of the License, or\n(at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\nGNU General Public License for more details.\nSee \u003chttps://www.gnu.org/licenses/\u003e.\n\nIndex all emails messages of your IMAP mailboxes and store\nthem into a ZincSearch/Elasticsearch to made them fully searchable.\n\nUsage:\n  imapindexer [flags]\n\nFlags:\n  -c, --config string          config file (default is $HOME/.imapindexer.yaml)\n  -d, --debug                  Enable debug mode\n  -h, --help                   help for imapindexer\n      --imap.address string    IMAP server address\n      --imap.mailbox string    IMAP mailbox pattern (default \"INBOX\")\n      --imap.password string   IMAP password\n      --imap.username string   IMAP username\n      --indexer.batch int      Number of message to send to ZincSearch in a single batch (default 100)\n      --indexer.buffer int     Size of buffer for messages channel (default 100)\n      --indexer.workers int    Number of imap workers to use (default 1)\n      --zinc.address string    ZincSearch server address\n      --zinc.index string      ZincSearch index name (default \"mail_index\")\n      --zinc.password string   ZincSearch password\n      --zinc.username string   ZincSearch username\n```\n\n## Configuration\n\nThe configuration file is a YAML file with the following structure:\nDefault configuration file is `$HOME/.imapindexer.yaml` or you can specify a custom one with the `--config` flag.\n\n```yaml\nimap:\n  address: imap.server.tld:993\n  username: user@server.tld\n  password: imap_password\n  mailbox: INBOX    # IMAP mailbox pattern (eg: INBOX, INBOX/Spam, INBOX/Spam/* etc)\nzinc:\n  password: Complexpass#123\n  username: admin\n  address: http://localhost:4080\n  index: mail_index   # ZincSearch index name\nindexer:\n  batch: 50     # number of message to send to ZincSearch in a single batch\n  buffer: 100   # size of buffer for messages channel\n  workers: 10   # number of imap threads to use\n```\n\n## Build\n\nIt uses [Task](https://taskfile.dev) and [GoReleaser](https://goreleaser.com) to build the binary.\n\n```bash\n$ task build\n```\n\n## License\n\nThis project is licensed under the terms of the GPLv3 license.\n\n## Development\n\nYou will need a ZincSearch instance running on your machine to run the tests.\nYou can setup local development using `task setup`\n\n### Dependencies\n\n- [Task](https://taskfile.dev)\n- [GoReleaser](https://goreleaser.com)\n- [Go](https://golang.org)\n- [pre-commit](https://pre-commit.com)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmbovo%2Fimapindexer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmbovo%2Fimapindexer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmbovo%2Fimapindexer/lists"}