| Name : python3-django-anymail
| |
| Version : 7.1.0
| Vendor : obs://build_opensuse_org/home:bmwiedemann
|
| Release : lp156.3.2
| Date : 2024-07-03 07:18:55
|
| Group : Development/Languages/Python
| Source RPM : python-django-anymail-7.1.0-lp156.3.2.src.rpm
|
| Size : 0.64 MB
| |
| Packager : https://www_suse_com/
| |
| Summary : Django email integration for various service providers
|
Description :
Django email integration for Amazon SES, Mailgun, Mailjet, Postmark, SendGrid, SendinBlue, SparkPost and other transactional ESPs
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 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.
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 integrates several transactional email service providers (ESPs) into Django,
with a consistent API that lets you use ESP-added features without locking your code
to a particular ESP.
It currently fully supports **Amazon SES, Mailgun, Mailjet, Postmark, SendinBlue, SendGrid,**
and **SparkPost,** and has limited support for **Mandrill.**
Anymail normalizes ESP functionality so it \"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/v7.1.0/topics/email/>`_
* Extensions that make it easy to use extra ESP 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 is released under the BSD license. It is extensively tested against
Django 1.11--3.0 on all Python versions supported by Django.
Anymail releases follow `semantic versioning < http://semver.org/>`_.
.. END shared-intro
.. image:: https://travis-ci.org/anymail/django-anymail.svg?branch=v7.1.0
:target: https://travis-ci.org/anymail/django-anymail
:alt: build status on Travis-CI
.. image:: https://readthedocs.org/projects/anymail/badge/?version=v7.1.0
:target: https://anymail.readthedocs.io/en/v7.1.0/
:alt: documentation on ReadTheDocs
**Resources**
* Full documentation: https://anymail.readthedocs.io/en/v7.1.0/
* Package on PyPI: https://pypi.org/project/django-anymail/
* Project on Github: https://github.com/anymail/django-anymail
* Changelog: https://anymail.readthedocs.io/en/v7.1.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 = {
\"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 = \"youAATTexample.com\" # if you don\'t already have this in settings
SERVER_EMAIL = \"your-serverAATTexample.com\" # ditto (default from-email for Django errors)
3. Now the regular `Django email functions < https://docs.djangoproject.com/en/v7.1.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 < fromAATTexample.com>\", [\"toAATTexample.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: http://example.com/activate\",
from_email=\"Example < adminAATTexample.com>\",
to=[\"New User < user1AATTexample.com>\", \"account.managerAATTexample.com\"],
reply_to=[\"Helpdesk < supportAATTexample.com>\"])
logo_cid = attach_inline_image_file(msg, \"/path/to/logo.jpg\")
html = \"\"\"< img alt=\"Logo\" src=\"cid:{logo_cid}\">
< p>Please < a href=\"http://example.com/activate\">activate< /a>
your account< /p>\"\"\".format(logo_cid=logo_cid)
msg.attach_alternative(html, \"text/html\")
msg.metadata = {\"user_id\": \"8675309\", \"experiment_variation\": 1}
msg.tags = [\"activation\", \"onboarding\"]
msg.track_clicks = True
msg.send()
.. END quickstart
See the `full documentation < https://anymail.readthedocs.io/en/v7.1.0/>`_
for more features and options, including receiving messages and tracking
sent message status.
|
RPM found in directory: /packages/linux-pbone/ftp5.gwdg.de/pub/opensuse/repositories/home:/bmwiedemann:/glitchtip/devel_languages_python_15.6/noarch |
