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 🚧 |
Dmitriy Solodkiy 🚧 |
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.2.0.tar.gz
(15.1 kB
view details)
Built Distribution
File details
Details for the file fastapi-mail-0.3.2.0.tar.gz
.
File metadata
- Download URL: fastapi-mail-0.3.2.0.tar.gz
- Upload date:
- Size: 15.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.55.0 CPython/3.7.9
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6b3871eb6c36a90fbbeacabc52c0d6489cf683c9981d687dc7e481468db690c7 |
|
MD5 | 1c6c1359550c7f354d5934cfb395b58f |
|
BLAKE2b-256 | 6fcc512ba8c1bbba45e53a848e1f9896eb1435163f4fc634a18074ff093bca6b |
File details
Details for the file fastapi_mail-0.3.2.0-py3-none-any.whl
.
File metadata
- Download URL: fastapi_mail-0.3.2.0-py3-none-any.whl
- Upload date:
- Size: 18.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.55.0 CPython/3.7.9
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3b8e4de521b12212b5da8d09abfbcb5b1bec74a0b5b39354c14eba99e1a412ae |
|
MD5 | c8fba092c606d3989d2dc2e6f6baae5e |
|
BLAKE2b-256 | 07b5049d5ac4b1431e71e7e9f3a52bd37bc3f804f49391609729c5e6ffc0c89f |