Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Miksus/red-mail
Advanced email sending for Python
https://github.com/Miksus/red-mail
email email-sender python smtp
Last synced: 2 months ago
JSON representation
Advanced email sending for Python
- Host: GitHub
- URL: https://github.com/Miksus/red-mail
- Owner: Miksus
- License: mit
- Created: 2021-12-31T07:31:24.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2024-04-18T04:45:17.000Z (9 months ago)
- Last Synced: 2024-10-30T17:04:06.437Z (2 months ago)
- Topics: email, email-sender, python, smtp
- Language: Python
- Homepage: https://red-mail.readthedocs.io
- Size: 663 KB
- Stars: 396
- Watchers: 7
- Forks: 32
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- my-awesome-github-stars - Miksus/red-mail - Advanced email sending for Python (Python)
README
# Red Mail: Advanced Email Sender
> Next generation email sender
---
[](https://pypi.org/project/redmail/)
[](https://github.com/Miksus/red-mail/actions/workflows/main.yml)
[](https://codecov.io/gh/Miksus/red-mail)
[](https://red-mail.readthedocs.io/en/latest/)
[](https://pypi.org/project/redmail/)
## What is it?
Red Mail is an advanced email sender library.
It is a sister library for [Red Box, advanced email reader](https://github.com/Miksus/red-box).
It makes sending emails trivial and has a lot of advanced features such as:
- [Attachments](https://red-mail.readthedocs.io/en/stable/tutorials/attachments.html)
- [Templating (with Jinja)](https://red-mail.readthedocs.io/en/stable/tutorials/jinja_support.html)
- [Embedded images](https://red-mail.readthedocs.io/en/stable/tutorials/body_content.html#embedded-images)
- [Prettified tables](https://red-mail.readthedocs.io/en/stable/tutorials/body_content.html#embedded-tables)
- [Send as cc or bcc](https://red-mail.readthedocs.io/en/stable/tutorials/sending.html#sending-email-with-cc-and-bcc)
- [Gmail preconfigured](https://red-mail.readthedocs.io/en/stable/tutorials/config.html#gmail)
See more from the [documentations](https://red-mail.readthedocs.io)
or see [release from PyPI](https://pypi.org/project/redmail/).
Install it from PyPI:
```shell
pip install redmail
```
## Why Red Mail?
Sending emails **SHOULD NOT** be this complicated:
```python
import smtplib
from email.mime.multipart import MIMEMultipart
from email.mime.text import MIMEText
msg = MIMEMultipart('alternative')
msg['Subject'] = 'An example email'
msg['From'] = '[email protected]'
msg['To'] = '[email protected]'
part1 = MIMEText("Hello!", 'plain')
part2 = MIMEText("
Hello!
", 'html')
msg.attach(part1)
msg.attach(part2)
# Send the message via our own SMTP server.
s = smtplib.SMTP('localhost', port=0)
s.send_message(msg)
s.quit()
```
With Red Mail, it is simple as this:
```python
from redmail import EmailSender
email = EmailSender(host="localhost", port=0)
email.send(
subject="An example email",
sender="[email protected]",
receivers=['[email protected]'],
text="Hello!",
html="
Hello!
"
)
```
More examples:
- [simple example](https://red-mail.readthedocs.io/en/stable/tutorials/example.html#simple-example)
- [email with attachments](https://red-mail.readthedocs.io/en/stable/tutorials/example.html#attachments)
- [email with embedded images](https://red-mail.readthedocs.io/en/stable/tutorials/example.html#embedded-images)
- [email with embedded plots](https://red-mail.readthedocs.io/en/stable/tutorials/example.html#embedded-plots)
- [email with body parameters](https://red-mail.readthedocs.io/en/stable/tutorials/example.html#parametrization)
See practical examples from the [cookbook](https://red-mail.readthedocs.io/en/stable/tutorials/cookbook.html).
---
## Author
* **Mikael Koli** - [Miksus](https://github.com/Miksus) - [email protected]