Skip to main content

Simple lightwigh mail sending for FastApi

Project description

Fastapi-mail

Fastapi with fastapi-mail simple lightweight

Fastapi mail system sending mails(individual, bulk) attachments(individual, bulk)

Installation

 $ pip install fastapi-mail

Email Send example

from fastapi import FastAPI
from starlette.responses import JSONResponse
from fastapi_mail import FastMail
from starlette.background import BackgroundTask
from test_examples.templates import  html, backgorund_task,bulkmail
from fastapi import File, Body,Query, UploadFile

app = FastAPI()

#test email standart sending mail 
@app.post("/email")
async def my_awesome_func_1(email: dict= Body(...)) -> JSONResponse:

    email = email.get("email")

    mail = FastMail("your_account@gmail.com","*********",tls=True)

    await  mail.send_message(email,"Test email from fastapi-mail", html, text_format="html")

    return JSONResponse(status_code=200, content={"message": f"email has been sent {email} address"})


#this mail sending using starlettes background tasks, faster than the above one
@app.post("/emailbackground")
async def my_awesome_func_2(email: dict= Body(...)) -> JSONResponse:

    email = email.get("email")

    mail = FastMail("your_account@gmail.com","*********",tls=True)

    task = BackgroundTask(mail.send_message, email,"Test email from fastapi-mail with background task",backgorund_task,text_format="html")

    return JSONResponse(status_code=200, 
                        content={"message": f"email has been sent {email} address"}, 
                        background=task)


#this an example of sending bulk mails
@app.post("/bulkemail")
async def my_awesome_func_3() -> JSONResponse:

    email = ["sabuhi.shukurov@gmail.com","sabus02@gmail.com"]
    mail = FastMail("your_account@gmail.com","*********",tls=True)


    task = BackgroundTask(mail.send_message, email,"Bulk mail from fastapi-mail with background task","Bulk mail Test",text_format="plain",bulk=True)

    return JSONResponse(status_code=200, content={"message": f"email has been sent to these {email} addresses"}, background=task)


#an example of sending bulk mails attaching files 
@app.post("/bulkfile")
async def my_awesome_func_4(file: UploadFile = File(...), file2: UploadFile = File(...)) -> JSONResponse:

    email = ["someaddress@gmail.com","address2@gmail.com"]
    mail = FastMail("your_account@gmail.com","*********",tls=True)


    task = BackgroundTask(mail.send_message, email,"Bulk mail from fastapi-mail with background task","Bulk mail Test",text_format="plain",bulk=True,file=[file,file2])

    return JSONResponse(status_code=200, content={"message": f"email has been sent to these {email} addresses"}, background=task)

Contributing

Fell free to open issue and send pull request.

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.1.0.tar.gz (4.4 kB view details)

Uploaded Source

Built Distribution

fastapi_mail-0.1.0-py3-none-any.whl (5.9 kB view details)

Uploaded Python 3

File details

Details for the file fastapi-mail-0.1.0.tar.gz.

File metadata

  • Download URL: fastapi-mail-0.1.0.tar.gz
  • Upload date:
  • Size: 4.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.42.0 CPython/3.7.3

File hashes

Hashes for fastapi-mail-0.1.0.tar.gz
Algorithm Hash digest
SHA256 2de60698ef724df8b87342ad2fd47e4e87137352de26c83811e96e88d1d56b6b
MD5 f64b8b59a4632bd3726e34477fd9ffda
BLAKE2b-256 d2a41869405bddd88ed04271383a927c2f8e952dbe160e5c41e8dc0ed46babbe

See more details on using hashes here.

File details

Details for the file fastapi_mail-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: fastapi_mail-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 5.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.42.0 CPython/3.7.3

File hashes

Hashes for fastapi_mail-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6a356729338e4dfb3ed64b2c64fa388b4f777f87b71b0692e4bcb87d9cbc5b51
MD5 573cdd6d6d67466ca3f497df02e7bb8a
BLAKE2b-256 b16833b3918a35549d01df4ddaa045cb0a7e8d41dc7081efaed227a128b5a44a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page