Skip to content

Commit d1600bf

Browse files
committed
Docs: remove references to future inbound handling
(Postponed -- see discussion or vote to reopen in #4) [ci skip] (cherry picked from commit e78410e)
1 parent 26ea8e1 commit d1600bf

File tree

7 files changed

+4
-51
lines changed

7 files changed

+4
-51
lines changed

README.rst

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,10 +45,6 @@ built-in `django.core.mail` package. It includes:
4545
your ESP's webhooks to Django signals
4646
* "Batch transactional" sends using your ESP's merge and template features
4747

48-
Support is also planned for:
49-
50-
* Normalized inbound email processing through your ESP
51-
5248
Anymail is released under the BSD license. It is extensively tested against Django 1.8--1.10
5349
(including Python 2.7, Python 3 and PyPy).
5450
Anymail releases follow `semantic versioning <http://semver.org/>`_.

docs/esps/index.rst

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -50,10 +50,6 @@ Email Service Provider |Mailgun| |Mandrill| |Postmark|
5050
============================================ ========== ========== ========== ========== ===========
5151

5252

53-
.. .. rubric:: :ref:`inbound`
54-
.. -------------------------------------------------------------------------------------------
55-
.. Inbound webhooks (coming)...
56-
5753
Trying to choose an ESP? Please **don't** start with this table. It's far more
5854
important to consider things like an ESP's deliverability stats, latency, uptime,
5955
and support for developers. The *number* of extra features an ESP offers is almost

docs/esps/mandrill.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -374,8 +374,9 @@ parameters is that most logging and analytics systems are aware of the
374374
need to keep auth secret.)
375375

376376
Anymail replaces `djrill.signals.webhook_event` with
377-
`anymail.signals.tracking` and (in a future release)
378-
`anymail.signals.inbound`. Anymail parses and normalizes
377+
`anymail.signals.tracking` for delivery tracking events.
378+
(It does not currently handle inbound message webhooks.)
379+
Anymail parses and normalizes
379380
the event data passed to the signal receiver: see :ref:`event-tracking`.
380381

381382
The equivalent of Djrill's ``data`` parameter is available

docs/inbound.rst

Lines changed: 0 additions & 12 deletions
This file was deleted.

docs/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,6 @@ Documentation
3434
quickstart
3535
installation
3636
sending/index
37-
inbound
3837
esps/index
3938
tips/index
4039
troubleshooting

docs/installation.rst

Lines changed: 1 addition & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ this is a good time to add one. (Django's default is "webmaster\@localhost",
6565
which some ESPs will reject.)
6666

6767
With the settings above, you are ready to send outgoing email through your ESP.
68-
If you also want to enable status tracking or inbound email, continue with the
68+
If you also want to enable status tracking, continue with the
6969
optional settings below. Otherwise, skip ahead to :ref:`sending-email`.
7070

7171

@@ -170,32 +170,6 @@ See :ref:`event-tracking` for information on creating signal handlers and the
170170
status tracking events you can receive.
171171

172172

173-
.. _inbound-configuration:
174-
175-
Configuring inbound email (optional)
176-
------------------------------------
177-
178-
(Coming soon -- not yet implemented)
179-
180-
.. Anymail can optionally connect to your ESP's inbound webhook to notify your app
181-
.. of incoming messages.
182-
..
183-
.. If you aren't using your EPS's inbound email, skip this section.
184-
..
185-
.. If you want to use inbound email with Anymail, follow the steps above
186-
.. for setting up :ref:`status tracking webhooks <webhooks-configuration>`,
187-
.. but enter the webhook URL in your ESP's "inbound email" settings,
188-
.. substituting "inbound" for "tracking" at the end of the url:
189-
..
190-
.. :samp:`https://{random}:{random}@{yoursite.example.com}/anymail/{esp}/inbound/`
191-
..
192-
.. Then see :ref:`inbound` for information on creating a signal handler
193-
.. for receiving inbound email notifications in your code.
194-
..
195-
.. (Note: if you are only using your ESP for inbound email, not sending messages,
196-
.. there's no need to change your project's EMAIL_BACKEND.)
197-
198-
199173
.. setting:: ANYMAIL
200174

201175
Anymail settings reference

docs/quickstart.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,5 @@ Problems? We have some :ref:`troubleshooting` info that may help.
1717
Now that you've got Anymail working, you might be interested in:
1818

1919
* :ref:`Sending email with Anymail <sending-email>`
20-
* :ref:`Receiving inbound email <inbound>`
2120
* :ref:`ESP-specific information <supported-esps>`
2221
* :ref:`All the docs <main-toc>`

0 commit comments

Comments
 (0)