django-db-mailer 1.0

Simple version of this app without celery settings, bcc, api, mail settings, signals, mail groups and model browser.

What's that
-----------
Django module to easily send emails using django templates stored on database.
From box you can use it with django-celery for send background messages.
Also you have opportunity create reports from logs by mail categories and slug.
That app very simple to install and use on your projects.


Installation:
-------------

1. Using pip:

.. code-block:: bash

$ pip install django-db-mailer

2. Add the ``dbmail`` application to ``INSTALLED_APPS`` in your settings file (usually ``settings.py``)
3. Sync database (``./manage.py syncdb``)


Usage examples
--------------

.. code-block:: python

from dbmail.models import MailTemplate
from dbmail import send_db_mail

# New dbmail template
MailTemplate.objects.create(
name="Site welcome template",
subject="Welcome",
message="Welcome to our site. We are glad to see you.",
slug="welcome",
is_html=False,
)

# Send message with created template
send_db_mail(
# slug was defined on db template
slug='welcome',

# recipient can be list, or separated with comma or simple string
# '[e-mail]' or '[e-mail], [e-mail]' or ['[e-mail]', '[e-mail]']
recipient='[e-mail]',

# All *args params will be accessible on template context
{
'username': request.user.username,
'full_name': request.user.get_full_name(),
'signup_date': request.user.date_joined
},

# You can access to all model fields. For m2m and fk fields, you should use module_name
MyModel.objects.get(pk=1),

# Optional kwargs:
# from_email='[e-mail]'
# cc=['[e-mail]'],
# bcc=['[e-mail]'],
# user=User.objects.get(pk=1),
# from_email='[e-mail]',
# attachments=[(filename, content, mimetype)],
# headers={'Custom-Header':'Some value'},
)


Local demo installation
-----------------------

.. code-block:: bash

$ sudo apt-get install virtualenvwrapper
$ mkvirtualenv django-db-mailer
$ git clone https://github.com/gotlium/django-db-mailer.git
$ cd django-db-mailer
$ python setup.py develop
$ cd demo
$ pip install -r requirements.txt
$ python manage.py syncdb
$ python manage.py migrate
$ python manage.py runserver


Screenshots
-----------

.. image:: /screenshots/template_edit.jpg
.. image:: /screenshots/templates_changelist.jpg
.. image:: /screenshots/template_log_changelist.jpg
.. image:: /screenshots/template_log_view.jpg


Compatibility:
-------------
* Python: 2.6, 2.7
* Django: 1.4, 1.5, 1.6