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
- NameEmail support - recipients can be specified as
"Name <email@domain.com>"format - email utils (utility allows you to check temporary email addresses, you can block any email or domain)
- email utils has two available classes
DefaultCheckerandWhoIsXmlApi - 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, NameEmail
from pydantic import BaseModel, EmailStr
from starlette.responses import JSONResponse
class EmailSchema(BaseModel):
email: List[NameEmail] # Supports both "user@example.com" and "Name <user@example.com>" formats
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"), # Can include "Name <email@domain.com>" format
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
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file fastapi_mail-1.6.6.tar.gz.
File metadata
- Download URL: fastapi_mail-1.6.6.tar.gz
- Upload date:
- Size: 14.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
poetry/2.4.1 CPython/3.11.16 Linux/6.17.0-1022-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5ba9053ada5f7582724468505d819d729248f1086f22febb03b6fc0ff9991691
|
|
| MD5 |
f4ba80df19ace4fda1b0848af8f136f7
|
|
| BLAKE2b-256 |
f3e04d45f69fe40b70cab93c74839a45147522d3e3fb603793a0280686505b4d
|
File details
Details for the file fastapi_mail-1.6.6-py3-none-any.whl.
File metadata
- Download URL: fastapi_mail-1.6.6-py3-none-any.whl
- Upload date:
- Size: 16.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
poetry/2.4.1 CPython/3.11.16 Linux/6.17.0-1022-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6f2310a93d734dcbdde97a9a7b00c8f41c185928349ea58265cb9be13ee53416
|
|
| MD5 |
a480e09c466dccff644a62024caa9362
|
|
| BLAKE2b-256 |
95ffa6c5ccb400337a417420f576f6ee9098a9af4a214c61afe5e103ddf6412d
|
