| Name | django-anymail JSON |
| Version |
12.0
JSON |
| download |
| home_page | None |
| Summary | Django email backends and webhooks for Amazon SES, Brevo, MailerSend, Mailgun, Mailjet, Mandrill, Postal, Postmark, Resend, SendGrid, SparkPost and Unisender Go (EmailBackend, transactional email tracking and inbound email signals) |
| upload_time | 2024-09-09 19:30:00 |
| maintainer | None |
| docs_url | None |
| author | Anymail Contributors |
| requires_python | >=3.8 |
| license | BSD 3-Clause License Copyright (c) 2016-2024, Anymail Contributors Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
aws ses
activecampaign
amazon ses
bird
brevo
django
esp
emailbackend
mailchimp
mailersend
mailgun
mailjet
mandrill
postal
postmark
resend
sendgrid
sendinblue
simple email service
sinch
sparkpost
twilio
unisender go
email
email backend
email service provider
email tracking
inbound email
transactional mail
webhook
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
Anymail: Django email integration for transactional ESPs
========================================================
.. 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 pyproject.toml readme; see also
hatch_build.py which edits in the release version number)
You can use docutils 1.0 markup, but *not* any Sphinx additions.
GitHub rst supports code-block, but *no other* block directives.
.. default-role:: literal
.. _shared-intro:
.. This shared-intro section is also included in docs/index.rst
Anymail lets you send and receive email in Django using your choice
of transactional email service providers (ESPs). It extends the
standard `django.core.mail` with many common ESP-added features, providing
a consistent API that avoids locking your code to one specific ESP
(and making it easier to change ESPs later if needed).
Anymail currently supports these ESPs:
* **Amazon SES**
* **Brevo** (formerly SendinBlue)
* **MailerSend**
* **Mailgun** (Sinch transactional email)
* **Mailjet** (Sinch transactional email)
* **Mandrill** (MailChimp transactional email)
* **Postal** (self-hosted ESP)
* **Postmark** (ActiveCampaign transactional email)
* **Resend**
* **SendGrid** (Twilio transactional email)
* **SparkPost** (Bird transactional email)
* **Unisender Go**
Anymail includes:
* Integration of each ESP's sending APIs into
`Django's built-in email <https://docs.djangoproject.com/en/v12.0/topics/email/>`_
package, including support for HTML, attachments, extra headers,
and other standard email features
* Extensions to expose common ESP-added functionality, like tags, metadata,
and tracking, with code that's portable between ESPs
* Simplified inline images for HTML email
* Normalized sent-message status and tracking notification, by connecting
your ESP's webhooks to Django signals
* "Batch transactional" sends using your ESP's merge and template features
* Inbound message support, to receive email through your ESP's webhooks,
with simplified, portable access to attachments and other inbound content
Anymail maintains compatibility with all Django versions that are in mainstream
or extended support, plus (usually) a few older Django versions, and is extensively
tested on all Python versions supported by Django. (Even-older Django versions
may still be covered by an Anymail extended support release; consult the
`changelog <https://anymail.dev/en/v12.0/changelog/>`_ for details.)
Anymail releases follow `semantic versioning <https://semver.org/>`_.
The package is released under the BSD license.
.. END shared-intro
.. image:: https://github.com/anymail/django-anymail/workflows/test/badge.svg?tag=v12.0
:target: https://github.com/anymail/django-anymail/actions?query=workflow:test+branch:v12.0
:alt: test status in GitHub Actions
.. image:: https://github.com/anymail/django-anymail/workflows/integration-test/badge.svg?tag=v12.0
:target: https://github.com/anymail/django-anymail/actions?query=workflow:integration-test+branch:v12.0
:alt: integration test status in GitHub Actions
.. image:: https://readthedocs.org/projects/anymail/badge/?version=v12.0
:target: https://anymail.dev/en/v12.0/
:alt: documentation build status on ReadTheDocs
**Resources**
* Full documentation: https://anymail.dev/en/v12.0/
* Help and troubleshooting: https://anymail.dev/en/v12.0/help/
* Package on PyPI: https://pypi.org/project/django-anymail/
* Project on Github: https://github.com/anymail/django-anymail
* Changelog: https://anymail.dev/en/v12.0/changelog/
Anymail 1-2-3
-------------
.. _quickstart:
.. This quickstart section is also included in docs/quickstart.rst
Here's how to send a message.
This example uses Mailgun, but you can substitute Mailjet or Postmark or SendGrid
or SparkPost or any other supported ESP where you see "mailgun":
1. Install Anymail from PyPI:
.. code-block:: console
$ pip install "django-anymail[mailgun]"
(The `[mailgun]` part installs any additional packages needed for that ESP.
Mailgun doesn't have any, but some other ESPs do.)
2. Edit your project's ``settings.py``:
.. code-block:: python
INSTALLED_APPS = [
# ...
"anymail",
# ...
]
ANYMAIL = {
# (exact settings here depend on your ESP...)
"MAILGUN_API_KEY": "<your Mailgun key>",
"MAILGUN_SENDER_DOMAIN": 'mg.example.com', # your Mailgun domain, if needed
}
EMAIL_BACKEND = "anymail.backends.mailgun.EmailBackend" # or sendgrid.EmailBackend, or...
DEFAULT_FROM_EMAIL = "you@example.com" # if you don't already have this in settings
SERVER_EMAIL = "your-server@example.com" # ditto (default from-email for Django errors)
3. Now the regular `Django email functions <https://docs.djangoproject.com/en/v12.0/topics/email/>`_
will send through your chosen ESP:
.. code-block:: python
from django.core.mail import send_mail
send_mail("It works!", "This will get sent through Mailgun",
"Anymail Sender <from@example.com>", ["to@example.com"])
You could send an HTML message, complete with an inline image,
custom tags and metadata:
.. code-block:: python
from django.core.mail import EmailMultiAlternatives
from anymail.message import attach_inline_image_file
msg = EmailMultiAlternatives(
subject="Please activate your account",
body="Click to activate your account: https://example.com/activate",
from_email="Example <admin@example.com>",
to=["New User <user1@example.com>", "account.manager@example.com"],
reply_to=["Helpdesk <support@example.com>"])
# Include an inline image in the html:
logo_cid = attach_inline_image_file(msg, "/path/to/logo.jpg")
html = """<img alt="Logo" src="cid:{logo_cid}">
<p>Please <a href="https://example.com/activate">activate</a>
your account</p>""".format(logo_cid=logo_cid)
msg.attach_alternative(html, "text/html")
# Optional Anymail extensions:
msg.metadata = {"user_id": "8675309", "experiment_variation": 1}
msg.tags = ["activation", "onboarding"]
msg.track_clicks = True
# Send it:
msg.send()
.. END quickstart
See the `full documentation <https://anymail.dev/en/v12.0/>`_
for more features and options, including receiving messages and tracking
sent message status.
Raw data
{
"_id": null,
"home_page": null,
"name": "django-anymail",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "AWS SES, ActiveCampaign, Amazon SES, Bird, Brevo, Django, ESP, EmailBackend, MailChimp, MailerSend, Mailgun, Mailjet, Mandrill, Postal, Postmark, Resend, SendGrid, SendinBlue, Simple Email Service, Sinch, SparkPost, Twilio, Unisender Go, email, email backend, email service provider, email tracking, inbound email, transactional mail, webhook",
"author": "Anymail Contributors",
"author_email": "Mike Edmunds <medmunds@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/91/cd/34eca54757511df252ae8b56f5b75f3d137cc51ba53c7c5c74b8d449fa0d/django_anymail-12.0.tar.gz",
"platform": null,
"description": "Anymail: Django email integration for transactional ESPs\n========================================================\n\n.. This README is reused in multiple places:\n * Github: project page, exactly as it appears here\n * Docs: shared-intro section gets included in docs/index.rst\n quickstart section gets included in docs/quickstart.rst\n * PyPI: project page (via pyproject.toml readme; see also\n hatch_build.py which edits in the release version number)\n You can use docutils 1.0 markup, but *not* any Sphinx additions.\n GitHub rst supports code-block, but *no other* block directives.\n\n\n.. default-role:: literal\n\n\n.. _shared-intro:\n\n.. This shared-intro section is also included in docs/index.rst\n\nAnymail lets you send and receive email in Django using your choice\nof transactional email service providers (ESPs). It extends the\nstandard `django.core.mail` with many common ESP-added features, providing\na consistent API that avoids locking your code to one specific ESP\n(and making it easier to change ESPs later if needed).\n\nAnymail currently supports these ESPs:\n\n* **Amazon SES**\n* **Brevo** (formerly SendinBlue)\n* **MailerSend**\n* **Mailgun** (Sinch transactional email)\n* **Mailjet** (Sinch transactional email)\n* **Mandrill** (MailChimp transactional email)\n* **Postal** (self-hosted ESP)\n* **Postmark** (ActiveCampaign transactional email)\n* **Resend**\n* **SendGrid** (Twilio transactional email)\n* **SparkPost** (Bird transactional email)\n* **Unisender Go**\n\nAnymail includes:\n\n* Integration of each ESP's sending APIs into\n `Django's built-in email <https://docs.djangoproject.com/en/v12.0/topics/email/>`_\n package, including support for HTML, attachments, extra headers,\n and other standard email features\n* Extensions to expose common ESP-added functionality, like tags, metadata,\n and tracking, with code that's portable between ESPs\n* Simplified inline images for HTML email\n* Normalized sent-message status and tracking notification, by connecting\n your ESP's webhooks to Django signals\n* \"Batch transactional\" sends using your ESP's merge and template features\n* Inbound message support, to receive email through your ESP's webhooks,\n with simplified, portable access to attachments and other inbound content\n\nAnymail maintains compatibility with all Django versions that are in mainstream\nor extended support, plus (usually) a few older Django versions, and is extensively\ntested on all Python versions supported by Django. (Even-older Django versions\nmay still be covered by an Anymail extended support release; consult the\n`changelog <https://anymail.dev/en/v12.0/changelog/>`_ for details.)\n\nAnymail releases follow `semantic versioning <https://semver.org/>`_.\nThe package is released under the BSD license.\n\n.. END shared-intro\n\n.. image:: https://github.com/anymail/django-anymail/workflows/test/badge.svg?tag=v12.0\n :target: https://github.com/anymail/django-anymail/actions?query=workflow:test+branch:v12.0\n :alt: test status in GitHub Actions\n\n.. image:: https://github.com/anymail/django-anymail/workflows/integration-test/badge.svg?tag=v12.0\n :target: https://github.com/anymail/django-anymail/actions?query=workflow:integration-test+branch:v12.0\n :alt: integration test status in GitHub Actions\n\n.. image:: https://readthedocs.org/projects/anymail/badge/?version=v12.0\n :target: https://anymail.dev/en/v12.0/\n :alt: documentation build status on ReadTheDocs\n\n**Resources**\n\n* Full documentation: https://anymail.dev/en/v12.0/\n* Help and troubleshooting: https://anymail.dev/en/v12.0/help/\n* Package on PyPI: https://pypi.org/project/django-anymail/\n* Project on Github: https://github.com/anymail/django-anymail\n* Changelog: https://anymail.dev/en/v12.0/changelog/\n\n\nAnymail 1-2-3\n-------------\n\n.. _quickstart:\n\n.. This quickstart section is also included in docs/quickstart.rst\n\nHere's how to send a message.\nThis example uses Mailgun, but you can substitute Mailjet or Postmark or SendGrid\nor SparkPost or any other supported ESP where you see \"mailgun\":\n\n1. Install Anymail from PyPI:\n\n .. code-block:: console\n\n $ pip install \"django-anymail[mailgun]\"\n\n (The `[mailgun]` part installs any additional packages needed for that ESP.\n Mailgun doesn't have any, but some other ESPs do.)\n\n\n2. Edit your project's ``settings.py``:\n\n .. code-block:: python\n\n INSTALLED_APPS = [\n # ...\n \"anymail\",\n # ...\n ]\n\n ANYMAIL = {\n # (exact settings here depend on your ESP...)\n \"MAILGUN_API_KEY\": \"<your Mailgun key>\",\n \"MAILGUN_SENDER_DOMAIN\": 'mg.example.com', # your Mailgun domain, if needed\n }\n EMAIL_BACKEND = \"anymail.backends.mailgun.EmailBackend\" # or sendgrid.EmailBackend, or...\n DEFAULT_FROM_EMAIL = \"you@example.com\" # if you don't already have this in settings\n SERVER_EMAIL = \"your-server@example.com\" # ditto (default from-email for Django errors)\n\n\n3. Now the regular `Django email functions <https://docs.djangoproject.com/en/v12.0/topics/email/>`_\n will send through your chosen ESP:\n\n .. code-block:: python\n\n from django.core.mail import send_mail\n\n send_mail(\"It works!\", \"This will get sent through Mailgun\",\n \"Anymail Sender <from@example.com>\", [\"to@example.com\"])\n\n\n You could send an HTML message, complete with an inline image,\n custom tags and metadata:\n\n .. code-block:: python\n\n from django.core.mail import EmailMultiAlternatives\n from anymail.message import attach_inline_image_file\n\n msg = EmailMultiAlternatives(\n subject=\"Please activate your account\",\n body=\"Click to activate your account: https://example.com/activate\",\n from_email=\"Example <admin@example.com>\",\n to=[\"New User <user1@example.com>\", \"account.manager@example.com\"],\n reply_to=[\"Helpdesk <support@example.com>\"])\n\n # Include an inline image in the html:\n logo_cid = attach_inline_image_file(msg, \"/path/to/logo.jpg\")\n html = \"\"\"<img alt=\"Logo\" src=\"cid:{logo_cid}\">\n <p>Please <a href=\"https://example.com/activate\">activate</a>\n your account</p>\"\"\".format(logo_cid=logo_cid)\n msg.attach_alternative(html, \"text/html\")\n\n # Optional Anymail extensions:\n msg.metadata = {\"user_id\": \"8675309\", \"experiment_variation\": 1}\n msg.tags = [\"activation\", \"onboarding\"]\n msg.track_clicks = True\n\n # Send it:\n msg.send()\n\n.. END quickstart\n\n\nSee the `full documentation <https://anymail.dev/en/v12.0/>`_\nfor more features and options, including receiving messages and tracking\nsent message status.\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License Copyright (c) 2016-2024, Anymail Contributors Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.",
"summary": "Django email backends and webhooks for Amazon SES, Brevo, MailerSend, Mailgun, Mailjet, Mandrill, Postal, Postmark, Resend, SendGrid, SparkPost and Unisender Go (EmailBackend, transactional email tracking and inbound email signals)",
"version": "12.0",
"project_urls": {
"Changelog": "https://anymail.dev/en/stable/changelog/",
"Documentation": "https://anymail.dev/en/stable/",
"Homepage": "https://github.com/anymail/django-anymail",
"Source": "https://github.com/anymail/django-anymail",
"Tracker": "https://github.com/anymail/django-anymail/issues"
},
"split_keywords": [
"aws ses",
" activecampaign",
" amazon ses",
" bird",
" brevo",
" django",
" esp",
" emailbackend",
" mailchimp",
" mailersend",
" mailgun",
" mailjet",
" mandrill",
" postal",
" postmark",
" resend",
" sendgrid",
" sendinblue",
" simple email service",
" sinch",
" sparkpost",
" twilio",
" unisender go",
" email",
" email backend",
" email service provider",
" email tracking",
" inbound email",
" transactional mail",
" webhook"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3d0983c613d8781d56af7b8736c7c968f8dc0487763b2680ae9d726a7313c9de",
"md5": "8dff0db262563d9b3e8f024817ec4bf1",
"sha256": "de8458d713d0f9776da9ed04dcd3a0161be23e9ecbcb49dcf149219700ecd274"
},
"downloads": -1,
"filename": "django_anymail-12.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8dff0db262563d9b3e8f024817ec4bf1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 131312,
"upload_time": "2024-09-09T19:29:58",
"upload_time_iso_8601": "2024-09-09T19:29:58.528135Z",
"url": "https://files.pythonhosted.org/packages/3d/09/83c613d8781d56af7b8736c7c968f8dc0487763b2680ae9d726a7313c9de/django_anymail-12.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "91cd34eca54757511df252ae8b56f5b75f3d137cc51ba53c7c5c74b8d449fa0d",
"md5": "d325db9ffee9acb146cac39d27b27477",
"sha256": "65789c1b0f42915aa0450a4f173f77572d4c552979b748ddd8125af41972ad30"
},
"downloads": -1,
"filename": "django_anymail-12.0.tar.gz",
"has_sig": false,
"md5_digest": "d325db9ffee9acb146cac39d27b27477",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 95175,
"upload_time": "2024-09-09T19:30:00",
"upload_time_iso_8601": "2024-09-09T19:30:00.181234Z",
"url": "https://files.pythonhosted.org/packages/91/cd/34eca54757511df252ae8b56f5b75f3d137cc51ba53c7c5c74b8d449fa0d/django_anymail-12.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-09 19:30:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "anymail",
"github_project": "django-anymail",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "django-anymail"
}
