Giter Club home page Giter Club logo

tmpx's Introduction

tmpx πŸ“¨

A stupidly simple to use temporary mail host with an easy to use JSON/WS API Yes, there are hundreds of these. It's just fun to learn new things

Core features πŸ“ƒ

  • A simple web UI where you can generate a temp mail.
  • An easy to use Websocket/HTTP API so you can integrate it into your own stuff.

Website and email πŸ•ΈοΈ

The website will be hosted on https://tmpx.email and the domain that's for receiving mail will be @tmpx.sa.com.

Technologies πŸ€–

It'll be straight forward:

  • Express for an API you can interact with.
  • Socket.io for the Websockets so the front-end doesn't have to refresh.
  • An IMAP server, this stores all the mail. Why use a DB when we can just use IMAP for now.
  • imap-simple to interact with the IMAP server.

Requirements πŸ–₯

  • A solid IMAP server that has a high uptime
  • A VPS with Node.js installed
  • A catch-all email address

Roadmap πŸ›£οΈ

  • Setup a backend that can stream imap to the right places
  • An endpoint that will fetch recent mail from the IMAP server
  • A CRON that will clear the main inbox after a certain amount of time
  • Download to PDF
  • Forward mail to your own places, like a proxy
  • Connect your own domain, you'll probably have to set something up that it arrives at our inbox.
  • Storing everything to a faster database than IMAP as soon as the mail arrives & then remove it from the mailbox to leave no traces on the place it arrived at.
  • Queuing queries so the IMAP server doesn't get flooded with useless queries.
  • Ratelimitting based off the email address AND ip that the requests comes from.
  • Automatically reconnect when the IMAP connection drops

Backend routes

The base for the JSON-API is https://json.tmpx.email, it currently hosts the @tmpx.sa.com domain.

/mail/:emailAddress

  • Find all mails for a certain email emailAddress

/ping

  • Pong!
  • Checks if the IMAP server is connected

Partners 🀝

The IMAP server will be hosted by LNGZL which is my software development agency aka it's sponsored by myself πŸŽ‰

Donate domains

If you're interested in donating a domain to the tmpx platform, first of all that's awesome!

Simply join the official LNGZL Discord server and send me (Like#0001) a message.

Click here to join the Discord

License βš–οΈ

It's licenesed under the Apache-2.0 license, check LICENSE.md for all information.

tmpx's People

Contributors

abcdan avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.