gitfor
Sign inSign up

amandoti/cindermail

public
☆ Star 2⑂ Fork 0

Report repository

CodeIssuesPull requestsDiscussionsActionsReleasesSecurityInsights
Go to fileHistory
Psalm 25 17Add MIT License to the project
7c8b2e3 ·
README.md

Cindermail 🔥

Website | Docs

Disposable email delivered where you already are.

Release License: Unlicense CI TypeScript Cloudflare Workers Stars

Give out x7k2p9qzrm@yourdomain.com instead of your real address. Mail sent to it gets parsed and delivered straight to you, on Discord or Telegram. Torch it when you're done.

Example delivery

Addresses sit on a domain you own, so nothing flags them as disposable the way public temp-mail domains get flagged. Runs on Cloudflare's free tier: Email Routing receives, D1 stores, one Worker does the rest. Nothing to keep alive.

No domain? Leave one setting blank and it uses mail.tm's instead.

Deploy

Deploy to Cloudflare

Forks the repo, creates the database, deploys the Worker, prompts for your domain and Discord credentials (Discord is the platform the automated setup covers today; Telegram is a manual step, see docs/telegram-adapter.md). Blank domain means mail.tm mode.

It can't load the database schema or register the slash commands with Discord. Those are in docs/deploy-cloudflare.md and docs/discord-adapter.md.

Prefer a local clone 
git clone https://github.com/psalm2517/cindermail.git
cd Cindermail
npm install && npm run setup

The wizard asks the same questions and writes the same config. Use this if you'll be changing the code.

Commands
/new [expiry] [note] A fresh address. Permanent unless given an expiry in days.
/list Your addresses, with notes, expiry, and how many of your quota you're using.
/extend <address> [expiry] Change when one expires. expiry: 0 makes it permanent.
/note <address> [note] Label one. Blank clears it.
/remind [on/off] Opt in to a message a day before an address expires.
/torch <address> Kill it.

Same six commands on both Discord and Telegram; exact option syntax differs slightly per platform (Discord takes structured options, Telegram reads plain text after the command). Discord replies are ephemeral, visible only to whoever ran the command; Telegram only works in a private chat with the bot for the same reason. Details in docs/discord-adapter.md and docs/telegram-adapter.md.

How it works

  1. /new mints a random address owned by whoever ran it.
  2. Give it out. Mail sent there comes back to you, not to wherever you used it.
  3. Mail arrives, the Worker looks up the owner. Unknown, expired or torched addresses are dropped: no bounce, nothing logged.
  4. Otherwise it's parsed (HTML to text, links intact, attachments forwarded) and delivered to you.

A daily cron deletes expired and torched addresses, clears stale rate-limit rows, and sends expiry reminders.

The Worker root serves a status page with running totals, also available as JSON at /counters. Counts only, no addresses or owners.

Limits

  • 5 active addresses per owner, configurable.
  • Message bodies cap at 1500 characters inline; longer is attached as message.txt.
  • Inbound HTML caps at 256KB before parsing. Parsing cost scales quadratically, and anyone who learns an address can send to it.
  • Attachments forward up to 25MB combined per email. Anything over budget is dropped with a note, not the whole batch.

Code layout and tests: docs/architecture.md. Every setting: docs/configuration.md.

Under consideration (contingent on demand)

  • Slack delivery adapter
  • Publicly hosted instance

AI disclosure

This project was built with AI assistance, directed by me.

License

Unlicense. See LICENSE.

Built with Cloudflare