Skip to content

Latest commit

 

History

History
225 lines (170 loc) · 5.41 KB

README.md

File metadata and controls

225 lines (170 loc) · 5.41 KB
Raw

IDLIX (1)

A Simple Web API to Generate Temporary Gmail Email. With a Json Response easy to manage messages and working with IMAP Gmail Provider

Demo

My.Video15.mp4

Time To build This Project : wakatime
Wakatime Project : https://wakatime.com/@sandrocods/projects/mtsiyzjnpw?start=2022-09-04&end=2022-09-10

Notice

This repository is only public for educational purposes!
All content provided here shall not be used for any kind of illegal activity nor for law enforcement at any time. This restrictions apply to all cases of usage, no matter whether the whole code or just parts of it are being used.

Build With

Features

Feature Status
Limit Request to API ✅
Use .env file to config Account ✅
Read Specific Email Body ✅
Delete Email ✅
Generate Dot Trick Email ✅
Web App Work In Progress

Run Locally

Clone the project

  git clone https://github.com/sandrocods/GTmp

Go to the project directory

  cd GTmp

Install dependencies

   pip3 install -r ./requirements.txt

Start the server

  python3 main.py

Access server

  Go to http://127.0.0.1:5000

Environment Variables

To run this project, you will need to add the following environment variables to your .env file

Email -> Your Gmail Email

Password -> Your Gmail Password

API Reference

Generate Temporary Email

Request :

  GET /generate/<type>
Parameter Type Description
type string Required. type (dot/dotplus)

Response :

// http://127.0.0.1:5000/generate/dot
{
    "data": {
        "email": "[email protected]",
        "mailbox": "/read/[email protected]",
        "status": true
    },
    "message": "Success",
    "status": true
}

// http://127.0.0.1:5000/generate/dotplus
{
     "data": {
          "email": "[email protected]",
          "mailbox": "/read/[email protected]",
          "status": true
     },
     "message": "Success",
     "status": true
}

Read Messages

Request :

  GET /read/<email>
Parameter Type Description
email string Required. Your Email

Response :

// http://127.0.0.1:5000/read/[email protected]
{
     "data": [
          {
               "body": "Test 1\r\n",
               "date": "Thu, 08 Sep 2022 15:27:42 GMT",
               "from": "[email protected]",
               "subject": "Test Email Temp",
               "to": [
                    "[email protected]"
               ],
               "uid": "125"
          }
     ],
     "email": "[email protected]",
     "message": "Messages appear",
     "status": true
}

Read Messages by Text in Body

Request :

  GET /readby/<email>/<string_in_body>
Parameter Type Description
email string Required. Your Email
string_in_body string Required. specific string in body message

Response :

// http://127.0.0.1:5000/readby/[email protected]/Test
{
     "data": [
          {
               "body": "Test 1\r\n",
               "date": "Thu, 08 Sep 2022 15:27:42 GMT",
               "from": "[email protected]",
               "subject": "Test Email Temp",
               "to": [
                    "[email protected]"
               ],
               "uid": "125"
          }
     ],
     "email": "[email protected]",
     "message": "Messages appear",
     "status": true
}

Delete Message

Request :

  GET /delete/<uid>
Parameter Type Description
uid string Required. uid from message

Response :

// http://127.0.0.1:5000/delete/125

true

Another Response

// Message not exist
{
     "email": "[email protected]",
     "message": "No messages appear",
     "status": false
}

// Limit Request by Flask_limiter
{
     "message": "You have reached the request limit of 20 per 1 minute requests per day",
     "status": "error"
}

Support

thank you for visiting this repository, if this repository is useful for your project please give a star ⭐️🙏❤️️