Djrill: Mandrill Transactional Email for Django
===============================================
.. This README is reused in multiple places:
* Github: project page, exactly as it appears here
* Docs: shared-intro section gets included in docs/index.rst
quickstart section gets included in docs/quickstart.rst
* PyPI: project page (via setup.py long_description),
with several edits to freeze it to the specific PyPI release
(see long_description_from_readme in setup.py)
You can use docutils 1.0 markup, but *not* any Sphinx additions.
.. default-role:: literal
.. _shared-intro:
.. This shared-intro section is also included in docs/index.rst
Djrill integrates the `Mandrill <http://mandrill.com>`_ transactional
email service into Django.
**PROJECT STATUS: INACTIVE**
As of April, 2016, Djrill is no longer actively maintained (other
than security updates). It is likely to keep working unless/until
Mandrill changes their APIs, but Djrill will not be updated for
newer Django versions or Mandrill changes.
(`more info <https://github.com/brack3t/Djrill/issues/111>`_)
You may be interested in
`django-anymail <https://github.com/anymail/django-anymail>`_,
a Djrill fork that supports Mailgun, Postmark, SendGrid, and other
transactional ESPs (including limited support for Mandrill).
In general, Djrill "just works" with Django's built-in `django.core.mail`
package. It includes:
* Support for HTML, attachments, extra headers, and other features of
`Django's built-in email <https://docs.djangoproject.com/en/stable/topics/email/>`_
* Mandrill-specific extensions like tags, metadata, tracking, and MailChimp templates
* Optional support for Mandrill inbound email and other webhook notifications,
via Django signals
Djrill is released under the BSD license. It is tested against Django 1.4--1.9
(including Python 3 with Django 1.6+, and PyPy support with Django 1.5+).
Djrill uses `semantic versioning <http://semver.org/>`_.
.. END shared-intro
.. image:: https://travis-ci.org/brack3t/Djrill.png?branch=v2.1
:target: https://travis-ci.org/brack3t/Djrill
:alt: build status on Travis-CI
**Resources**
* Full documentation: https://djrill.readthedocs.org/en/v2.1/
* Package on PyPI: https://pypi.python.org/pypi/djrill
* Project on Github: https://github.com/brack3t/Djrill
Djrill 1-2-3
------------
.. _quickstart:
.. This quickstart section is also included in docs/quickstart.rst
1. Install Djrill from PyPI:
.. code-block:: console
$ pip install djrill
2. Edit your project's ``settings.py``:
.. code-block:: python
INSTALLED_APPS = (
...
"djrill"
)
MANDRILL_API_KEY = "<your Mandrill key>"
EMAIL_BACKEND = "djrill.mail.backends.djrill.DjrillBackend"
DEFAULT_FROM_EMAIL = "you@example.com" # if you don't already have this in settings
3. Now the regular `Django email functions <https://docs.djangoproject.com/en/stable/topics/email/>`_
will send through Mandrill:
.. code-block:: python
from django.core.mail import send_mail
send_mail("It works!", "This will get sent through Mandrill",
"Djrill Sender <djrill@example.com>", ["to@example.com"])
You could send an HTML message, complete with custom Mandrill tags and metadata:
.. code-block:: python
from django.core.mail import EmailMultiAlternatives
msg = EmailMultiAlternatives(
subject="Djrill Message",
body="This is the text email body",
from_email="Djrill Sender <djrill@example.com>",
to=["Recipient One <someone@example.com>", "another.person@example.com"],
headers={'Reply-To': "Service <support@example.com>"} # optional extra headers
)
msg.attach_alternative("<p>This is the HTML email body</p>", "text/html")
# Optional Mandrill-specific extensions:
msg.tags = ["one tag", "two tag", "red tag", "blue tag"]
msg.metadata = {'user_id': "8675309"}
# Send it:
msg.send()
.. END quickstart
See the `full documentation <https://djrill.readthedocs.org/en/v2.1/>`_
for more features and options.
Raw data
{
"_id": null,
"home_page": "https://github.com/brack3t/Djrill/",
"name": "djrill",
"maintainer": "",
"docs_url": null,
"requires_python": null,
"maintainer_email": "",
"keywords": "django,mailchimp,mandrill,email,email backend",
"author": "Kenneth Love <kenneth@brack3t.com>, Chris Jones <chris@brack3t.com>",
"author_email": "kenneth@brack3t.com",
"download_url": "https://files.pythonhosted.org/packages/9f/33/b385e7823be0dfa375444cae71be9dd1450fea31f7dbf19f734e572ff849/djrill-2.1.0.tar.gz",
"platform": "UNKNOWN",
"description": "Djrill: Mandrill Transactional Email for Django\r\n===============================================\r\n\r\n.. This README is reused in multiple places:\r\n * Github: project page, exactly as it appears here\r\n * Docs: shared-intro section gets included in docs/index.rst\r\n quickstart section gets included in docs/quickstart.rst\r\n * PyPI: project page (via setup.py long_description),\r\n with several edits to freeze it to the specific PyPI release\r\n (see long_description_from_readme in setup.py)\r\n You can use docutils 1.0 markup, but *not* any Sphinx additions.\r\n\r\n.. default-role:: literal\r\n\r\n\r\n.. _shared-intro:\r\n\r\n.. This shared-intro section is also included in docs/index.rst\r\n\r\nDjrill integrates the `Mandrill <http://mandrill.com>`_ transactional\r\nemail service into Django.\r\n\r\n **PROJECT STATUS: INACTIVE**\r\n\r\n As of April, 2016, Djrill is no longer actively maintained (other\r\n than security updates). It is likely to keep working unless/until\r\n Mandrill changes their APIs, but Djrill will not be updated for\r\n newer Django versions or Mandrill changes.\r\n (`more info <https://github.com/brack3t/Djrill/issues/111>`_)\r\n\r\n You may be interested in\r\n `django-anymail <https://github.com/anymail/django-anymail>`_,\r\n a Djrill fork that supports Mailgun, Postmark, SendGrid, and other\r\n transactional ESPs (including limited support for Mandrill).\r\n\r\n\r\nIn general, Djrill \"just works\" with Django's built-in `django.core.mail`\r\npackage. It includes:\r\n\r\n* Support for HTML, attachments, extra headers, and other features of\r\n `Django's built-in email <https://docs.djangoproject.com/en/stable/topics/email/>`_\r\n* Mandrill-specific extensions like tags, metadata, tracking, and MailChimp templates\r\n* Optional support for Mandrill inbound email and other webhook notifications,\r\n via Django signals\r\n\r\nDjrill is released under the BSD license. It is tested against Django 1.4--1.9\r\n(including Python 3 with Django 1.6+, and PyPy support with Django 1.5+).\r\nDjrill uses `semantic versioning <http://semver.org/>`_.\r\n\r\n.. END shared-intro\r\n\r\n.. image:: https://travis-ci.org/brack3t/Djrill.png?branch=v2.1\r\n :target: https://travis-ci.org/brack3t/Djrill\r\n :alt: build status on Travis-CI\r\n\r\n\r\n**Resources**\r\n\r\n* Full documentation: https://djrill.readthedocs.org/en/v2.1/\r\n* Package on PyPI: https://pypi.python.org/pypi/djrill\r\n* Project on Github: https://github.com/brack3t/Djrill\r\n\r\n\r\nDjrill 1-2-3\r\n------------\r\n\r\n.. _quickstart:\r\n\r\n.. This quickstart section is also included in docs/quickstart.rst\r\n\r\n1. Install Djrill from PyPI:\r\n\r\n .. code-block:: console\r\n\r\n $ pip install djrill\r\n\r\n\r\n2. Edit your project's ``settings.py``:\r\n\r\n .. code-block:: python\r\n\r\n INSTALLED_APPS = (\r\n ...\r\n \"djrill\"\r\n )\r\n\r\n MANDRILL_API_KEY = \"<your Mandrill key>\"\r\n EMAIL_BACKEND = \"djrill.mail.backends.djrill.DjrillBackend\"\r\n DEFAULT_FROM_EMAIL = \"you@example.com\" # if you don't already have this in settings\r\n\r\n\r\n3. Now the regular `Django email functions <https://docs.djangoproject.com/en/stable/topics/email/>`_\r\n will send through Mandrill:\r\n\r\n .. code-block:: python\r\n\r\n from django.core.mail import send_mail\r\n\r\n send_mail(\"It works!\", \"This will get sent through Mandrill\",\r\n \"Djrill Sender <djrill@example.com>\", [\"to@example.com\"])\r\n\r\n\r\n You could send an HTML message, complete with custom Mandrill tags and metadata:\r\n\r\n .. code-block:: python\r\n\r\n from django.core.mail import EmailMultiAlternatives\r\n\r\n msg = EmailMultiAlternatives(\r\n subject=\"Djrill Message\",\r\n body=\"This is the text email body\",\r\n from_email=\"Djrill Sender <djrill@example.com>\",\r\n to=[\"Recipient One <someone@example.com>\", \"another.person@example.com\"],\r\n headers={'Reply-To': \"Service <support@example.com>\"} # optional extra headers\r\n )\r\n msg.attach_alternative(\"<p>This is the HTML email body</p>\", \"text/html\")\r\n\r\n # Optional Mandrill-specific extensions:\r\n msg.tags = [\"one tag\", \"two tag\", \"red tag\", \"blue tag\"]\r\n msg.metadata = {'user_id': \"8675309\"}\r\n\r\n # Send it:\r\n msg.send()\r\n\r\n.. END quickstart\r\n\r\n\r\nSee the `full documentation <https://djrill.readthedocs.org/en/v2.1/>`_\r\nfor more features and options.",
"bugtrack_url": null,
"license": "BSD License",
"summary": "Mandrill transactional email for Django",
"version": "2.1.0",
"split_keywords": [
"django",
"mailchimp",
"mandrill",
"email",
"email backend"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9f33b385e7823be0dfa375444cae71be9dd1450fea31f7dbf19f734e572ff849",
"md5": "3b5c0bbdc8b70c83935ed02943c11011",
"sha256": "1047a11f3982816aa3aa02eab778e199d5d9561815fe01460f45f70a503c65f4"
},
"downloads": -1,
"filename": "djrill-2.1.0.tar.gz",
"has_sig": false,
"md5_digest": "3b5c0bbdc8b70c83935ed02943c11011",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 13063,
"upload_time": "2016-04-15T00:24:23",
"upload_time_iso_8601": "2016-04-15T00:24:23.540820Z",
"url": "https://files.pythonhosted.org/packages/9f/33/b385e7823be0dfa375444cae71be9dd1450fea31f7dbf19f734e572ff849/djrill-2.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2016-04-15 00:24:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "brack3t",
"github_project": "Djrill",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"lcname": "djrill"
}
JSON
