Simple lightweight mail library for FastApi
Project description
Fastapi-mail
The fastapi-mail is a simple lightweight mail system, for sending emails and attachments(individual && bulk)
🔨 Installation
python3 -m venv .venv
source .venv/bin/activate
pip install fastapi-mail
for aioredis and httpx
pip install 'fastapi-mail[aioredis]'
pip install 'fastapi-mail[httpx]'
Alternatively, if you prefer to use poetry
for package dependencies:
poetry shell
poetry add fastapi-mail
for aioredis and httpx
poetry add 'fastapi-mail[aioredis]'
poetry add 'fastapi-mail[httpx]'
Documentation: FastApi-MAIL
The key features are:
- sending emails either with FastApi or using asyncio module
- sending emails using FastApi background 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 available classes
DefaultChecker
andWhoIsXmlApi
- Unittests using FastapiMail
More information on Getting-Started
Guide
from typing import List
from fastapi import BackgroundTasks, FastAPI
from fastapi_mail import ConnectionConfig, FastMail, MessageSchema, MessageType
from pydantic import BaseModel, EmailStr
from starlette.responses import JSONResponse
class EmailSchema(BaseModel):
email: List[EmailStr]
conf = ConnectionConfig(
MAIL_USERNAME ="username",
MAIL_PASSWORD = "**********",
MAIL_FROM = "test@email.com",
MAIL_PORT = 465,
MAIL_SERVER = "mail server",
MAIL_STARTTLS = False,
MAIL_SSL_TLS = True,
USE_CREDENTIALS = True,
VALIDATE_CERTS = True
)
app = FastAPI()
html = """
<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"),
body=html,
subtype=MessageType.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.
Contributors ✨
Thanks goes to these wonderful People
Contributing
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-1.5.0.tar.gz
(13.3 kB
view details)
Built Distribution
File details
Details for the file fastapi_mail-1.5.0.tar.gz
.
File metadata
- Download URL: fastapi_mail-1.5.0.tar.gz
- Upload date:
- Size: 13.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/2.1.3 CPython/3.9.22 Linux/6.11.0-1014-azure
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
d2e59cde8ef27e5c9e196639c9506b895000350e19a13b3e0a60cd4e33813f09
|
|
MD5 |
6b262f65f29e18c5d01b9a84ee5a8024
|
|
BLAKE2b-256 |
c03b8987e2472303a7e3d12983c6edc62f85948df10439e067bb19355cbd3326
|
File details
Details for the file fastapi_mail-1.5.0-py3-none-any.whl
.
File metadata
- Download URL: fastapi_mail-1.5.0-py3-none-any.whl
- Upload date:
- Size: 15.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/2.1.3 CPython/3.9.22 Linux/6.11.0-1014-azure
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
c7c811a2a06e5aa3e444f8ae15052479a7726ca52e82c31b9e7bbac51a491204
|
|
MD5 |
3d3542641a382c9a89de3d912471f22a
|
|
BLAKE2b-256 |
93c09632fcf5201e9481ec0ac8d107f3b2ec058245325a235f0c651601e3552b
|