Giter Club home page Giter Club logo

whoamimailbot's Introduction

Who Am I Mail Bot

What is it?

Who Am I Mail Bot is a service to mask your e-mails. It was inspired by Blur, where you can create an alias for your e-mail and use it to signup on applications. The problem with Blur is that all e-mails pass trough their infraestructure and I don't need/want anybody looking on my e-mails, so I made this project. WhoAmIMailBot is similar to Blur service but runs on your own infraestructure!

How it works?

You will need:

  • A domain (to not expend money you can use no-ip services);
  • A VPS that allows smtp outbound;
  • A telegram bot ID;
  • Your telegram user ID;
  • This project.

Your VPS will run a postfix that will redirect e-mails using the postfix function of virtual alias (where you can set an e-mail address to redirect all incoming messages to another e-mail), the no-ip domain will be the domain which you'll use on your alias e-mails and the telegram bot will manage your alias. So:

diagram

Installation

  • From source
git clone https://github.com/mthbernardes/WhoAmIMailBot.git
cd WhoAmIMailBot
docker build -t whoamimailbot .
docker run -d -p 25:25 --name whoamimailbot -v /data/postfix/:/data -e TELEGRAM_BOT_TOKEN="BOT_TOKEN" -e TELEGRAM_USER_ID="USER_ID" -e FAKE_DOMAIN="mail.example.com" whoamimailbot
  • From Hub Docker

You can download the image using the following command:

docker pull btamburi/whoamimailbot

or

docker run -d -p 25:25 --name whoamimailbot -v /data/postfix/:/data -e TELEGRAM_BOT_TOKEN="BOT_TOKEN" -e TELEGRAM_USER_ID="USER_ID" -e FAKE_DOMAIN="mail.example.com" btamburi/whoamimailbot

Environment variables

This image uses environment variables to allow the configuration of some parameteres at run time:

  • TELEGRAM_BOT_TOKEN: Telegram bot token. (Use: @BotFather)
  • TELEGRAM_USER_ID: Your Telegram ID. (Use: @my_id_bot)
  • FAKE_DOMAIN: Your fake domain for receive email. (Example: mailbot.ddns.net )

Usage

On your telegram bot you have the follow commands,

Command Description
/list List all available aliases
/new [email protected] Create a new alias for the given mail
/delete string Delete alias by a given string

whoamimailbot's People

Contributors

btamburi avatar mthbernardes avatar giovanifss avatar

Watchers

James Cloos 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.