.. _email-settings:

==============
Email Settings
==============

Fleio sends email messages using the parameters defined in the ``settings.py`` file. See :ref:`how to edit settings.py
<edit_settings-py>`.

You will need a mail server for Fleio to send email messages. Set the values below based on your environment.

``DEFAULT_FROM_EMAIL`` is used for email messages sent to end-users and staff users. In the
:ref:`staff panel Configuration<configuration-general>`, you can override the ``From`` email field. The staff panel
Configuration takes precedence over the ``DEFAULT_FROM_EMAIL`` setting.

.. code-block:: python

    DEFAULT_FROM_EMAIL = 'cloud@mycloud.com'

In case of errors, messages are sent to the email address(es) defined in :ref:`admins-setting`. The error email messages
have the ``From`` field defined this way:

.. code-block:: python

    SERVER_EMAIL = 'cloud@mycloud.com'  # From field of error email messages. Not To field!

.. note::

    The default value for ``SERVER_EMAIL`` is ``root@localhost`` and your mail server may refuse emails coming from this
    address. Set ``SERVER_EMAIL`` to an email address accepted by your mail server, otherwise you will not receive error
    related emails.

If your SMTP server doesn't require authentication, the minimum needed configuration for email sending to work is just
one line in ``settings.py``:

.. code-block:: python

    EMAIL_HOST = 'server.host.name' # SMTP server

You can also configure SMTP authentication and other parameters:

.. code-block:: python

    EMAIL_HOST = 'server.host.name' # ex: smtp.gmail.com
    EMAIL_PORT = 587  # specify SMTP server port, if non-standard
    EMAIL_HOST_USER = 'smtpUserName'  # SMTP authentication user, usually the email address
    EMAIL_HOST_PASSWORD = 'UserPassword'  # SMTP password
    EMAIL_USE_TLS = True  # True if TLS should be enabled, False otherwise
    EMAIL_USE_SSL = False  # True if SSL should be enabled, False otherwise

Fleio uses Django underneath and all email settings are explained in the Django documentation:
`<https://docs.djangoproject.com/en/dev/topics/email/>`_.

If you have troubles receiving emails sent by Fleio, see :ref:`troubleshoot-email`.

.. note::

    Please note that if you are using Gmail for SMTP, you have to enable account access for less secure apps. Visit the
    following link to enable access for your account: https://myaccount.google.com/lesssecureapps