emencia.django.newsletter 0.1

Features

More than a long speech, here the list of the main features :

• Coupling capacities with another django model.

• Variables can be used in the newsletter’s templates.

• Mailing list managements (merging, importing…).

• Configurable SMTP servers with flow limit management.

• Can send newsletter previews.

• Unsubscriptions to mailing list.

• Unique urls for an user.

• Tracking statistics.

Architecture

At the level of the application architecture, we can see 2 originalities who need to be explained.

$> python manage.py send_newsletter

Installation

First of all you need to install emencia.django.newsletter into your PYTHON_PATH.

Then register this module, admin and contenttypes in your INSTALLED_APPS section your project settings.

>>> INSTALLED_APPS = (
...   # Your favorites apps
..    'django.contrib.contenttypes',
...   'django.contrib.admin',
...   'emencia.django.newsletter',)

In your project urls.py adding this following line to include the newsletter’s urls for serving the newsletters in HTML.

>>> (r'^newsletters/', include('emencia.django.newsletter.urls')),

Now you can run a syncdb for installing the models into your database.

HOWTO couple your profile application with emencia.django.newsletter

If you wan to quickly import your contacts into a mailing list for example, you can write an admin’s action for your model.

We suppose that we have the fields email, first_name and last_name in a models name Profile.

In his AdminModel definition add this method and register it into the actions property.

>>> class ProfileAdmin(admin.ModelAdmin):
...
...   def make_mailing_list(self, request, queryset):
...     from emencia.django.newsletter.models import Contact
...     from emencia.django.newsletter.models import MailingList
...
...     subscribers = []
...     for profile in queryset:
...       contact, created = Contact.objects.get_or_create(email=profile.mail,
...                                                        defaults={'first_name': profile.first_name,
...                                                                  'last_name': profile.last_name,
...                                                                  'content_object': profile})
...     subscribers.append(contact)
...     new_mailing = MailingList(name='New mailing list',
...                               description='New mailing list created from admin/profile')
...     new_mailing.save()
...     new_mailing.subscribers.add(*subscribers)
...     new_mailing.save()
...     self.message_user(request, '%s succesfully created.' % new_mailing)
...   make_mailing_list.short_description = 'Create a mailing list'
...
...   actions = ['make_mailing_list',]

This action will create or retrieve all the Contact instances needed for the mailing list creation.

After this you can send a newsletter to this mailing list.

Database Representation

Changelog

0.1dev (unreleased)

• Initial release