Metadata-Version: 2.1
Name: incuna-mail
Version: 4.1.1
Summary: Pythonic utility for sending template based emails with Django.
Home-page: https://github.com/incuna/incuna-mail
Author: Incuna Ltd
Author-email: admin@incuna.com
License: MIT
Description: # Incuna Mail  [![Build Status](https://travis-ci.org/incuna/incuna-mail.svg?branch=i5-add-tests)](https://travis-ci.org/incuna/incuna-mail)  [![Coverage Status](https://img.shields.io/coveralls/incuna/incuna-mail.svg)](https://coveralls.io/r/incuna/incuna-mail) [![Wheel Status](https://img.shields.io/pypi/wheel/incuna-mail.svg)](https://pypi.python.org/pypi/incuna-mail/) [![Latest Version](https://img.shields.io/pypi/v/incuna-mail.svg)](https://pypi.python.org/pypi/incuna-mail/)
        
        Pythonic utility for sending template based emails with Django.
        
        ## Installation
        Install the package:
        
            pip install incuna_mail
        
        
        ## Usage
        Import the `send` function and call it:
        
        ```python
        from incuna_mail import send
        
        send(
            to='foo@example.com',
            subject='Example email',
            template_name='plaintext_email.txt',
        )
        ```
        
        Supports `cc` and `bcc`...
        
        ```python
        send(
            to='foo@example.com',
            cc='bar@example.com',
            bcc='baz@example.com',
            ...
        )
        ```
        
        ... lists of recipients...
        
        ```python
        send(
            to=['foo@example.com', 'bar@example.com'],
            cc=['spam@example.com', 'eggs@example.com'],
            ...
        )
        ```
        
        ... multi-part emails...
        
        ```python
        send(
            ...
            template_name='plaintext_email.txt',
            html_template_name='html_email.html',
        )
        ```
        
        ... template context...
        
        ```python
        send(
            ...
            context={'user': user},
        )
        ```
        
        ... template lists...
        
        ```python
        send(
            ...
            # Uses the first template found.
            template_name=['might-exist.html', 'will-exist.html'],
        )
        ```
        
        ... reply-to addresses...
        
        ```python
        send(
            ...
            reply_to=['another@example.com'],
        )
        ```
        
        ... and custom email headers:
        
        ```python
        send(
            ...
            headers={'Extra-Header': 'This will appear among the email headers'}
        )
        ```
        
        The email sender can be set globally with `settings.DEFAULT_FROM_EMAIL`, and will default to `settings.SERVER_EMAIL`. It can be explicitly set on each call, if required:
        
        ```python
        send(
            ...
            sender='eggy-mcspambot@example.com',
        )
        ```
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Framework :: Django
Classifier: Framework :: Django :: 1.8
Classifier: Framework :: Django :: 1.11
Classifier: Framework :: Django :: 2.2
Classifier: Framework :: Django :: 3.0
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Communications :: Email
Classifier: Topic :: Utilities
Description-Content-Type: text/markdown
