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 = "YourUsername",
MAIL_PASSWORD = "strong_password",
MAIL_FROM = "your@email.com",
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",
recipients=email.dict().get("email"), # List of recipients, 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",
recipients=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",
recipients=[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 🚧 |
 Leon Xu 🚧 |
 Gabriel Oliveira 📖 🚧 |
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.7.tar.gz
(6.6 kB
view details)
Built Distribution
File details
Details for the file fastapi-mail-0.2.8.7.tar.gz.
File metadata
- Download URL: fastapi-mail-0.2.8.7.tar.gz
- Upload date:
- Size: 6.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.7.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 9efc4931a0e17bca3233380ed595c153f2ea7820c2c607d3c4c1e1f6bc45205a |
|
| MD5 | cbbaa67bb35818fe94ca8bce17f5691b |
|
| BLAKE2b-256 | a9622d99e73199bcff41fb0314fed84dcafb414bc0bb5f060699bb5a002d8a79 |
File details
Details for the file fastapi_mail-0.2.8.7-py3-none-any.whl.
File metadata
- Download URL: fastapi_mail-0.2.8.7-py3-none-any.whl
- Upload date:
- Size: 10.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.7.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 4e7d3bed2871c0bcf7e4f7ed2668bcddfef496606e4327d9d869b2ee8b231c10 |
|
| MD5 | 6864cb455a015046013c6a38f87fddcc |
|
| BLAKE2b-256 | afa2c994f656a1212ae5d0484e0c7a0859a2269d8cc555ce5122a6679d00edd9 |
