pacnpal/django-anymail
1
0
Fork 0
mirror of https://github.com/pacnpal/django-anymail.git synced 2025-12-22 12:51:06 -05:00
Code Issues Packages Projects Releases Wiki Activity

Update (almost) all the docs

Browse Source
This commit is contained in:
medmunds
2016-03-09 18:37:11 -08:00
parent 8f0f2d3d83
commit 20c6350140
28 changed files with 1741 additions and 1192 deletions
Download Patch File Download Diff File Expand all files Collapse all files

76
docs/troubleshooting.rst
View File

@@ -3,68 +3,60 @@
Troubleshooting
===============
Djrill throwing errors? Not sending what you want? Here are some tips...
Anymail throwing errors? Not sending what you want? Here are some tips...
Figuring Out What's Wrong
Figuring out what's wrong
-------------------------
* **Check the error message:** Look for a Mandrill error message in your
**Check the error message**
Look for an Anymail error message in your
web browser or console (running Django in dev mode) or in your server
error logs. As of v1.4, Djrill reports the detailed Mandrill error when
something goes wrong. And when the error is something like "invalid API key"
error logs. If you see something like "invalid API key"
or "invalid email address", that's probably 90% of what you'll need to know
to solve the problem.
* **Check the Mandrill API logs:** The Mandrill dashboard includes an
*incredibly-helpful* list of your `recent API calls`_ -- and you can click
into each one to see the full request and response. Check to see if the
data you thought you were sending actually made it into the request, and
if Mandrill has any complaints in the response.
**Check your ESPs API logs**
* **Double-check common issues:**
Many ESPs offer an incredibly-helpful log
of your recent API calls in their dashboards. Check the logs to see if the
data you thought you were sending actually made it to your ESP, and
if they recorded any errors there.
* Did you set your :setting:`MANDRILL_API_KEY` in settings.py?
* Did you add ``'djrill'`` to the list of :setting:`INSTALLED_APPS` in settings.py?
**Double-check common issues**
* Did you install Anymail with the ESPs you want available?
(E.g., `pip install anymail[mailgun,sendgrid]` -- *not* just `pip install anymail`.)
* Did you add any required settings for those ESPs to your settings.py?
(E.g., `ANYMAIL_MANDRILL_API_KEY`.)
* Did you add ``'anymail'`` to the list of :setting:`INSTALLED_APPS` in settings.py?
* Are you using a valid from address? Django's default is "webmaster@localhost",
which won't cut it. Either specify the ``from_email`` explicitly on every message
you send through Djrill, or add :setting:`DEFAULT_FROM_EMAIL` to your settings.py.
you send through Anymail, or add :setting:`DEFAULT_FROM_EMAIL` to your settings.py.
* **Try it without Djrill:** Try switching your :setting:`EMAIL_BACKEND`
setting to Django's `File backend`_ and then running your email-sending
code again. If that causes errors, you'll know the issue is somewhere
other than Djrill. And you can look through the :setting:`EMAIL_FILE_PATH`
**Try it without Anymail**
Try switching your :setting:`EMAIL_BACKEND` setting to
Django's :ref:`File backend <django:topic-email-file-backend>` and then running your
email-sending code again. If that causes errors, you'll know the issue is somewhere
other than Anymail. And you can look through the :setting:`EMAIL_FILE_PATH`
file contents afterward to see if you're generating the email you want.
.. _recent API calls: https://mandrillapp.com/settings/api
.. _File backend: https://docs.djangoproject.com/en/stable/topics/email/#file-backend
Getting Help
Getting help
------------
If you've gone through the suggestions above and still aren't sure what's wrong,
the Djrill community is happy to help. Djrill is supported and maintained by the
people who use it -- like you! (We're not Mandrill employees.)
the Anymail community is happy to help. Anymail is supported and maintained by the
people who use it -- like you! (We're not employees of any ESP.)
You can ask in either of these places (but please pick only one per question!):
For questions or problems with Anymail, you can open a `GitHub issue`_.
(And if you've found a bug, you're welcome to :ref:`contribute <contributing>` a fix!)
Ask on `StackOverflow`_
Tag your question with **both** ``Django`` and ``Mandrill`` to get our attention.
Bonus: a lot of questions about Djrill are actually questions about Django
itself, so by asking on StackOverflow you'll also get the benefit of the
thousands of Django experts there.
Open a `GitHub issue`_
We do our best to answer questions in GitHub issues. And if you've found
a Djrill bug, that's definitely the place to report it. (Or even fix it --
see :ref:`contributing`.)
Wherever you ask, it's always helpful to include the relevant portions of your
code, the text of any error messages, and any exception stack traces in your
question.
Whenever you open an issue, it's always helpful to mention which ESP you're using,
include the relevant portions of your code and settings, the text of any error messages,
and any exception stack traces.
.. _StackOverflow: http://stackoverflow.com/questions/tagged/django+mandrill
.. _GitHub issue: https://github.com/brack3t/Djrill/issues
.. _GitHub issue: https://github.com/anymail/django-anymail/issues