Metadata-Version: 2.1
Name: redmail
Version: 0.6.0
Summary: Email sending library
Author-email: Mikael Koli <koli.mikael@gmail.com>
License: MIT License
        
        Copyright (c) 2022 Mikael Koli
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/Miksus/red-mail
Project-URL: Documentation, https://red-mail.readthedocs.io
Project-URL: Funding, https://github.com/sponsors/Miksus
Project-URL: Source, https://github.com/Miksus/red-mail
Project-URL: Changelog, https://red-mail.readthedocs.io/en/stable/versions.html
Classifier: Topic :: Communications :: Email
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Customer Service
Classifier: Intended Audience :: Financial and Insurance Industry
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: test
Provides-Extra: docs
Provides-Extra: style
License-File: LICENSE


# Red Mail: Advanced Email Sender
> Next generation email sender

---

[![Pypi version](https://badgen.net/pypi/v/redmail)](https://pypi.org/project/redmail/)
[![build](https://github.com/Miksus/red-mail/actions/workflows/main.yml/badge.svg?branch=master)](https://github.com/Miksus/red-mail/actions/workflows/main.yml)
[![codecov](https://codecov.io/gh/Miksus/red-mail/branch/master/graph/badge.svg?token=IMR1CQT9PY)](https://codecov.io/gh/Miksus/red-mail)
[![Documentation Status](https://readthedocs.org/projects/red-mail/badge/?version=latest)](https://red-mail.readthedocs.io/en/latest/)
[![PyPI pyversions](https://badgen.net/pypi/python/redmail)](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'] = 'first.last@gmail.com'
msg['To'] = 'first.last@example.com'

part1 = MIMEText("Hello!", 'plain')
part2 = MIMEText("<h1>Hello!</h1>", '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="me@example.com",
    receivers=['first.last@example.com'],
    text="Hello!",
    html="<h1>Hello!</h1>"
)
```

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) - koli.mikael@gmail.com

