{"id":18305077,"url":"https://github.com/jop-software/imap-mailbox-exporter","last_synced_at":"2025-04-09T10:40:20.810Z","repository":{"id":51799205,"uuid":"520592416","full_name":"jop-software/imap-mailbox-exporter","owner":"jop-software","description":"IMAP Mailbox exporter for prometheus","archived":false,"fork":false,"pushed_at":"2023-11-03T07:05:19.000Z","size":42,"stargazers_count":0,"open_issues_count":5,"forks_count":3,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-15T04:43:47.198Z","etag":null,"topics":["email","email-monitoring","exporter","hacktoberfest","imap","imap-monitoring","monitoring","prometheus-exporter"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jop-software.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-08-02T17:36:16.000Z","updated_at":"2022-10-03T08:32:51.000Z","dependencies_parsed_at":"2024-11-05T15:39:35.859Z","dependency_job_id":"2e7f30e2-1478-441f-8e1b-172f6bd372c5","html_url":"https://github.com/jop-software/imap-mailbox-exporter","commit_stats":{"total_commits":14,"total_committers":1,"mean_commits":14.0,"dds":0.0,"last_synced_commit":"42a2e1a58a27215e8ee6f1821caec40827b50d2a"},"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jop-software%2Fimap-mailbox-exporter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jop-software%2Fimap-mailbox-exporter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jop-software%2Fimap-mailbox-exporter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jop-software%2Fimap-mailbox-exporter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jop-software","download_url":"https://codeload.github.com/jop-software/imap-mailbox-exporter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248022402,"owners_count":21034865,"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":["email","email-monitoring","exporter","hacktoberfest","imap","imap-monitoring","monitoring","prometheus-exporter"],"created_at":"2024-11-05T15:32:36.571Z","updated_at":"2025-04-09T10:40:20.780Z","avatar_url":"https://github.com/jop-software.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Imap Mailbox Exporter\n\n\u003e Export the amount of mails in a mailbox for use in prometheus.\n\n## Usage\n\n### Probe\n\n```txt\nhttp://127.0.0.1:9101/probe?target=INBOX\u0026hostname=imap.example.com\u0026username=me@example.com\n```\n\n### Provided metrics\n\n```txt\n# HELP probe_mailbox_count Displays the count of mails found in the mailbox\n# TYPE probe_mailbox_count gauge\nprobe_mailbox_count 0\n```\n\n### Configuration\n\nThe `imap-mailbox-exporter` can be configures with a `config.yaml` file and environment variables.\n\n```yaml\nserver:\n- hostname: 'imap.example.com'\n  port: '993'\n  accounts:\n    - username: 'me@example.com'\n      password: 'env:E_AT_MAIL_COM_PASSWORD'\n```\n\nYou can use environment variables with the `env:VARIABLE_NAME` directive in YAML.\n\nThe configuration file is expected in `./config.yaml` relative to the `imap-mailbox-exporter` binary.\n\n### Example Usage\n\nYou can find a example docker compose configuration.\n\nMake sure to update `examples/imap-exporter.env` with your imap credentials.\n\n**Start the example container**\n\n```shell\npushd examples\n\ndocker compose pull\ndocker compose up -d\n```\n\n## Compilation\n\nYou can compile the source-code with the `go build` command.\n\n```bash\ngo build -o imap-mailbox-exporter main.go\n```\n\nAlternativly you can use [`gnu make`](https://www.gnu.org/software/make/) with the `make build` command to execute the `go build` command.\n\n\n## License\n\nThis project is licensed under the [MIT License](./LICENCE)\n\n\u003cdiv align=\"center\"\u003e\n    \u003cspan\u003e\u0026copy; 2022, jop-software Inh. Johannes Przymusinski\u003c/span\u003e\n\u003c/div\u003e","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjop-software%2Fimap-mailbox-exporter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjop-software%2Fimap-mailbox-exporter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjop-software%2Fimap-mailbox-exporter/lists"}