Simple lightwigh mail sending for FastApi
Project description
Fastapi-mail
The fastapi-mail simple lightweight mail system, sending emails and attachments(individual && bulk)
🔨 Installation
$ pip install fastapi-mail
In order to run the application use command below
uvicorn test_examples.main:app --reload --port 8001
Guide
from fastapi import FastAPI, BackgroundTasks, UploadFile, File, Form
from starlette.responses import JSONResponse
from starlette.requests import Request
from fastapi_mail import FastMail, MessageSchema,ConnectionConfig
from pydantic import EmailStr
from pydantic import EmailStr, BaseModel
from typing import List
class EmailSchema(BaseModel):
email: List[EmailStr]
conf = ConnectionConfig(
MAIL_USERNAME = "your@email.com",
MAIL_PASSWORD = "strong_password",
MAIL_PORT = 587,
MAIL_SERVER = "your mail server",
MAIL_TLS = True,
MAIL_SSL = False
)
app = FastAPI()
html = """
<html>
<body>
<p>Hi This test mail
<br>Thanks for using Fastapi-mail</p>
</body>
</html>
"""
template = """
<html>
<body>
<p>Hi This test mail using BackgroundTasks
<br>Thanks for using Fastapi-mail</p>
</body>
</html>
"""
@app.post("/email")
async def simple_send(email: EmailSchema) -> JSONResponse:
message = MessageSchema(
subject="Fastapi-Mail module",
receipients=email.dict().get("email"), # List of receipients, as many as you can pass
body=html,
subtype="html"
)
fm = FastMail(conf)
await fm.send_message(message)
return JSONResponse(status_code=200, content={"message": "email has been sent"})
Sending email as background task
@app.post("/emailbackground")
async def send_in_background(background_tasks: BackgroundTasks,email: EmailSchema) -> JSONResponse:
message = MessageSchema(
subject="Fastapi mail module",
receipients=email.dict().get("email"),
body="Simple background task ",
)
fm = FastMail(conf)
background_tasks.add_task(fm.send_message,message)
return JSONResponse(status_code=200, content={"message": "email has been sent"})
Sending files
@app.post("/file")
async def send_file(background_tasks: BackgroundTasks,file: UploadFile = File(...),email:EmailStr = Form(...)) -> JSONResponse:
message = MessageSchema(
subject="Fastapi mail module",
receipients=[email],
body="Simple background task ",
attachments=[file]
)
fm = FastMail(conf)
background_tasks.add_task(fm.send_message,message)
return JSONResponse(status_code=200, content={"message": "email has been sent"})
Contributing
Fell free to open issue and send pull request.
Contributors ✨
Thanks goes to these wonderful people (🚧):
 Sabuhi Shukurov 💬 👀 🚧 |
 Tural Muradov 📖 👀 🔧 |
 Hasan Aliyev 📖 🚧 👀 |
 Ashwani 🚧 |
This project follows the all-contributors specification. Contributions of any kind are welcome!
LICENSE
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
fastapi-mail-0.2.8.2.tar.gz
(8.6 kB
view details)
Built Distribution
File details
Details for the file fastapi-mail-0.2.8.2.tar.gz.
File metadata
- Download URL: fastapi-mail-0.2.8.2.tar.gz
- Upload date:
- Size: 8.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/41.6.0 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.8.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 2605d8ff9a3de5c8ba42d63737fa074fe622323d8ed76e176224f93241e02239 |
|
| MD5 | 95c5bc216fa4f24fbf53d8241e93dfae |
|
| BLAKE2b-256 | 0acb99a4ff53419b5697df52a589efc79cc78eab31d15a9810de08d5a5b8539a |
File details
Details for the file fastapi_mail-0.2.8.2-py3-none-any.whl.
File metadata
- Download URL: fastapi_mail-0.2.8.2-py3-none-any.whl
- Upload date:
- Size: 10.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/41.6.0 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.8.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c58a0e5c92678ec80669e4acecf89b5cd6e10be51f0960c9aa29db979f6b9dc9 |
|
| MD5 | 22ba3b761368189c698e5a6957400a59 |
|
| BLAKE2b-256 | 44fb5385ae8a16bedc02316dab95574c523a0417a7810ffa6f2b1054a8caf091 |
