Docs: remove references to future inbound handling

(Postponed -- see discussion or vote to reopen in #4)

[ci skip]
This commit is contained in:
medmunds
2016-11-01 11:46:49 -07:00
parent 1cced97f65
commit e78410eea4
7 changed files with 4 additions and 51 deletions

View File

@@ -45,10 +45,6 @@ built-in `django.core.mail` package. It includes:
your ESP's webhooks to Django signals your ESP's webhooks to Django signals
* "Batch transactional" sends using your ESP's merge and template features * "Batch transactional" sends using your ESP's merge and template features
Support is also planned for:
* Normalized inbound email processing through your ESP
Anymail is released under the BSD license. It is extensively tested against Django 1.8--1.10 Anymail is released under the BSD license. It is extensively tested against Django 1.8--1.10
(including Python 2.7, Python 3 and PyPy). (including Python 2.7, Python 3 and PyPy).
Anymail releases follow `semantic versioning <http://semver.org/>`_. Anymail releases follow `semantic versioning <http://semver.org/>`_.

View File

@@ -50,10 +50,6 @@ Email Service Provider |Mailgun| |Mandrill| |Postmark|
============================================ ========== ========== ========== ========== =========== ============================================ ========== ========== ========== ========== ===========
.. .. rubric:: :ref:`inbound`
.. -------------------------------------------------------------------------------------------
.. Inbound webhooks (coming)...
Trying to choose an ESP? Please **don't** start with this table. It's far more Trying to choose an ESP? Please **don't** start with this table. It's far more
important to consider things like an ESP's deliverability stats, latency, uptime, important to consider things like an ESP's deliverability stats, latency, uptime,
and support for developers. The *number* of extra features an ESP offers is almost and support for developers. The *number* of extra features an ESP offers is almost

View File

@@ -374,8 +374,9 @@ parameters is that most logging and analytics systems are aware of the
need to keep auth secret.) need to keep auth secret.)
Anymail replaces `djrill.signals.webhook_event` with Anymail replaces `djrill.signals.webhook_event` with
`anymail.signals.tracking` and (in a future release) `anymail.signals.tracking` for delivery tracking events.
`anymail.signals.inbound`. Anymail parses and normalizes (It does not currently handle inbound message webhooks.)
Anymail parses and normalizes
the event data passed to the signal receiver: see :ref:`event-tracking`. the event data passed to the signal receiver: see :ref:`event-tracking`.
The equivalent of Djrill's ``data`` parameter is available The equivalent of Djrill's ``data`` parameter is available

View File

@@ -1,12 +0,0 @@
.. _inbound:
Receiving inbound email
=======================
.. note::
Normalized inbound email handling is coming soon to Anymail.
Inbound email signals
---------------------

View File

@@ -34,7 +34,6 @@ Documentation
quickstart quickstart
installation installation
sending/index sending/index
inbound
esps/index esps/index
tips/index tips/index
troubleshooting troubleshooting

View File

@@ -65,7 +65,7 @@ this is a good time to add one. (Django's default is "webmaster\@localhost",
which some ESPs will reject.) which some ESPs will reject.)
With the settings above, you are ready to send outgoing email through your ESP. With the settings above, you are ready to send outgoing email through your ESP.
If you also want to enable status tracking or inbound email, continue with the If you also want to enable status tracking, continue with the
optional settings below. Otherwise, skip ahead to :ref:`sending-email`. optional settings below. Otherwise, skip ahead to :ref:`sending-email`.
@@ -170,32 +170,6 @@ See :ref:`event-tracking` for information on creating signal handlers and the
status tracking events you can receive. status tracking events you can receive.
.. _inbound-configuration:
Configuring inbound email (optional)
------------------------------------
(Coming soon -- not yet implemented)
.. Anymail can optionally connect to your ESP's inbound webhook to notify your app
.. of incoming messages.
..
.. If you aren't using your EPS's inbound email, skip this section.
..
.. If you want to use inbound email with Anymail, follow the steps above
.. for setting up :ref:`status tracking webhooks <webhooks-configuration>`,
.. but enter the webhook URL in your ESP's "inbound email" settings,
.. substituting "inbound" for "tracking" at the end of the url:
..
.. :samp:`https://{random}:{random}@{yoursite.example.com}/anymail/{esp}/inbound/`
..
.. Then see :ref:`inbound` for information on creating a signal handler
.. for receiving inbound email notifications in your code.
..
.. (Note: if you are only using your ESP for inbound email, not sending messages,
.. there's no need to change your project's EMAIL_BACKEND.)
.. setting:: ANYMAIL .. setting:: ANYMAIL
Anymail settings reference Anymail settings reference

View File

@@ -17,6 +17,5 @@ Problems? We have some :ref:`troubleshooting` info that may help.
Now that you've got Anymail working, you might be interested in: Now that you've got Anymail working, you might be interested in:
* :ref:`Sending email with Anymail <sending-email>` * :ref:`Sending email with Anymail <sending-email>`
* :ref:`Receiving inbound email <inbound>`
* :ref:`ESP-specific information <supported-esps>` * :ref:`ESP-specific information <supported-esps>`
* :ref:`All the docs <main-toc>` * :ref:`All the docs <main-toc>`