{"id":22797366,"url":"https://github.com/the-software-compagny/flower-inbox","last_synced_at":"2025-03-30T18:29:11.301Z","repository":{"id":247842724,"uuid":"823514073","full_name":"The-Software-Compagny/flower-inbox","owner":"The-Software-Compagny","description":null,"archived":false,"fork":false,"pushed_at":"2024-07-10T20:18:24.000Z","size":420,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-02-05T21:00:52.657Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/The-Software-Compagny.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2024-07-03T07:19:59.000Z","updated_at":"2024-07-10T20:18:28.000Z","dependencies_parsed_at":"2024-07-11T00:08:12.617Z","dependency_job_id":null,"html_url":"https://github.com/The-Software-Compagny/flower-inbox","commit_stats":null,"previous_names":["the-software-compagny/flower-inbox"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/The-Software-Compagny%2Fflower-inbox","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/The-Software-Compagny%2Fflower-inbox/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/The-Software-Compagny%2Fflower-inbox/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/The-Software-Compagny%2Fflower-inbox/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/The-Software-Compagny","download_url":"https://codeload.github.com/The-Software-Compagny/flower-inbox/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246362112,"owners_count":20765041,"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":[],"created_at":"2024-12-12T06:05:53.514Z","updated_at":"2025-03-30T18:29:11.279Z","avatar_url":"https://github.com/The-Software-Compagny.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=\"http://the-software-compagny.github.io/flower-inbox\" target=\"blank\"\u003e\u003cimg src=\"./public/logo.png\" width=\"200\" alt=\"FlowerInboxLogo\" /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003eAn email retrieval system with a REST API built with NestJS in NodeJS\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n  \u003cimg alt=\"GitHub all releases\" src=\"https://img.shields.io/github/downloads/the-software-compagny/flower-inbox/total\"\u003e\n  \u003cimg alt=\"GitHub\" src=\"https://img.shields.io/github/license/the-software-compagny/flower-inbox\"\u003e\n  \u003cimg alt=\"GitHub contributors\" src=\"https://img.shields.io/github/contributors/the-software-compagny/flower-inbox\"\u003e\n  \u003ca href=\"https://github.com/the-software-compagny/flower-inbox/actions/workflows/release.yml?event=workflow_dispatch\"\u003e\u003cimg alt=\"GitHub contributors\" src=\"https://github.com/the-software-compagny/flower-inbox/actions/workflows/release.yml/badge.svg\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\u003cbr\u003e\n\n# FlowerInbox - Rest API for email retrieval\n\nFlower Inbox est un projet open source polyvalent conçu pour simplifier les processus d'envoi et de réception de courriels. Il offre une API rest conviviale, permettant aux développeurs d'intégrer facilement des fonctionnalités de messagerie dans leurs applications. Flower Inbox vise à fournir une solution complète pour la gestion des courriels.\n\n## Getting started\n\n```bash\ndocker pull ghcr.io/the-software-compagny/flower-inbox:latest\n```\n\n```env\n# .env\n\n#FLOWERINBOX_LOGGER=debug\nFLOWERINBOX_JWT_SECRET=1212974\nFLOWERINBOX_CRYPT_SECURITYKEY=78987946\n```\n\n```yml\n# accounts.yml\nversion: \"1\"\naccounts:\n  - id: my-account-the-software-compagny\n    name: my-account-the-software-compagny\n    imap:\n      maxIdleTime: 60000\n      host: mail.the-software-compagny.fr\n      port: 993\n      auth:\n        user: my-account@the-software-compagny.fr\n        pass: ******\n    smtp:\n      host: mail.the-software-compagny.fr\n      port: 465\n      auth:\n        user: my-account@the-software-compagny.fr\n        pass: ******\n\n```\n\n```yml\n# tokens.yml\nversion: \"1\"\ntokens:\n  - client_id: test\n    key: '12212546ezaeaze5a4r65azer4ar56sq4'\n    ip:\n      - 127.0.0.1\n    acls:\n      - resource: tokens\n        actions: ['create:any', 'read:any', 'update:any', 'delete:any']\n        attributes: ['*']\n      - resource: accounts\n        actions: ['create:any', 'read:any', 'update:any', 'delete:any']\n        attributes: ['*']\n```\n\n## Points d'accès API\n- Défaut\n  - GET / - Récupérer des informations de base sur le service Flower Inbox.\n  - GET /cron/run - Déclencher un travail cron manuellement.\n  - GET /cron/run/{account} - Déclencher un travail cron pour un compte spécifique.\n- Comptes\n  - GET /accounts - Récupérer une liste de tous les comptes.\n  - POST /accounts - Créer un nouveau compte.\n  - GET /accounts/{account} - Récupérer des informations sur un compte spécifique.\n  - PATCH /accounts/{account} - Mettre à jour les informations d'un compte spécifique.\n  - DELETE /accounts/{account} - Supprimer un compte spécifique.\n  - POST /accounts/{account}/submit - Soumettre des données pour un compte spécifique.\n  - GET /accounts/changes - Récupérer les changements liés aux comptes.\n- Boîtes aux lettres\n  - GET /accounts/{account}/mailboxes - Récupérer une liste des boîtes aux lettres pour un compte spécifique.\n- Messages\n  - GET /accounts/{account}/messages - Récupérer une liste de messages pour un compte spécifique.\n  - GET /accounts/{account}/messages/{seq} - Récupérer un message spécifique par numéro de séquence.\n  - DELETE /accounts/{account}/messages/{seq} - Supprimer un message spécifique par numéro de séquence.\n  - GET /accounts/{account}/messages/{seq}/source - Récupérer la source d'un message spécifique par numéro de séquence.\n\n## Support\nFlowerInbox is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please read more here. For personalized support, please contact **The Software Compagny**.\n## License\nFlowerInbox is [MIT licensed](LICENSE).\nIf you require a license specific to your needs, please contact **The Software Compagny**.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthe-software-compagny%2Fflower-inbox","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthe-software-compagny%2Fflower-inbox","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthe-software-compagny%2Fflower-inbox/lists"}