{"id":13772857,"url":"https://github.com/kyee-rs/Ymail","last_synced_at":"2025-05-11T05:33:47.187Z","repository":{"id":131799694,"uuid":"606465701","full_name":"kyee-rs/Ymail","owner":"kyee-rs","description":"YmailBot - Temporary Email Service in your smartphone. 📬","archived":true,"fork":false,"pushed_at":"2023-07-23T12:40:48.000Z","size":63,"stargazers_count":39,"open_issues_count":0,"forks_count":3,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-05-18T20:24:02.701Z","etag":null,"topics":["bot","deno","docker","docker-compose","email","mailgun","telegram","tempmail","tg","tgbot","typescript"],"latest_commit_sha":null,"homepage":"https://t.me/ymailerbot","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kyee-rs.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":"contributing.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2023-02-25T15:23:11.000Z","updated_at":"2023-10-09T14:31:19.000Z","dependencies_parsed_at":null,"dependency_job_id":"a08bdbc6-a548-433a-b414-e9a6142c4839","html_url":"https://github.com/kyee-rs/Ymail","commit_stats":null,"previous_names":["12subnet/ymail","kyee-rs/ymail"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kyee-rs%2FYmail","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kyee-rs%2FYmail/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kyee-rs%2FYmail/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kyee-rs%2FYmail/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kyee-rs","download_url":"https://codeload.github.com/kyee-rs/Ymail/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223783200,"owners_count":17201913,"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":["bot","deno","docker","docker-compose","email","mailgun","telegram","tempmail","tg","tgbot","typescript"],"created_at":"2024-08-03T17:01:08.570Z","updated_at":"2024-11-17T08:30:32.623Z","avatar_url":"https://github.com/kyee-rs.png","language":"TypeScript","funding_links":[],"categories":["Bots"],"sub_categories":[],"readme":"# YmailBot - Temporary Email Service in your smartphone. 📬\n\n\u003e ## ⚠️ Deprecated. Use [AtomicEmails/AtomicEmails](https://github.com/AtomicEmails/AtomicEmails) instead.\n\n## Contents\n\n- [Introduction](#introduction)\n- [Features](#features)\n- [Installation](#installation)\n- [Usage](#usage)\n- [Contributing](#contributing)\n- [License](#license)\n- [Credits](#credits)\n\n## Introduction\n\n---\n\n### What is YmailBot?\n\nYmail is a user-friendly telegram bot that lets you create temporary email\naddresses and receive emails on your smartphone for free. It's open source design\nallows you to receive emails from any website or service requiring email\nverification, as well as from friends and family. The bot helps safeguard your\nprivacy and keep your email address secure by preventing spamming and hacking\nattempts.\n\n### Why YmailBot?\n\nYmailBot is a free, open source, and user-friendly temporary email service that\nallows you to receive emails on your smartphone. It is a great alternative to\nother temporary email services that require you to sign up for an account and\nprovide your personal information. Ymail is a great way to protect your privacy\nand keep your email address secure. There is also an ability to connect your own\ndomain to the bot to prevent service from being blocked by some websites.\n\n## Features\n\n---\n\n### Create a temporary email address\n\nYou can create a temporary email address by sending the command `/new` to the\nbot. The bot will then generate a random email address for you and forward all\nincoming emails to your chat.\n\n### Persistent email address\n\nOne persistent email address is created for each chat. You can use this email\naddress to receive emails from friends and family instead of using your main\nemail address. The bot will forward all incoming emails to your chat.\n\n### Connect your own domain\n\nYou can connect your own domain to the bot to prevent service from being blocked\nby some websites. To do that, you need to install bot on your own machine and\nfollow the instructions in the [Installation](#installation) section.\n\n## Installation\n\n---\n\n### Requirements\n\n- [Deno](https://deno.land/) runtime or\n  [Docker Compose](https://docs.docker.com/compose/)\n- Custom domain\n- [SurrealDB](https://surrealdb.com) Instance or\n  [Docker Compose](https://docs.docker.com/compose/)\n- [Mailgun](https://www.mailgun.com/) account\n\n### Setup\n\nUsing Docker Compose:\n\n- Clone the repository and navigate to the project directory.\n\n```bash\n$ git clone https://github.com/voxelin/Ymail.git\n$ cd Ymail\n```\n\n- Rename `.env.example` to `.env` and fill in the required fields.\n\n```bash\n$ mv .env.example .env\n$ nano .env\n```\n\n- Run the bot using Docker Compose.\n\n```bash\n$ docker-compose up -d\n```\n\n- Next steps from [Network Setup](#network-setup) section.\n\nUsing Deno:\n\n- Clone the repository and navigate to the project directory.\n\n```bash\n$ git clone https://github.com/voxelin/Ymail.git\n$ cd Ymail\n```\n\n- Rename `.env.example` to `.env` and fill in the required fields.\n\n```bash\n$ mv .env.example .env\n$ nano .env\n```\n\n- Start the database server.\n\n```bash\n$ curl -sSf https://install.surrealdb.com | sh\n$ surreal start --user \u003cusername-from-env\u003e --pass \u003cpassword-from-env\u003e \u003cDB-Path-from-env\u003e\n```\n\n- Run the bot using Deno.\n\n```bash\n$ deno task edge\n```\n\n### Network Setup\n\n- Set up a webhook integration in your bot's settings. You can use\n  [ngrok](https://ngrok.com/) to expose your local server to the internet.\n\n```bash\n$ ngrok http 7000\n```\n\n- Set up a webhook integration in your bot's settings. Use the URL provided by\n  ngrok as the webhook URL.\n\n```jsonc\n// Navigate to https://api.telegram.org/bot\u003cyour-bot-token\u003e/setWebhook?url=\u003cyour-webhook-url\u003e/bot/\u003cyour-bot-token\u003e. You should receive a response like this:\n{ \"ok\": true, \"result\": true, \"description\": \"Webhook was set\" }\n```\n\n- Login to your mailgun account and add your custom domain. Follow the\n  instructions on the mailgun website to verify your domain.\n- Open Receiving tab and create a new route. Set these settings:\n\n```diff\n+ Expression type: Catch All\n+ Forward: \u003cyour-webhook-url\u003e/receive?secret=SECRET_KEY_FROM_ENV\n+ Priority: 0\n```\n\nYou are all set! Now you can use the bot to create temporary email addresses and\nreceive emails on your smartphone. 🎊📬\n\n## Usage\n\n---\n\n### Commands\n\n- `/start` - Start the bot.\n- `/help` - Show help message.\n- `/new` - Create a new temporary email address.\n- `/list` - List all temporary email addresses.\n- `/delete` - Delete your temporary email address.\n- `/deleteall` - Delete all temporary email addresses.\n\n## Contributing\n\n---\n\nContributions are welcome! Please read the\n[contribution guidelines](contributing.md) first.\n\n## License\n\n---\n\nThis project is licensed under the GNU General Public License - see the\n[LICENSE](LICENSE) file for details.\n\n## Credits\n\n---\n\n- [voxelin 🇺🇦](https://github.com/voxelin) - The creator of this project.\n- [SurrealDB](https://surrealdb.com/) - A simple, fast, and secure database that\n  I personally love.\n- [Mailgun](https://www.mailgun.com/) - A simple service for sending and\n  receiving emails.\n- [Deno](https://deno.land/) - A secure runtime for JavaScript and TypeScript.\n- [Docker](https://www.docker.com/) - A great tool for containerizing\n  applications.\n- [ngrok](https://ngrok.com/) - An easy way for exposing local servers to the\n  internet.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkyee-rs%2FYmail","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkyee-rs%2FYmail","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkyee-rs%2FYmail/lists"}