https://github.com/philippWassibauer/templated-emails

A simple app (that works similar to django-notification) that allows you to send emails by specifying a short.txt (subject), email.txt (plain text), and email.html (html email, optional) in a folder. When you send the email you only have to specify the folder and the context.
https://github.com/philippWassibauer/templated-emails

Last synced: about 2 months ago
JSON representation

A simple app (that works similar to django-notification) that allows you to send emails by specifying a short.txt (subject), email.txt (plain text), and email.html (html email, optional) in a folder. When you send the email you only have to specify the folder and the context.

• Host: GitHub
• URL: https://github.com/philippWassibauer/templated-emails
• Owner: philippWassibauer
• License: mit
• Created: 2011-02-10T17:28:41.000Z (over 13 years ago)
• Default Branch: master
• Last Pushed: 2016-07-08T14:18:29.000Z (about 8 years ago)
• Last Synced: 2024-07-24T21:10:33.989Z (2 months ago)
• Language: Python
• Homepage:
• Size: 251 KB
• Stars: 60
• Watchers: 5
• Forks: 31
• Open Issues: 5
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
================

templated-emails

================

This app abstracts the sending of emails in a way so that it is possible to

switch from plain text emails to html emails, even if you are using third party apps. 

It does this by using a very similar mechanism as django-notifications.

Each email gets a folder. In this folder one can put:

* short.txt (for the subject)

* email.txt (for the plain text email)

* email.html (optional, if an HTML email should also be sent)

A good practice is to put all emails in an emails/ folder within your templates folder,

so it is easy to see what emails are being sent by your system.

Recipients can either be an array of emails (as strings) or users.

If you pass users it will also try to find the users stored language

(accounts.Account.language in pinax) and send it using it.

Sending an emails works like this::

    from templated_emails.utils import send_templated_email

    send_templated_email(["[email protected]"], "emails/invite_friends", {"my_variable":"blafoo"})

    

or

::

    

    user = User.objects.get(pk=1)

    # this will try to switch to the correct language of the user

    send_templated_email([user], "emails/invite_friends", {"my_variable":"blafoo"})

    

The system will add current_site (the Site object of the Django Project)

and STATIC_URL (for linking in static content) to the context of your templates.

Language

========

Similar to django-notification the system will try to look for the language the

user has set in his Account (but can be configured to other Models using settings.NOTIFICATION_LANGUAGE_MODULE)

to server the right language to each user.

Inline CSS Rules

================

Inline CSS Rules are annoying and tedious, but a neccessity if you want to support all email clients.

Since 0.3 pynliner is included that will take the CSS from the HEAD and put it into each element that matches the rule

There is a toggle you can set in settings.py to turn this feature on or off:

TEMPLATEDEMAILS_USE_PYNLINER = False is the default value.

Celery

======

Pynliner can be quite slow when inlining CSS. You can move all the execution

to Celery with this setting (default is False)::

    TEMPLATEDEMAILS_USE_CELERY = True

Please note that the given context is passed to Celery unchanged.

Install

=======

::

    pip install -e http://github.com/philippWassibauer/templated-emails.git#egg=templated-emails

or

::

    pip install templated-emails

Dependencies

============

* pynliner

* cssutils

Follow Me

=========

* http://github.com/philippWassibauer

* http://twitter.com/__philw__

* http://philippw.tumblr.com

* https://bitbucket.org/philippwassibauer