{"id":39620450,"url":"https://github.com/dovecot/doveadm-http-cli","last_synced_at":"2026-01-18T08:25:30.629Z","repository":{"id":145812071,"uuid":"339387989","full_name":"dovecot/doveadm-http-cli","owner":"dovecot","description":" Python CLI client for Dovecot doveadm HTTP api ","archived":false,"fork":false,"pushed_at":"2025-01-24T18:26:19.000Z","size":14,"stargazers_count":5,"open_issues_count":0,"forks_count":2,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-01-24T19:27:57.803Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dovecot.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":"2021-02-16T12:14:06.000Z","updated_at":"2025-01-24T18:26:24.000Z","dependencies_parsed_at":"2023-04-18T04:03:00.477Z","dependency_job_id":null,"html_url":"https://github.com/dovecot/doveadm-http-cli","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/dovecot/doveadm-http-cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dovecot%2Fdoveadm-http-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dovecot%2Fdoveadm-http-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dovecot%2Fdoveadm-http-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dovecot%2Fdoveadm-http-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dovecot","download_url":"https://codeload.github.com/dovecot/doveadm-http-cli/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dovecot%2Fdoveadm-http-cli/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28534143,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-18T00:39:45.795Z","status":"online","status_checked_at":"2026-01-18T02:00:07.578Z","response_time":98,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2026-01-18T08:25:30.549Z","updated_at":"2026-01-18T08:25:30.617Z","avatar_url":"https://github.com/dovecot.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Python CLI client for Doveadm HTTP API\n\ndoveadm-http-cli is a PoC client for Dovecot doveadm HTTP API written in\npython.\n\nOn startup it will connect to the API and fetch all available commands and\ntheir accepted parameters.\n\nTab completion is available.\n\n## Usage\n\nFirst enable\n[Doveadm HTTP API](https://doc.dovecot.org/main/core/admin/doveadm.html#http-api).\n\nNext, install the necessary Python requirements (`requirements.txt`). It is\nrecommended to use [venv](https://docs.python.org/3/library/venv.html) for this\npurpose.\n\n```\npython3 -m venv venv\n. venv/bin/activate\npip install -r requirements.txt\n```\n\nThen run the client:\n```\n./doveadm_cli.py --apikey doveadm_apikey --apiurl http://host:port/doveadm/v1\n```\nor\n```\n./doveadm_cli.py --password doveadm_password --apiurl http://host:port/doveadm/v1\n```\n\nUse \\\u003cTAB\\\u003e to expand commands/parameters.\n\n### Advanced\n\nUse command `debug` to enable printing curl commands for API calls.\n\n### Example\n\n```\n$ ./doveadm_cli.py --apikey someapikey --apiurl http://127.0.0.1:8080/doveadm/v1\n=== Doveadm HTTP CLI ===\n - Array type parameters should be comma separated\n - EOF can be specified as a special value for multiline input.\n - Command 'debug' can be used to enable debug printing curl command for each command.\n - 'commands' can be used to display all available commands.\n - Use tab to complete commands/parameters.\n\n(doveadm) debug\nDebug set to True\n(doveadm) mailboxStatus user=testuser1 mailboxMask=INBOX field=messages\n\ncurl -H \"Authorization: X-Dovecot-API anV1c3RvNjY2\" -H \"Content-Type: application/json\" -d '[[\"mailboxStatus\", {\"field\": [\"messages\"], \"mailboxMask\": [\"INBOX\"], \"user\": \"testuser1\"}, \"c01\"]]' http://10.211.55.7:8080/doveadm/v1\n\n[\n    {\n        \"mailbox\": \"INBOX\",\n        \"messages\": \"35\"\n    }\n]\nResults: 1\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdovecot%2Fdoveadm-http-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdovecot%2Fdoveadm-http-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdovecot%2Fdoveadm-http-cli/lists"}