Emailer

An API to integrate in other apps to send emails, OTPs or newsletter. No need to setup your on SMTP server you can use Gmail, AWS, Yahoo, Yandex or any other email services to confiugre this app and send emails programatically.

This project is under development, not recommended for use in production directly.

Table of Contents

• Features
  • Roadmap
  • Tech Stack
• Usage/Example
  • API Reference
  • Example
• Getting Started
  • Installation
  • Configuration
  • Deployment
• Contribution
• License

Features

• Send emails via HTTP POST request
• Configure HTML and RAW body seperately
• Blacklist & Whitelist email addresses
• Whitelist IP for API calls

Roadmap

• Multiple email support
• Email verification via OTP
• SMS Support using AWS SNS

If you have any other suggestions, feel free to open a Issue or Pull Request

Tech Stack

Client: Swagger, Bootstrap

Server: Python3, FastAPI, smtplib

API Reference

Sends an Email

POST /email/send

Usage Example

import requests

reqUrl = "http://<host>:<port>/email/send"

headersList = {
 "Content-Type": "application/json" 
}

payload = json.dumps({
    "email":"[email protected]",
    "body": "Hello from emailer-py"
})

response = requests.request("POST", reqUrl, data=payload,  headers=headersList)

print(response.text)

• You can use a for loop if you have multiple emails as a list.

Installation

This project is built with python-3.9 and FastApi so you need to install python and should have atleast one public PORT and IP

• Installing pre-requisites

apt install git python3 python3-pip

• Cloning Project

git clone https://github.com/viperadnan-git/emailer-py
cd emailer-py

• Installing dependencies via pip

pip install -r requirements.txt

Configuration

All configuration are inside a single file config.yml

server:
    allowed_hosts: ["127.0.0.1", "103.201.127.144", "*"]

smtp:
    username: [email protected]
    password: TheStr@ngPassword
    host: smtp.mail.yahoo.com
    port: 587

options:
    whitelist: ["*@gmail.com"]
    blacklist: ["*-*@gmail.com"]

Deployment

To deploy this project via uvicorn (ASGI server implementation) run

uvicorn main.app:app

By default this will listen to localhost and port 8000. To listen to desired host nad port pass the --host <host> and --port <port> flags accordingly.

If you want to listen on all host and HTTP request (with port 80)

uvicorn main.app:app --host 0.0.0.0 --port 80

Contributing

Contributions are always welcome!

To discuss about the improvement/contribution on this project join group chat.

License

Made with ♥ and Licensed under GNU General Public License v3.0