Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/marktennyson/fastapi-mailman
Porting Django's email implementation to your FastAPI applications.
https://github.com/marktennyson/fastapi-mailman
fastapi fastapi-extension fastapi-framework fastapi-library fastapi-mail fastapi-mailman fastapi-smtp smtp
Last synced: 2 months ago
JSON representation
Porting Django's email implementation to your FastAPI applications.
- Host: GitHub
- URL: https://github.com/marktennyson/fastapi-mailman
- Owner: marktennyson
- License: mit
- Created: 2021-09-29T10:20:59.000Z (about 3 years ago)
- Default Branch: development
- Last Pushed: 2023-01-16T07:17:39.000Z (almost 2 years ago)
- Last Synced: 2024-09-27T09:43:23.335Z (3 months ago)
- Topics: fastapi, fastapi-extension, fastapi-framework, fastapi-library, fastapi-mail, fastapi-mailman, fastapi-smtp, smtp
- Language: Python
- Homepage: http://gh.aniketsarkar.site/fastapi-mailman/
- Size: 734 KB
- Stars: 19
- Watchers: 1
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# 📬 Fastapi-Mailman
### 🔥 Porting Django's email implementation to your FastAPI applications.
[](https://github.com/marktennyson/fastapi-mailman/actions/workflows/dev.yml)
Fastapi-Mailman is a Fastapi extension providing simple email sending capabilities. It's actually a hard fork of `waynerv's` `flask-mailman` module. I have tried to implement the same features for the `Fastapi` too.
It was meant to replace the basic Fastapi-Mail with a better warranty and more features.
## ⛲ Key Features:
1. Easy to use.
2. Backend based email sender.
3. Customisable backend class.
4. Proper testcases.
5. Proper documentation.
## 🔗 Important Links:
[Github Repo](https://github.com/marktennyson/fastapi-mailman)
[PYPI](https://pypi.org/project/fastapi-mailman)
[Documentation](https://marktennyson.github.io/fastapi-mailman)
## 💯 Usage
Fastapi-Mailman ported Django's email implementation to your Fastapi applications, which may be the best mail sending implementation that's available for python.
The way of using this extension is almost the same as Django.
Documentation: [https://marktennyson.github.io/fastapi-mailman.](https://marktennyson.github.io/fastapi-mailman)
## 🪜 Basic Example
```python
from fastapi import FastAPI
import uvicorn as uv
from fastapi_mailman import Mail, EmailMessage
from fastapi_mailman.config import ConnectionConfig
app = FastAPI(debug=True)
config = config = ConnectionConfig(
MAIL_USERNAME = '[email protected]',
MAIL_PASSWORD = "7655tgrf443%$",
MAIL_BACKEND = 'smtp',
MAIL_SERVER = 'smtp.gmail.com',
MAIL_PORT = 587,
MAIL_USE_TLS = True,
MAIL_USE_SSL = False,
MAIL_DEFAULT_SENDER = '[email protected]',
)
mail = Mail(config)
@app.get("/send-base")
async def send_base():
msg = EmailMessage('this is subject', 'this is message', to=['[email protected]'])
await msg.send()
return {"Hello": "World"}
@app.get("/send-mail")
async def check_send_mail():
await mail.send_mail("this is subject", "this is message", None, ["[email protected]"])
return {"Hello": "World"}
if __name__ == "__main__":
uv.run(app, port=8082, debug=True)
```
## 🚇 Development
#### 🧑💻 Contribution procedure.
1. Create a new issue on github.
2. Fork and clone this repository.
3. Make some changes as required.
4. Write unit test to showcase its functionality.
5. Submit a pull request under the `master` branch.
#### 🖨️ Run this project on your local machine.
To run this project on your local machine please [click here](https://marktennyson.github.io/fastapi-mailman/contributing)
### ❤️ Contributors
Credits goes to these peoples:
## 📝 License
[MIT](https://github.com/marktennyson/fastapi-mailman/blob/master/LICENSE)
Copyright (c) 2021 Aniket Sarkar([email protected])