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
Documentation: FastApi-MAIL
The key feature are:
- sending emails with either with FastApi or using asyncio module
- sending emails using FastApi backroung task managment
- sending files either from form-data or files from server
- Using Jinja2 HTML Templates
- email utils (utility allows you to check temporary email addresses, you can block any email or domain)
- email utils has two avalibale class
DefaultChecker
andWhoIsXmlApi
- Unittests using FastapiMail
More information on Getting-Started
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()
template = """
<p>Hi this test mail using BackgroundTasks, thanks for using Fastapi-mail</p>
"""
@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"})
List of Examples
for more examples of using fastapi-mail please check example section
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 📖 🚧 |
Onothoja Marho 📖 🚧 🔧 |
Tim Kiely 🚧 |
This project follows the all-contributors specification. Contributions of any kind are welcome!
Before you start please read CONTRIBUTING
LICENSE
Project details
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.3.1.1.tar.gz
(14.6 kB
view details)
Built Distribution
File details
Details for the file fastapi-mail-0.3.1.1.tar.gz
.
File metadata
- Download URL: fastapi-mail-0.3.1.1.tar.gz
- Upload date:
- Size: 14.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.7.9
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 80ca438855c7b6452af0133f25979015bfe879767ef592e53e34da74a7af215c |
|
MD5 | d4c61270937dccfee7f0773e475e0c00 |
|
BLAKE2b-256 | 77c5593cb4cc6737b5205a242d322bdf4c37cbef1bb45dd2ed7518945e3362c1 |
File details
Details for the file fastapi_mail-0.3.1.1-py3-none-any.whl
.
File metadata
- Download URL: fastapi_mail-0.3.1.1-py3-none-any.whl
- Upload date:
- Size: 18.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.7.9
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9cc0feb5751f01fec93962886253c33900f47a4724ff7a2a7317ccd045d6e937 |
|
MD5 | 02b74e90242c45cdcaf085ea4b498b75 |
|
BLAKE2b-256 | 550c246d084ff1e040df26cadca6948e86d36539ceb6282bba8771e2ffff72b0 |