{"id":19670491,"url":"https://github.com/mat-sz/catchmail-ws","last_synced_at":"2026-05-13T18:33:12.334Z","repository":{"id":128693075,"uuid":"255285624","full_name":"mat-sz/catchmail-ws","owner":"mat-sz","description":"✉️ Self-hosted e-mail debugging tool. (WebSockets backend/TypeScript)","archived":false,"fork":false,"pushed_at":"2021-04-20T16:05:43.000Z","size":140,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-10T03:35:08.370Z","etag":null,"topics":["email","nodejs","smtp-server","typescript","websocket","websockets-server"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause-clear","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mat-sz.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}},"created_at":"2020-04-13T09:38:27.000Z","updated_at":"2021-04-20T16:05:45.000Z","dependencies_parsed_at":"2023-04-05T05:02:49.914Z","dependency_job_id":null,"html_url":"https://github.com/mat-sz/catchmail-ws","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mat-sz%2Fcatchmail-ws","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mat-sz%2Fcatchmail-ws/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mat-sz%2Fcatchmail-ws/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mat-sz%2Fcatchmail-ws/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mat-sz","download_url":"https://codeload.github.com/mat-sz/catchmail-ws/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240980814,"owners_count":19888343,"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","nodejs","smtp-server","typescript","websocket","websockets-server"],"created_at":"2024-11-11T17:06:21.628Z","updated_at":"2026-05-13T18:33:07.299Z","avatar_url":"https://github.com/mat-sz.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# catchmail-ws\n\nWebSockets server for [catchmail-web](https://github.com/mat-sz/catchmail-web).\n\nMore details about the project are available in the [catchmail-web](https://github.com/mat-sz/catchmail-web) repository.\n\n**Check other TypeScript e-mail projects:**\n\n| Rendering (React.js)                                   | Rendering (Vue.js)                                 | Parser                                                 | Inbound SMTP                                   |\n| ------------------------------------------------------ | -------------------------------------------------- | ------------------------------------------------------ | ---------------------------------------------- |\n| [react-letter](https://github.com/mat-sz/react-letter) | [vue-letter](https://github.com/mat-sz/vue-letter) | [letterparser](https://github.com/mat-sz/letterparser) | [microMTA](https://github.com/mat-sz/microMTA) |\n\n## Installation\n\nRun `yarn install`, `yarn build` and then simply run `yarn start`. For development you can also run catchmail-ws with live reload, `yarn dev`. A permission to use port 25 is required (running as superuser is not recommended though, an alternative is to use Docker or authbind/setcap).\n\n## Configuration\n\n`dotenv-flow` is used to manage the configuration.\n\nThe following variables are used for the configuration:\n\n| Variable      | Default value | Description                                                                      |\n| ------------- | ------------- | -------------------------------------------------------------------------------- |\n| `WS_HOST`     | `127.0.0.1`   | IP address to bind to (WebSockets).                                              |\n| `WS_PORT`     | `5000`        | Port to bind to (WebSockets).                                                    |\n| `AUTH_MODE`   | `none`        | Set to `secret` if you'd like to protect your instance with a secret.            |\n| `AUTH_SECRET` | undefined     | Authentication secret for `AUTH_MODE=secret`.                                    |\n| `LOG_MODE`    | `none`        | Set to `file` if you'd like to save all incoming messages.                       |\n| `CACHE_SIZE`  | `0`           | Set to any number above 0 to allow message caching and replaying to new clients. |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmat-sz%2Fcatchmail-ws","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmat-sz%2Fcatchmail-ws","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmat-sz%2Fcatchmail-ws/lists"}