{
    "info": {
        "author": "Michael Handerek",
        "author_email": "michael@handerek.net",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 5 - Production/Stable",
            "Environment :: Web Environment",
            "Framework :: Django",
            "Intended Audience :: Developers",
            "License :: OSI Approved :: BSD License",
            "Operating System :: OS Independent",
            "Programming Language :: Python",
            "Programming Language :: Python :: 2",
            "Programming Language :: Python :: 2.6",
            "Programming Language :: Python :: 2.7",
            "Programming Language :: Python :: 3",
            "Programming Language :: Python :: 3.2",
            "Programming Language :: Python :: 3.3",
            "Topic :: Internet :: WWW/HTTP"
        ],
        "description": "# django-mailto\n\ndjango-mailto is a simple reusable Django app, which enables you to send, manage and queue the sending of templated\nand multilingual emails.\n\nQueueing is an optional feature, which will be enabled when [celery - Distributed Task Queue](https://github.com/celery/celery) \nis up and running within your project.\n\n## Dependencies\n\n- [Django >= 1.4](https://www.djangoproject.com/)\n- [Celery >= 3.0.0](http://www.celeryproject.org/) (optional)\n\n## Features\n\n- simple interface `mailto(['test@localhost'], 'test')`\n- inline editing of HTML mails\n- send mails asynchron\n- Opt-In/-Out\n\n## Getting started\n\n1. `pip install django-mailto`\n\n2. Add `mailto` to your `INSTALLED_APPS` settings:\n\n    ```\n    INSTALLED_APPS = (\n        ...\n        'mailto',\n    )\n    ```\n\n3. And add it to your urls:\n\n    ```\n    urlpatterns += patterns('',\n        url(r'^mailto/', include('mailto.urls')),\n    )\n    ```\n\n4. Finally run `manage.py syncdb`.\n\n\n## Usage\n\n`mailto(recipients, slug, language_code=settings.LANGUAGE_CODE, context={}, from_email=None, reply_to=None, cc=[], bcc=[], headers={}, attachments=[])`\n\nParameters:\n\n- **recipients** (list) - A list of recipeint addresses.\n- **slug** (string) - Slug of Mail object to be sent.\n- **language_code** (string) - Language code.\n- **context** (dict) - A dictionary of additional context.\n- **from_email** (string) - Senders email address, will override `sender_email` attribute of an existing Mail object.\n- **reply_to** (string) - Reply-To email address, will override `reply_to` attribute of an existing Mail object.\n- **cc** (list) -  A list of recipient addresses., will extend `cc` attribute of an existing Mail object.\n- **bcc** (list) - A list of recipient address, will extend `bcc` attribute of an existing Mail object.\n- **headers** (dict) - A dictionary of extra headers to put on the message. The keys are the header name, values are the \n    header values. It\u2019s up to the caller to ensure header names and values are in the correct format for an email message.\n- **attachment** (list) - A list of attachments to put on the message. These can be either `email.MIMEBase.MIMEBase` instances, or \n    `(filename, content, mimetype)` triples.\n\n```\nfrom mailto import mailto\n\nmailto(['test@localhost'], 'test')\n```\n\nIn case, Mail object with given slug does not exist, it will be created with `active=False`, without sending. In order to provide an initial set of Mail objects specify `MAILTO_MAILS` setting in your settings file, which will be created on `syncdb`.\n \n### In your templates \n\nLoad `mailtotags` into your template and define placeholders where content should be editable. A minimal template with a simple footer would look like this (e.g. `mailto/simple_footer.html`):\n\n```\n{% extends 'mailto/base.html' %}\n{% load mailtotags %}\n\n{% block title %}{{ block.super }}{% endblock %}\n{% block extra_head %}{{ block.super }}{% endblock %}\n{% block extra_body_attrs %}{{ block.super }}{% endblock %}\n\n{% block body %}\n        {% placeholder 'main-content' %}\n        \n        <hr>\n        Thank you for treating this mail as confidential\n{% endblock %}\n\n{% block extra_body %}{{ block.super }}{% endblock %}\n``` \n\nA coresponding plain text template would look like this (e.g. `mailto/simple_footer.txt`):\n\n```\n{{ body }}\n\n---\nThank you for treating this mail as confidential.\n```\n\n### Template rendering\n\nTemplate rendering  will be done with current `context_processor` setting in mind. This means, there is the same context available as in regular views.\nIn case the recipients email address matches an existing user, than recipients User object will be added to `recipient` context variable. E.g. `{{ recipient.username }}` will return the User objects username.\n\n### Opt-out URL\n\nTo get the Opt-out URL for the current user, use `{{ recipient.optin.get_optout_url }}`.\n\n## Settings\n\n### MAILTO_TEMPLATES\n\ndjango-mailto is shipped with a default set of email templates [thanks to *Antwort*](https://github.com/internations/antwort) but it\nis easy to setup your own.\n\nDefault:\n\n```\n(\n    ('mailto/default.html', _('Default')),\n    ('mailto/default_2col.html', _('Default 2 column')),\n    ('mailto/default_3col.html', _('Default 3 column')),\n)\n```\n\nAdditionally when a `mailto/default.txt` is available besides the `mailto/default.html` it will be taken as template for plain body of your email.\n\n### MAILTO_MAILS\n\nDefault: `None`\n\nProvide an initial set of Mail objects by settings a list or tuple of mail slugs. They will be crated on each syncdb if not already existing.\n\n```\n(\n    'mail-registration',\n    'mail-password-reset',\n)\n```\n\n### MAILTO_DEFAULT_SENDER_EMAIL\n\nDefault: `settings.DEFAULT_FROM_EMAIL`\n\nSets the default sender email for new Mail objects.\n\n### MAILTO_OPTOUT_REDIRECT_URL\n\nDefault: `\"/\"`\n\nAfter a successful Opt-out the user will be redirected to an URL of your choice.",
        "description_content_type": null,
        "docs_url": null,
        "download_url": "UNKNOWN",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/hckjck/django-mailto",
        "keywords": null,
        "license": "BSD",
        "maintainer": null,
        "maintainer_email": null,
        "name": "django-mailto",
        "package_url": "https://pypi.org/project/django-mailto/",
        "platform": "UNKNOWN",
        "project_url": "https://pypi.org/project/django-mailto/",
        "project_urls": {
            "Download": "UNKNOWN",
            "Homepage": "https://github.com/hckjck/django-mailto"
        },
        "release_url": "https://pypi.org/project/django-mailto/0.1.0/",
        "requires_dist": null,
        "requires_python": null,
        "summary": "Django app to send, manage and queue multilingual mails with template support.",
        "version": "0.1.0"
    },
    "last_serial": 1609254,
    "releases": {
        "0.1.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "7da3a0396e6c8438121868b729c3ad51",
                    "sha256": "efc9605aeb401dbb824a822b1e79e787950b6bc9a57ca13033213cfaa7766383"
                },
                "downloads": -1,
                "filename": "django-mailto-0.1.0.tar.gz",
                "has_sig": false,
                "md5_digest": "7da3a0396e6c8438121868b729c3ad51",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 17375,
                "upload_time": "2015-06-27T15:26:00",
                "url": "https://files.pythonhosted.org/packages/2c/9d/bccb0c9fceb4deb337ba78794a2ccb9d2259329c7e6da9a3db6929aa39c8/django-mailto-0.1.0.tar.gz"
            }
        ],
        "0.1.0b": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "9f76a605e1b2c485eabee45603223002",
                    "sha256": "24f6564f74f9762533145a7f881523ebae698e789341c0a5afcff22f52dc123b"
                },
                "downloads": -1,
                "filename": "django-mailto-0.1.0b.tar.gz",
                "has_sig": false,
                "md5_digest": "9f76a605e1b2c485eabee45603223002",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 825150,
                "upload_time": "2014-09-12T15:29:26",
                "url": "https://files.pythonhosted.org/packages/1e/ce/44b1e12ab4a2e49040da0b1b7cc756040db6d2a5c643566721963a4c0527/django-mailto-0.1.0b.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "7da3a0396e6c8438121868b729c3ad51",
                "sha256": "efc9605aeb401dbb824a822b1e79e787950b6bc9a57ca13033213cfaa7766383"
            },
            "downloads": -1,
            "filename": "django-mailto-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "7da3a0396e6c8438121868b729c3ad51",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 17375,
            "upload_time": "2015-06-27T15:26:00",
            "url": "https://files.pythonhosted.org/packages/2c/9d/bccb0c9fceb4deb337ba78794a2ccb9d2259329c7e6da9a3db6929aa39c8/django-mailto-0.1.0.tar.gz"
        }
    ]
}