https://github.com/munas-git/mail-correction-api
Email correction API which aims to reduce email bounce rate. This system provides Restful FastAPI which receives an email address as input, analyzes the email address, make corrections where necessary and returns the correct email to the user.
https://github.com/munas-git/mail-correction-api
email-corrector email-fixer email-validator python rest-api
Last synced: about 1 month ago
JSON representation
Email correction API which aims to reduce email bounce rate. This system provides Restful FastAPI which receives an email address as input, analyzes the email address, make corrections where necessary and returns the correct email to the user.
- Host: GitHub
- URL: https://github.com/munas-git/mail-correction-api
- Owner: munas-git
- License: mit
- Created: 2023-03-22T18:58:20.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-06-27T09:47:01.000Z (almost 3 years ago)
- Last Synced: 2025-04-01T11:49:31.092Z (about 1 year ago)
- Topics: email-corrector, email-fixer, email-validator, python, rest-api
- Language: Jupyter Notebook
- Homepage:
- Size: 99.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
#### Project Status: Incomplete.
# Project Title: Mail-correction API
## Project Description.
Mail correction API is an API written in Python capable of receiving an email address (correct/wrong), analyzing it to determine the issue with the email address before attempting to correct it and returning the corrected email to the user.
This system can be used to scan through your mailing list and instantly correct thousands of emails in order to reduce your bounce rate.
> Missing functionality: Mail pinging. This functionality is to ping the corrected email address in order to verify that it actually exists.
## How to use?
- Install all requirements in the requirements.txt file
- Navigate to the api folder in terminal
- Run the command: $ uvicorn main:app --reload
- Open: http://127.0.0.1:8000/docs in your browser or
- Open Postman and enter the url http://127.0.0.1:8000/basic-correction for basic correction attempts
- For more advanced email correction attempts, navigate to http://127.0.0.1:8000/advanced-correction
- Enter the email and process the post request.