From e78410eea47c532462186f61d4a9f5b3c021c74f Mon Sep 17 00:00:00 2001 From: medmunds Date: Tue, 1 Nov 2016 11:46:49 -0700 Subject: [PATCH] Docs: remove references to future inbound handling (Postponed -- see discussion or vote to reopen in #4) [ci skip] --- README.rst | 4 ---- docs/esps/index.rst | 4 ---- docs/esps/mandrill.rst | 5 +++-- docs/inbound.rst | 12 ------------ docs/index.rst | 1 - docs/installation.rst | 28 +--------------------------- docs/quickstart.rst | 1 - 7 files changed, 4 insertions(+), 51 deletions(-) delete mode 100644 docs/inbound.rst diff --git a/README.rst b/README.rst index 99f6d15..40d8b15 100644 --- a/README.rst +++ b/README.rst @@ -45,10 +45,6 @@ built-in `django.core.mail` package. It includes: your ESP's webhooks to Django signals * "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 (including Python 2.7, Python 3 and PyPy). Anymail releases follow `semantic versioning `_. diff --git a/docs/esps/index.rst b/docs/esps/index.rst index 18643b6..9014920 100644 --- a/docs/esps/index.rst +++ b/docs/esps/index.rst @@ -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 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 diff --git a/docs/esps/mandrill.rst b/docs/esps/mandrill.rst index 6bfd1f6..3d579c1 100644 --- a/docs/esps/mandrill.rst +++ b/docs/esps/mandrill.rst @@ -374,8 +374,9 @@ parameters is that most logging and analytics systems are aware of the need to keep auth secret.) Anymail replaces `djrill.signals.webhook_event` with -`anymail.signals.tracking` and (in a future release) -`anymail.signals.inbound`. Anymail parses and normalizes +`anymail.signals.tracking` for delivery tracking events. +(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 equivalent of Djrill's ``data`` parameter is available diff --git a/docs/inbound.rst b/docs/inbound.rst deleted file mode 100644 index 0fab760..0000000 --- a/docs/inbound.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. _inbound: - -Receiving inbound email -======================= - -.. note:: - - Normalized inbound email handling is coming soon to Anymail. - - -Inbound email signals ---------------------- diff --git a/docs/index.rst b/docs/index.rst index 42d3883..c101263 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -34,7 +34,6 @@ Documentation quickstart installation sending/index - inbound esps/index tips/index troubleshooting diff --git a/docs/installation.rst b/docs/installation.rst index 0144c3b..fb654ab 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -65,7 +65,7 @@ this is a good time to add one. (Django's default is "webmaster\@localhost", which some ESPs will reject.) 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`. @@ -170,32 +170,6 @@ See :ref:`event-tracking` for information on creating signal handlers and the 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 `, -.. 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 Anymail settings reference diff --git a/docs/quickstart.rst b/docs/quickstart.rst index 3053166..91ad1e7 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -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: * :ref:`Sending email with Anymail ` -* :ref:`Receiving inbound email ` * :ref:`ESP-specific information ` * :ref:`All the docs `