Fastapi-mail

The fastapi-mail simple lightweight mail system, sending emails and attachments(individual && bulk)

WARNING!

This is a uvicorn compatible fork of the original library, which ditches aiosmtplib due to it using asyncio Locks, which breaks down with uvicorn + gunicorn (for some reason).

This means that the sending logic in this library is synchronous in order to ensure functionality.

🔨 Installation

 $ pip install fastapi-mail

Documentation: FastApi-MAIL

The key features are:

sending emails with 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 and WhoIsXmlApi
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 = "[email protected]",
    MAIL_PORT = 587,
    MAIL_SERVER = "your mail server",
    MAIL_TLS = True,
    MAIL_SSL = False,
    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"),  # 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

Feel free to open issues and send pull requests.

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} 📖 🚧 🔧	_Gogoku 📖 🚧 🔧	_Kucera-Lukas 📖 🚧 🔧	_LLYX 📖 🚧 🔧
_floodpants 🚧	_{André Felipe Dias} 📖 👀 🔧	_{Wojtek Jurkowlaniec} 📖 👀 🔧