Skip to main content

Simple lightweight mail library for FastApi

Project description

Fastapi-mail

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

MIT licensed GitHub stars GitHub forks GitHub issues Downloads

๐Ÿ”จ 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 = "your@email.com",
    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

๐Ÿ“– ๐Ÿ‘€ ๐Ÿ”ง

This project follows the all-contributors specification. Contributions of any kind are welcome!

Before you start please read CONTRIBUTING

LICENSE

MIT

Project details


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.0.8.tar.gz (15.2 kB view hashes)

Uploaded source

Built Distribution

fastapi_mail-1.0.8-py3-none-any.whl (15.5 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page