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 BaseModel, EmailStr
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,
USE_CREDENTIALS = True
)
app = FastAPI()
template = """
<p>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 🚧 |
Dmitriy Solodkiy 🚧 |
Peter Boers 🚧 |
James Valentine 📖 🚧 🔧 |
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.5.0.tar.gz
(15.9 kB
view details)
Built Distribution
File details
Details for the file fastapi-mail-0.3.5.0.tar.gz
.
File metadata
- Download URL: fastapi-mail-0.3.5.0.tar.gz
- Upload date:
- Size: 15.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.58.0 CPython/3.7.10
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9c01a2e34671bdb12fafe606eb6ee3e7eec00e6aab2c678c4acd64289d61dcfc |
|
MD5 | 1f8e194522fd2f4aeb6ab5e605542d9f |
|
BLAKE2b-256 | 5d24b8b3fa9da684328697ebabbee2b1bcc63fd82d63d4d3750125b145fe7d38 |
File details
Details for the file fastapi_mail-0.3.5.0-py3-none-any.whl
.
File metadata
- Download URL: fastapi_mail-0.3.5.0-py3-none-any.whl
- Upload date:
- Size: 20.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.58.0 CPython/3.7.10
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 802608aa1206e53fd104f7ec9e017df61727a6be96352c2510b24378a91828de |
|
MD5 | c7ca42279d928c7a5ae5d98d9b020673 |
|
BLAKE2b-256 | 07a75e85d81416a7ec4cfbe8deea78fd0a70cbe99467a214a1467f458afe2192 |