.. _settings:

========
Settings
========

Required Settings
^^^^^^^^^^^^^^^^^

The following settings are required.

Configure thumbnailing applications
-----------------------------------
To improve the user experience and performance of django-newsletter,
a thumbnailing application is used to automatically thumbnail
article images in newsletter messages.

Currently two applications are supported by default:
`easy-thumbnails <https://pypi.org/project/easy-thumbnails/>`_ and
`sorl-thumbnail <https://pypi.org/project/sorl-thumbnail/>`_.

First you will need to install the thumbnailing application (as per the
applications instructions). Afterwards the thumbnailing application can be
selected as follows::

    # Using sorl-thumbnail
    NEWSLETTER_THUMBNAIL = 'sorl-thumbnail'

    # Using easy-thumbnails
    NEWSLETTER_THUMBNAIL = 'easy-thumbnails'

This configures django-newletter to use these applications for relevant
model fields, admin fields, and template thumbnails.

Optional Settings
^^^^^^^^^^^^^^^^^

The following optional features may be configured.

Disabling email confirmation
----------------------------
Disable email confirmation for subscribe, unsubscribe and update actions for subscriptions.

By default subscribe, unsubscribe and update requests made by a user who is
not logged in need to be confirmed by clicking on an activation link in an
email. If you want all requested actions to be performed without email
confirmation, add following line to ``settings.py``::

    NEWSLETTER_CONFIRM_EMAIL = False

For more granular control the ``NEWSLETTER_CONFIRM_EMAIL`` setting can be
overridden for each of subscribe, unsubscribe and update actions, by adding
``NEWSLETTER_CONFIRM_EMAIL_SUBSCRIBE`` and/or
``NEWSLETTER_CONFIRM_EMAIL_UNSUBSCRIBE`` and/or
``NEWSLETTER_CONFIRM_EMAIL_UPDATE`` set to ``True`` or ``False``.

Disabling the no-user validation
--------------------------------
Disable checking for existing users for the provided email address.

By default, the subscribe/update/unsubscribe forms will reject email addresses
that belong to a registered user, asking the visitor to login instead. If you
want to bypass this check, add to ``settings.py``::

    NEWSLETTER_VALIDATE_NO_USER = False

Defaults to ``True``.

Configure rich text widget
--------------------------
Known to work are `django-imperavi <http://pypi.python.org/pypi/django-imperavi>`_
as well as for `django-tinymce <http://pypi.python.org/pypi/django-tinymce>`_.
Be sure to follow installation instructions for respective widgets. After
installation, the widgets can be selected as follows::

    # Using django-imperavi
    NEWSLETTER_RICHTEXT_WIDGET = "imperavi.widget.ImperaviWidget"

    # Using django-tinymce
    NEWSLETTER_RICHTEXT_WIDGET = "tinymce.widgets.TinyMCE"

If not set, django-newsletter will fall back to Django's default TextField
widget.

.. note::
    django-tinymce 3 and higher do not support Python 3.5.

Configure thumbnailing applications
-----------------------------------
To improve the user experience and performance of django-newsletter,
you may use various thumbnailing applications to automatically thumbnail
article images in newsletter messages.

Currently two applications are supported by default:
`easy-thumbnails <https://pypi.org/project/easy-thumbnails/>`_ and
`sorl-thumbnail <https://pypi.org/project/sorl-thumbnail/>`_.

First you will need to install the thumbnailing application (as per the
applications instructions). Afterwards the thumbnailing application can be
selected as follows::

    # Using sorl-thumbnail
    NEWSLETTER_THUMBNAIL = 'sorl-thumbnail'

    # Using easy-thumbnails
    NEWSLETTER_THUMBNAIL = 'easy-thumbnails'

This configures django-newletter to use these applications for relevant
model fields, admin fields, and template thumbnails.

If not set, django-newsletter will fall back to Django's default ImageField
and implement rudimentary thumbnailing with Pillow.

The thumbnail jpeg quality can be set with ``NEWSLETTER_THUMBNAIL_QUALITY``.
The value can range from 1 to 100. Defaults to 95.

    NEWSLETTER_THUMBNAIL_QUALITY = 95


Delay and batch size
--------------------
The delay between each email, batches en batch size can be specified with e.g.::

    # Amount of seconds to wait between each email. Here 100ms is used.
    NEWSLETTER_EMAIL_DELAY = 0.1

    # Amount of seconds to wait between each batch. Here one minute is used.
    NEWSLETTER_BATCH_DELAY = 60

    # Number of emails in one batch
    NEWSLETTER_BATCH_SIZE = 100

For both delays, sub-second delays can also be used. If the delays are not
set, it will default to not sleeping.