{"id":37391372,"url":"https://github.com/jeboehm/fetchmailmgr","last_synced_at":"2026-01-16T05:32:23.540Z","repository":{"id":284455596,"uuid":"952568242","full_name":"jeboehm/fetchmailmgr","owner":"jeboehm","description":"fetchmailmgr is a bridge between fetchmail and docker-mailserver","archived":false,"fork":false,"pushed_at":"2026-01-15T05:47:51.000Z","size":134,"stargazers_count":1,"open_issues_count":5,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-01-15T11:59:42.222Z","etag":null,"topics":["docker-mailserver","fetchmail"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/jeboehm.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":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-03-21T13:53:55.000Z","updated_at":"2026-01-12T01:14:42.000Z","dependencies_parsed_at":"2025-03-26T01:32:59.679Z","dependency_job_id":"ee02a86a-3cbb-44ad-b321-08c1c10331e3","html_url":"https://github.com/jeboehm/fetchmailmgr","commit_stats":null,"previous_names":["jeboehm/fetchmailmgr"],"tags_count":34,"template":false,"template_full_name":null,"purl":"pkg:github/jeboehm/fetchmailmgr","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jeboehm%2Ffetchmailmgr","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jeboehm%2Ffetchmailmgr/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jeboehm%2Ffetchmailmgr/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jeboehm%2Ffetchmailmgr/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jeboehm","download_url":"https://codeload.github.com/jeboehm/fetchmailmgr/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jeboehm%2Ffetchmailmgr/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28477299,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-16T03:13:13.607Z","status":"ssl_error","status_checked_at":"2026-01-16T03:11:47.863Z","response_time":107,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["docker-mailserver","fetchmail"],"created_at":"2026-01-16T05:32:22.944Z","updated_at":"2026-01-16T05:32:23.535Z","avatar_url":"https://github.com/jeboehm.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# fetchmailmgr\n\n[![Application tests](https://github.com/jeboehm/fetchmailmgr/actions/workflows/test.yml/badge.svg)](https://github.com/jeboehm/fetchmailmgr/actions/workflows/test.yml)\n\n`fetchmailmgr` is a bridge between `fetchmail` and `docker-mailserver`. It fetches emails from external mail providers and delivers them to\nthe `docker-mailserver`. The configuration is managed by `mailserver-admin`, the management interface for `docker-mailserver`.\n\n## Usage\n\n### Environment Variables\n\n- `REDIS_URL`: The URL of the Redis server. Default is `redis://localhost:6379`.\n- `TEMP_DIR`: The directory used for temporary files. Default is `/run/fetchmailmgr`.\n- `FETCHMAIL_SMTP_ADDRESS`: The SMTP address for mail delivery. Accepts host:port or just host. This variable is required.\n- `FETCHMAIL_USE_LMTP`: Enable LMTP (Local Mail Transfer Protocol) for mail delivery. Accepts `true` or `false`. Default is `false`.\n- `FETCHMAIL_PATH`: The path to the `fetchmail` executable. Default is `/usr/bin/fetchmail`.\n\n### Command Line Options\n\n- `-d, --debug`: Output extra debugging information.\n- `-i, --interval \u003cinterval\u003e`: Interval in seconds to run fetchmail. Default is `60`.\n- `-s, --server \u003cserver\u003e`: Host to listen for health check requests. Default is `0.0.0.0`.\n- `-p, --port \u003cport\u003e`: Port to listen for health check requests. Default is `3000`.\n\n`fetchmailmgr` is a bridge between `fetchmail` and `docker-mailserver`. It fetches emails from external mail providers and delivers them to the `docker-mailserver`. The configuration is managed by `mailserver-admin`, the management interface for `docker-mailserver`.\n\n## How `fetchmailmgr` Functions\n\n1. **Configuration**: The configuration details for email accounts are stored in Redis under the key `fetchmail_accounts`. These details are read and used to manage the fetching of emails.\n\n2. **Account Object**: The `account` object represents the configuration details for an email account. It includes various properties that define how to connect to the email server and how to handle the emails.\n\n3. **Fetching Emails**: The `fetchmailmgr` uses the `fetchmail` executable to fetch emails from the configured email accounts. It constructs the necessary configuration files and executes `fetchmail` with the appropriate arguments.\n\n### Account Object\n\nThe `account` object has the following properties:\n\n- `id`: A unique identifier for the account.\n- `host`: The hostname of the email server.\n- `protocol`: The protocol used to connect to the email server (e.g., `IMAP`, `POP3`).\n- `port`: The port number to connect to the email server.\n- `username`: The username for the email account.\n- `password`: The password for the email account.\n- `ssl`: A boolean indicating whether to use SSL or implicit TLS for the connection.\n- `verifySsl`: A boolean indicating whether to verify the SSL certificate.\n- `user`: The local user to deliver the emails to.\n\n### Example of the `fetchmail_accounts` key in Redis:\n\n```json\n[\n  {\n    \"id\": 1,\n    \"host\": \"mail.example.com\",\n    \"protocol\": \"IMAP\",\n    \"port\": 993,\n    \"username\": \"user@example.com\",\n    \"password\": \"password123\",\n    \"ssl\": true,\n    \"verifySsl\": true,\n    \"user\": \"localuser\"\n  }\n]\n```\n\n## Testing\n\nThe project includes a comprehensive test suite using Jest. To run the tests:\n\n```bash\n# Install dependencies\nnpm install\n\n# Run all tests\nnpm test\n\n# Run tests in watch mode\nnpm run test:watch\n\n# Run tests with coverage report\nnpm run test:coverage\n```\n\n## Development\n\nTo add a prefilled `fetchmail_accounts` key to Redis using `docker compose`, follow these steps:\n\nStart the services:\n\n```bash\ndocker-compose up\n```\n\nPrefill the fetchmail_accounts key in Redis:\n\n```bash\ndocker-compose exec redis redis-cli \\\n  SET fetchmail_accounts '[{\"id\":1,\"host\":\"mail.example.com\",\"protocol\":\"IMAP\",\"port\":993,\"username\":\"user@example.com\",\"password\":\"password123\",\"ssl\":true,\"verifySsl\":true,\"user\":\"localuser\"}]'\n```\n\nThese commands will start the services and set the `fetchmail_accounts` key in Redis with the specified data.\nThis will put fetchmailmgr in a state where it will fetch emails from the specified email account.\n\n## Links\n\n- [docker-mailserver](https://github.com/jeboehm/docker-mailserver)\n- [mailserver-admin](https://github.com/jeboehm/mailserver-admin)\n- [Issues](https://github.com/jeboehm/docker-mailserver/issues)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjeboehm%2Ffetchmailmgr","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjeboehm%2Ffetchmailmgr","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjeboehm%2Ffetchmailmgr/lists"}