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 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
DefaultCheckerandWhoIsXmlApi - 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 (🚧):
🚧
This project follows the all-contributors specification. Contributions of any kind are welcome!
Before you start please read CONTRIBUTING
LICENSE
1 maintainer
Metadata
1 maintainer
Release files for fastapi-mail 1.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| fastapi-mail-1.0.0.tar.gz | 14.9 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| fastapi_mail-1.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 30.1 kB
Release files / fastapi-mail-1.0.0.tar.gz
| Download URL | fastapi-mail-1.0.0.tar.gz |
|---|---|
| Size | 14.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c4854cb4306f5d04902ae9a52cef1f9504cb24f16a60711ee424cc0705277474
|
|
BLAKE2b-256 checksum How to use checksums |
6165e42d55a6bcbe8f41543846a94d30fb02d4b793c99e87e7097fe8f09944b0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.1.9 CPython/3.8.11 Linux/5.8.0-1041-azure
|
Release files / fastapi_mail-1.0.0-py3-none-any.whl
| Download URL | fastapi_mail-1.0.0-py3-none-any.whl |
|---|---|
| Size | 15.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
db370fc2b985f7d4915c7712250ec9ff20149f6d1794fc75de7973c6e48c7ebc
|
|
BLAKE2b-256 checksum How to use checksums |
f6f875478177dc7d7fc3d47e4d5e8642921b44b296bab40f83d0d8216ee72f99
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.1.9 CPython/3.8.11 Linux/5.8.0-1041-azure
|
Security for fastapi-mail 1.0.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
