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

Docs: update Mailgun links and examples

Browse Source
This commit is contained in:
medmunds
2021-01-26 18:13:49 -08:00
committed by Mike Edmunds
parent a522fb9f60
commit 2196ab8330
1 changed files with 36 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

59
docs/esps/mailgun.rst
View File

@@ -4,8 +4,16 @@ Mailgun
======= =======
Anymail integrates with the `Mailgun <https://mailgun.com>`_ Anymail integrates with the `Mailgun <https://mailgun.com>`_
transactional email service from Rackspace, using their transactional email service, using their `messages REST API`_.
REST API.
.. note::
By default, Anymail connects to Mailgun's US-based API servers.
If you are using Mailgun's EU region, be sure to change the
:setting:`MAILGUN_API_URL <ANYMAIL_MAILGUN_API_URL>` Anymail setting
as shown below.
.. _messages REST API: https://documentation.mailgun.com/en/latest/api-sending.html#sending
Settings Settings
@@ -41,6 +49,28 @@ root of the settings file if neither ``ANYMAIL["MAILGUN_API_KEY"]``
nor ``ANYMAIL_MAILGUN_API_KEY`` is set. nor ``ANYMAIL_MAILGUN_API_KEY`` is set.
.. setting:: ANYMAIL_MAILGUN_API_URL
.. rubric:: MAILGUN_API_URL
The base url for calling the Mailgun API.
The default is ``MAILGUN_API_URL = "https://api.mailgun.net/v3"``, which connects
to Mailgun's US service. You must change this if you are using Mailgun's European
region:
.. code-block:: python
ANYMAIL = {
"MAILGUN_API_KEY": "...",
"MAILGUN_API_URL": "https://api.eu.mailgun.net/v3",
# ...
}
(Do not include your sender domain or "/messages" in the API URL. Anymail
:ref:`figures this out <mailgun-sender-domain>` for you.)
.. setting:: ANYMAIL_MAILGUN_SENDER_DOMAIN .. setting:: ANYMAIL_MAILGUN_SENDER_DOMAIN
.. rubric:: MAILGUN_SENDER_DOMAIN .. rubric:: MAILGUN_SENDER_DOMAIN
@@ -76,27 +106,6 @@ If not provided, Anymail will attempt to validate webhooks using the
the same values for new Mailgun users, but will diverge if you ever rotate either key.) the same values for new Mailgun users, but will diverge if you ever rotate either key.)
.. setting:: ANYMAIL_MAILGUN_API_URL
.. rubric:: MAILGUN_API_URL
The base url for calling the Mailgun API. It does not include
the sender domain. (Anymail :ref:`figures this out <mailgun-sender-domain>`
for you.)
The default is ``MAILGUN_API_URL = "https://api.mailgun.net/v3"``, which connects
to Mailgun's US service. You must override this if you are using Mailgun's European
region:
.. code-block:: python
ANYMAIL = {
"MAILGUN_API_KEY": "...",
"MAILGUN_API_URL": "https://api.eu.mailgun.net/v3",
# ...
}
.. _API security settings: https://app.mailgun.com/app/account/security/api_keys .. _API security settings: https://app.mailgun.com/app/account/security/api_keys
@@ -154,10 +163,12 @@ values directly to Mailgun. You can use any of the (non-file) parameters listed
message = AnymailMessage(...) message = AnymailMessage(...)
message.esp_extra = { message.esp_extra = {
'o:deliverytime-optimize-period': '24h', # use Mailgun Send Time Optimization
'o:time-zone-localize': '16:00', # use Mailgun Timezone Optimization
'o:testmode': 'yes', # use Mailgun's test mode 'o:testmode': 'yes', # use Mailgun's test mode
} }
.. _Mailgun sending docs: https://documentation.mailgun.com/api-sending.html#sending .. _Mailgun sending docs: https://documentation.mailgun.com/en/latest/api-sending.html#sending
.. _mailgun-quirks: .. _mailgun-quirks: