Skip to content

Commit

Permalink
Merge pull request #19 from marktennyson/development
Browse files Browse the repository at this point in the history
Bump version: 0.0.4 → 0.0.5
  • Loading branch information
marktennyson authored Sep 23, 2021
2 parents 8979233 + 088e1f4 commit 4f77c03
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 33 deletions.
51 changes: 26 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,45 @@
# Flask-Mailing
# ✉️ Flask-Mailing
![Flask mail logo](https://github.com/marktennyson/flask-mailing/blob/main/logo/flask-mailing-logo-cropped.png?raw=true)

Flask-Mailing adds SMTP mail sending to your Flask applications

Flask_Mail is dead now. To use the mail service with your project you can use eaither [Flask-Mailing](https://github.com/marktennyson/flask-mailing) for legacy or [Flask-Mailman](https://github.com/waynerv/flask-mailman) for Django type implementation.
**Flask_Mail** is dead now. This is the time to migrate a fully asynchronous based mailer library to send emails while using a Flask based application. Now Flask 2.0 supports the asynchronous view function then who is stopping you to use __Flask-Mailing__ ?

Flask-Mailing is a fork of `Sabuhi's` Fastapi-Mail package, providing similar functionality. 99% of the work was done by him, and the fork was made mainly provide the same features and the apis for the Flask Microframework.

# Downloads
__The key features are:__

- Most of the Apis are very familiar with `Flask-Mail` module.
- sending emails with either with Flask or using asyncio module
- 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 Mail

More information on [Getting-Started](https://marktennyson.github.io/flask-mailing/getting-started)

# 📥 Downloads
[![Downloads](https://pepy.tech/badge/flask-mailing)](https://pepy.tech/project/flask-mailing) [![Downloads](https://pepy.tech/badge/flask-mailing/month)](https://pepy.tech/project/flask-mailing) [![Downloads](https://pepy.tech/badge/flask-mailing/week)](https://pepy.tech/project/flask-mailing)
<br>

# 🔗 Important Links
#### ❤️ [Github](https://github.com/marktennyson/flask-mailing)
#### 📄 [Documentation](https://marktennyson.github.io/flask-mailing)
#### 🐍 [PYPI](https://pypi.org/project/flask-mailing)

### 🔨 Installation ###
# 🔨 Installation ###

```bash
pip install flask-mailing
```
or install from source code
```bash
git clone https://github.com/marktennyson/flask-mailing.git && cd flask-mailing
python setup.py install
python -m pip install .
```

---
**Documentation**: [Flask-MAILING](https://marktennyson.github.io/flask-mailing)
---

The key features are:

- sending emails with either with Flask or using asyncio module
- 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 Mail

More information on [Getting-Started](https://marktennyson.github.io/flask-mailing/getting-started)

### Guide
# 🦮 Guide


```python
Expand Down Expand Up @@ -80,14 +81,14 @@ async def simple_send() -> JSONResponse:
return jsonify(status_code=200, content={"message": "email has been sent"})
```

## List of Examples
# 🪜 List of Examples

For more examples of using flask-mailing please check [example](https://marktennyson.github.io/flask-mailing/example/) section

# Contributing
# 👍 Contributing
Feel free to open issues and send pull requests.

## Contributors ✨
## 😀 Contributors ✨

Thanks goes to these wonderful people ([🚧]):

Expand All @@ -105,6 +106,6 @@ Before you start please read [CONTRIBUTING](https://github.com/marktennyson/flas



## LICENSE
# 📝 LICENSE

[MIT](LICENSE)
17 changes: 9 additions & 8 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
aioredis==2.0.0
aiosmtplib==1.1.6
asgiref==3.4.1
blinker==1.4
email-validator==1.1.3
httpx==0.18.2
pydantic==1.8.2
typing-extensions==3.10.0.0
aioredis>=2.0.0
aiosmtplib>=1.1.6
asgiref>=3.4.1
blinker>=1.4
email-validator>=1.1.3
httpx>=0.19.0
pydantic>=1.8.2
typing-extensions>=3.10.0.0
Flask>=2.0.0

0 comments on commit 4f77c03

Please sign in to comment.