Git Product home page Git Product logo

trashmail2-client's Introduction

Trashmail

Build Status License: AGPL v3

This tool is for building a trashmail service. It is suitable either for private networks (for example your company) or public services to provide temporary e-mail addresses to your users.

Public installation is at https://spamwc.de

Use Cases

Many services want you to provide a e-mail address. After providing that, you may get a lot of spam, they are calling that opt-out newsletters. Now this disposable e-mail tool helps you. If you registered somewhere for somewhat and do not like their newsletter you will get desired information and you can forget unsolicited newsletter.

How to support

If you are interested to support this project please set up a pull request. You may get access to our private Gitlab system then. Github is a mirror only due to security reasons, but it contains a exact copy of that private repository.

Documentation

See /doc folder for further documentation.

Architecture

This solution consists on at least 3 + 1 core services:

  • Trashmail2-Client (this tool) - this is a Web-GUI for retrieving e-mails
  • MongoDB - this is the storage medium for received e-mail
  • lmtp-server - for receiving e-mail. It is strongly recommended to set up a SMTP mailgateway in front of this server
  • smtp server - we recommend to use a Postfix server to receive mails from Internet, doing some filtering, routing etc. and relay them to lmtp-server

Provides a web gui for a disposable mail system. It is written in JavaScript/NodeJS and uses Express/PUG for templating.

IMPORTANT

File trashmail.json MUST contain line "configRuntime": "trashmail.runtime.json", for reference to runtime config. Please read Github wiki for further information.

Features

  • Direct access to specific mail address by GET request
  • URL encoded as QR code available
  • Responsive design
  • PUG template (formerly Jade)
  • Supports mail attachments (configurable)
  • QRcode for mobile devices
  • If mail server supports DKIM it show DKIM status to user
  • International support.

Status

Production: Works in a single production environment.

Optional

If you are using NodeJS without full libicu support you may consider to install full-icu. full-icu not found warning will tell you, what to to. If you are using nodejs from your Linux distribution you probably get a version with full libicu support, so you do not have to care about this. If warning does not appear do not install full-icu.

Other OS

  • Recommended: Systemd based Linux distribution
  • Should also work with FreeBSD, OpenBSD

trashmail2-client's People

Contributors

dependabot[bot] avatar ip6li avatar p000255 avatar

Watchers

 avatar  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.