Metadata-Version: 1.1
Name: django_simple_mail
Version: 1.2.1
Summary: A simple and customizable email template built for Django
Home-page: https://github.com/charlesthk/django-simple-mail
Author: Charles TISSIER
Author-email: charles@vingtcinq.io
License: MIT
Description: |django-simple-mail v1.2.1 on PyPi| |MIT license| |Stable|
        
        django-simple-mail
        ==================
        
        Simple customizable email template built for Django
        
        Requirements
        ------------
        
        These Django app works with :
        
        -  Python (>=2.7) (Need to be tested for 3.x)
        -  Django (>=1.9) (Need to be tested for previous versions)
        
        Installation
        ------------
        
        Install using ``pip`` :
        
        ``pip install django_simple_mail``
        
        Add ``simple_mail`` to your INSTALLED_APPS setting.
        
        .. code:: python
        
            INSTALLED_APPS = (
                ...
                'simple_mail',
            )
        
        Then run :
        
        ``python manage.py makemigrations`` ``python manage.py migrate``
        
        Preview and customization:
        --------------------------
        
        The default mail template is a fork of `Mailchimp
        email-blueprints <https://github.com/mailchimp/email-blueprints/blob/master/responsive-templates/base_boxed_basic_query.html>`__
        and looks like this with placeholder values:
        
        .. figure:: https://raw.githubusercontent.com/charlesthk/django-simple-mail/master/docs/preview.png
           :alt: Email Preview
        
           Email Preview
        
        You can customize the template with ``CONTEXT`` settings :
        
        ::
        
            DEFAULTS = {
                'CONTEXT': {
                    'header_url': 'http://placehold.it/1200x300',
                    'footer_content': "",
                    'colors': {
                        'background': "#222222",
                        'container_bg': "#FFFFFF",
                        'title': "#2C9AB7",
                        'content': "#444444",
                        'footer': "#888888",
                        'footer_bg': "#555555",
                        'button': "#FFFFFF",
                        'button_bg': "#2C9AB7",
                    }
                },
                'TEMPLATE': 'simple_mail/default.html',
                'EMAIL_TO': '',
                'EMAILS': [],
                'BASE_URL': '',
                'FROM_EMAIL': ''
            }
        
        Django Admin
        ------------
        
        You can manage your emails and their content directly from django admin
        :
        
        .. figure:: https://raw.githubusercontent.com/charlesthk/django-simple-mail/master/docs/admin.png
           :alt: Admin Preview
        
           Admin Preview
        
        You can also use variables inside the fields to make your content more
        dynamic :
        
        .. figure:: https://raw.githubusercontent.com/charlesthk/django-simple-mail/master/docs/admin-context.png
           :alt: Admin Preview
        
           Admin Preview
        
        Settings
        --------
        
        Here are all the settings you can define:
        
        ::
        
            SIMPLE_MAIL = {
                'CONTEXT': {
                    'header_url': 'http://placehold.it/1200x300',
                    'footer_content': "",
                    'colors': {
                        'background': "#222222",
                        'container_bg': "#FFFFFF",
                        'title': "#2C9AB7",
                        'content': "#444444",
                        'footer': "#888888",
                        'footer_bg': "#555555",
                        'button': "#FFFFFF",
                        'button_bg': "#2C9AB7",
                    }
                },
                'TEMPLATE': 'simple_mail/default.html',
                'EMAIL_TO': '',
                'EMAILS': [],
                'BASE_URL': '',
                'FROM_EMAIL': ''
            }
        
        ``CONTEXT``
        ~~~~~~~~~~~
        
        Defines the values that needs to be populated to all your emails.
        
        ``TEMPLATE``
        ~~~~~~~~~~~~
        
        Defines the path to the template that is used by default. You can use
        this setting in case your want to modify the default template.
        
        ``EMAILS``
        ~~~~~~~~~~
        
        Defines the list of different emails that are used inside your project,
        for example :
        
        ::
        
            DEFAULTS = {
                'EMAILS': [
                    ['RESETPWD', 'Reset password'],
                    ['WELCOME', 'Welcome a user'],
                    ['VALIDATE', 'Validate a user email'],
                ]
            }
        
        ``BASE_URL``
        ~~~~~~~~~~~~
        
        Defines the base url to resolve links.
        
        ``FROM_EMAIL``
        ~~~~~~~~~~~~~~
        
        Defines the mail to send from by default.
        
        Support
        -------
        
        If you are having issues, please let us know or submit a pull request.
        
        License
        -------
        
        The project is licensed under the MIT License.
        
        .. |django-simple-mail v1.2.1 on PyPi| image:: https://img.shields.io/badge/pypi-1.2.1-green.svg
           :target: https://pypi.python.org/pypi/django-simple-mail
        .. |MIT license| image:: https://img.shields.io/badge/licence-MIT-blue.svg
        .. |Stable| image:: https://img.shields.io/badge/status-stable-green.svg
        
        
Keywords: python django mail html template
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: License :: OSI Approved :: MIT License
Classifier: Framework :: Django :: 2.1
Classifier: Framework :: Django :: 2.0
Classifier: Framework :: Django :: 1.11
Classifier: Framework :: Django :: 1.10
Classifier: Framework :: Django :: 1.9
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.3
Classifier: Programming Language :: Python :: 2.4
Classifier: Programming Language :: Python :: 2.5
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
