How To: Use a Mail Relay for Password Reset Emails
==================================================

For security, InterWorx does not send password reset emails through the
typical outbound email relays. In an environment where system administrators
only allow messages from a specific relay or relays, this could mean that password
reset emails may not arrive.  In this rare occasion, it is possible for system administrators to set the 
relay that will be used for sending password reset emails.

.. contents::

To Configure a Mail Relay for Password Reset Emails
----------------------------------------------------

#. Log in to the server at the CLI as root, either via SSH or from
   the terminal
#. At the CLI, using a text editor, open ``~iworx/iworx.ini``. The following example uses the Vim text editor: 

   .. code-block::

      vim ~iworx/iworx.ini

#. In edit mode, add the following to the end of the file, replacing ``relayserveraddress.tld`` with the corresponding
   information: 

   .. code-block::

      [lostpass]
      relay="relayserveraddress.tld"

#. If the relay requires SMTP authentication, add all of the following fields just below ``relay``, replacing 
   ``smtp_user_name``, ``yourpassword``, and ``login`` with the corresponding information. Authentication style 
   settings are provided the third-party email relay service.:

   .. code-block::

      username="smtp_user_name"
      password="yourpassword"
      connection_class="login"

   ``connection_class`` should be set to one of the following options: 
   
     - ``plain``
     - ``login``
     - ``crammd5`` 
    
   These options are explained in greater detail `here <https://www.mailslurp.com/blog/smtp-authentication/>`__. 
   
   .. warning::
      
      If any of the three fields above are missing, InterWorx will not attempt
      to use any credentials when accessing the relay.

#. Save and exit the file