Metadata-Version: 1.1
Name: django-mailrobot
Version: 0.3.1
Summary: Stores and sends canned email responses.
Home-page: UNKNOWN
Author: kaleissin
Author-email: kaleissin@gmail.com
License: UNKNOWN
Description: ================
        django-mailrobot
        ================
        
        Stores and sends canned email responses.
        
        Ever had to change the signature or add a recipient to N hardcoded emails
        spread all throughout your code? Hardcode no more! Use mailrobot instead.
        
        Installation
        ============
        
        1. Install the library, for instance with pip::
        
            pip install django-mailrobot
        
        2. Add the library to your INSTALLED_APPS of an exiting project::
        
            INSTALLED_APPS += ['mailrobot']
        
        3. Add the tables to the existing project.
        
           Prior to django 1.7::
        
                $ ./manage.py syncdb
        
           With South::
        
                $ ./manage.py schemamigration --initial mailrobot
                $ ./manage.py migrate mailrobot
        
        Demo
        ====
        
        Copy the entire django-mailrobot directory somewhere, set up and enter a
        virtualenv, then provided you are on some Un*x::
        
            make demo
        
        This'll ask you to make an admin user. Do so.
        
        The demo should now be running on http://127.0.0.1/
        
        Tests
        =====
        
        To run the tests, first install the testing-requirements::
        
            pip install -r requirements/test.txt
        
        then run the tests with::
        
            make test APP=mailrobot
        
        Usage
        =====
        
        Add mails and addresses through the django admin.
        
        In code
        -------
        
        Fetch a mail-template::
        
            template = Mail.objects.get(name='hello-world').
        
        Fill it::
        
            mail = template.make_message(
                sender='Yep <overridden-from@example.com'>,
                recipients=('extra1@example.com', u'Blåbærsyltetøy <extra2@example.com>'),
                context={'world': 'Mailrobot'}
            )
        
        Have a look::
        
            print mail.message
        
        Send it::
        
            mail.send()
        
        Niceties
        ========
        
        In case you need to send an email somewhere else for
        testing/debugging, clone an existing email in the admin:
        
        1. Select it
        2. Choose "Clone selected mails" in the action list
        3. Hit "Go"
        
        The clone will share everything with its original except the name,
        which will be suffixed with a timestamp.
        
        Edit the name of the clone to what you need, change recipients,
        CCs, BCCs. Then, where you send the mail from, choose the clone if
        settings.DEBUG is True.
        
        :Version: 0.3.1
        
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Classifier: Topic :: Software Development :: Libraries :: Python Modules
