{"id":21679231,"url":"https://github.com/alexanderbabel/mail-parser","last_synced_at":"2025-04-12T05:43:02.565Z","repository":{"id":36997966,"uuid":"289490153","full_name":"AlexanderBabel/mail-parser","owner":"AlexanderBabel","description":"A NestJS project, that can parse e-mails and send push notifications.","archived":false,"fork":false,"pushed_at":"2025-04-11T22:56:56.000Z","size":3466,"stargazers_count":5,"open_issues_count":55,"forks_count":1,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-04-12T05:42:47.413Z","etag":null,"topics":["javascript","nestjs","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/AlexanderBabel.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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,"zenodo":null}},"created_at":"2020-08-22T13:11:17.000Z","updated_at":"2024-01-16T17:47:08.000Z","dependencies_parsed_at":"2024-01-12T02:39:41.749Z","dependency_job_id":"42e5bd7e-9965-4882-bae0-738d055104d6","html_url":"https://github.com/AlexanderBabel/mail-parser","commit_stats":null,"previous_names":[],"tags_count":163,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlexanderBabel%2Fmail-parser","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlexanderBabel%2Fmail-parser/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlexanderBabel%2Fmail-parser/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlexanderBabel%2Fmail-parser/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AlexanderBabel","download_url":"https://codeload.github.com/AlexanderBabel/mail-parser/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248525160,"owners_count":21118616,"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":["javascript","nestjs","typescript"],"created_at":"2024-11-25T14:49:48.971Z","updated_at":"2025-04-12T05:43:02.536Z","avatar_url":"https://github.com/AlexanderBabel.png","language":"TypeScript","readme":"# mail-parser\n\nAn extensible NestJS project, that can parse e-mails and send push notifications.\n\nImplemented functionalities:\n- `Deutsche Post Briefankündigung`: Sends a message to Matrix including an image of the mail envelope from the e-mail\n\n## Deutsche Post Briefankündigung\n\nThis functionality takes advantages of the emails send by the Deutsche Post, when a letter is on its way to your mailbox. You need to setup this feature by getting an mail account at web.de or gmx.de. Deutsche Post will sent you a letter to verify your address.\n\nAfterwards, you can setup an app specific password in your mail account. This password is used to connect to the mail server and parse the e-mails.\n\n### Prerequisites\n- A mail account at web.de or gmx.de\n- Enable the `Deutsche Post Briefankündigung` feature in your mail account settings\n- Setup an app specific password in your mail account settings\n- Maubot with the [`hasswebhookbot`](https://github.com/v411e/hasswebhookbot) plugin installed\n- Exposed Maubot endpoint\n- A Matrix room with the Maubot bot to sent the push notification to\n\n### Setup\n\nRun this project with Docker!\n\n```bash\ndocker pull alexbabel/mail-parser:latest\n```\n\ndocker-compose:\n```yaml\nservices:\n  mail-parser:\n    image: alexbabel/mail-parser:latest\n    restart: unless-stopped\n    environment:\n      - MAIL_HOST=mail.example.com\n      - MAIL_PORT=993\n      - MAIL_USER=parse@example.com\n      - MAIL_PASSWORD=\n      - PUSH_ENDPOINT=\n      - MAIL_ANNOUNCEMENT_PUSH_ROOM=\n```\n\n### Environment variables\n| Variable | Description | Example |\n| --- | --- | --- |\n| `MAIL_HOST` | The IMAP mail server to connect to | `imap.example.com` |\n| `MAIL_PORT` | The IMAP port of the mail server | `993` |\n| `MAIL_USER` | The user to connect to the mail server | `parse@example.com` |\n| `MAIL_PASSWORD` | The password to connect to the mail server | `secure-password` |\n| `PUSH_ENDPOINT` | The endpoint to send the push notification to | `https://matrix-bot.example.com/_matrix/maubot/plugin/mail/push/` |\n| `MAIL_ANNOUNCEMENT_PUSH_ROOM` | The Matrix room to send the push notification to | `!LSsicedfgixpqFfsDz:example.com` |\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falexanderbabel%2Fmail-parser","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falexanderbabel%2Fmail-parser","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falexanderbabel%2Fmail-parser/lists"}