File: PKG-INFO

package info (click to toggle)
django-anymail 7.1.0-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, sid
  • size: 496 kB
  • sloc: python: 4,446; makefile: 4
file content (195 lines) | stat: -rw-r--r-- 8,972 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
Metadata-Version: 2.1
Name: django-anymail
Version: 7.1.0
Summary: Django email integration for Amazon SES, Mailgun, Mailjet, Postmark, SendGrid, SendinBlue, SparkPost and other transactional ESPs
Home-page: https://github.com/anymail/django-anymail
Author: Mike Edmunds and Anymail contributors
Author-email: medmunds@gmail.com
License: BSD License
Project-URL: Documentation, https://anymail.readthedocs.io/en/v7.1.0/
Project-URL: Source, https://github.com/anymail/django-anymail
Project-URL: Changelog, https://anymail.readthedocs.io/en/v7.1.0/changelog/
Project-URL: Tracker, https://github.com/anymail/django-anymail/issues
Description: 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 = {
                    # (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/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 <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: http://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="http://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.readthedocs.io/en/v7.1.0/>`_
        for more features and options, including receiving messages and tracking
        sent message status.
        
Keywords: Django,email,email backend,ESP,transactional mail,Amazon SES,Mailgun,Mailjet,Mandrill,Postmark,SendinBlue,SendGrid,SparkPost
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: License :: OSI Approved :: BSD License
Classifier: Topic :: Communications :: Email
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Intended Audience :: Developers
Classifier: Framework :: Django
Classifier: Framework :: Django :: 1.11
Classifier: Framework :: Django :: 2.0
Classifier: Framework :: Django :: 2.1
Classifier: Environment :: Web Environment
Provides-Extra: mandrill
Provides-Extra: mailgun
Provides-Extra: mailjet
Provides-Extra: sparkpost
Provides-Extra: sendinblue
Provides-Extra: sendgrid
Provides-Extra: amazon_ses
Provides-Extra: postmark