How To: Configure SiteWorx Spam Filtering
=========================================

InterWorx uses `SpamAssassin <https://spamassassin.apache.org>`__ to help keep levels of email spam reasonable. From the
Spam Flitering page in SiteWorx, users may manage the SpamAssassin service, determine how spam messages 
are handled for the account, and add custom rules. 

.. note::

   This documentation refers specifically to SiteWorx-level SpamAssassin settings. Information on NodeWorx SpamAssassin 
   settings can be found :doc:`here </nodeworx/mail_server/spam_and_virus_protection/configure-nodeworx-spam-filtering>`. 

.. contents::

To Manage SpamAssassin Status
-----------------------------

#. Log into SiteWorx from the browser (https://ip.ad.dr.ess:2443/siteworx)
#. In SiteWorx, navigate to **Administration > Mail Options > Spam Settings**, either from the side menu or SiteWorx home

   .. image:: /images/sw-spam.png
      :alt: spamassassin page 

#. Under SpamAssassin Configuration, Select either **On** or **Off** from the SpamAssassin Status dropdown

To Edit SpamAssassin Options
----------------------------

.. note::

   It is only possible to edit SpamAssassin configuration options when SpamAssassin is enabled.

#. Log into SiteWorx from the browser (https://ip.ad.dr.ess:2443/siteworx)
#. In SiteWorx, navigate to **Administration > Mail Options > Spam Settings**, either from the side menu or SiteWorx home

   .. image:: /images/sw-spam.png
      :alt: spamassassin page 
    
#. Under SpamAssassin Configuration, update the desired settings: 

   .. image:: /images/siteworx-spamassassin-settings.png
      :alt: siteworx spamassassin settings

   - **Spam Delivery**: Defines what happens to spam, once it has been tagged by SpamAssassin The options are:
 
     - Deliver the spam to an IMAP mailbox named Spam, or, if that box does not exist, the message is delivered to the 
       Inbox
     - Delete spam scored above a certain threshold. All messages that are below that threshold marked as spam are 
       delivered to an IMAP mailbox named Spam

   - **Spam Score Threshold**: Messages that are scored above this value will be tagged and identified as spam 
     by SpamAssassin. Messages with scores below this value will not be tagged as spam
   - **Rewrite Message Subject**: Determines whether SpamAssassin will alter the subject line of messages it 
     identifies as spam. This can make messages tagged as spam more readily visible when viewing a list of messages, 
     and can be used to filter messages based on the subject line in some e-mail clients
   - **Message Attachment Policy**: Determines how SpamAssassin handles the messages it tags as spam
   
#. Click **Submit**

To Manage Custom Spam Settings
------------------------------

SpamAssassin allows for custom rules to more specifically target and manage potential spam messages that enter the 
server. More detailed information can be found in `SpamAssassin's User Preferences documentation <https://spamassassin.apache.org/full/3.1.x/doc/Mail_SpamAssassin_Conf.html#user_preferences>`__.

Adding a Custom Spam Setting
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

#. Log into SiteWorx from the browser (https://ip.ad.dr.ess:2443/siteworx)
#. In SiteWorx, navigate to **Administration > Mail Options > Spam Settings**, either from the side menu or SiteWorx home

   .. image:: /images/sw-spam.png
      :alt: spamassassin page 
    
#. Under Advanced SpamAssassin Custom Options, click **+**. This opens the Add Spam Preference Form 

   .. image:: /images/sw-spam-advanced.png
      :alt: spamassassin advanced 

#. Under Add Spam Preference, update the desired fields: 

   .. image:: /images/siteworx-add-spam-rule.png
      :alt: siteworx add spam rules 

   - **Type**: Determines if the custom rule applies to the whole domain, or just a specific email address
   - **Add Preference For**: The domain or email address the rule should apply to
   - **Preference**: The type of custom SpamAssassin rule
   - **Value**: The value of the rule

#. Click **Add**

Editing Custom Spam Setting
^^^^^^^^^^^^^^^^^^^^^^^^^^^

#. Log into SiteWorx from the browser (https://ip.ad.dr.ess:2443/siteworx)
#. In SiteWorx, navigate to **Administration > Mail Options > Spam Settings**, either from the side menu or SiteWorx home

   .. image:: /images/sw-spam.png
      :alt: spamassassin page 
    
#. Under Advanced SpamAssassin Custom Options, click the **Pencil** next to the rule. This opens the Edit Spam 
   Preference form 

   .. image:: /images/sw-spam-advanced.png
      :alt: spamassassin advanced 

   .. image:: /images/siteworx-edit-spam-rule.png
      :alt: siteworx edit spam rules 

#. Update the desired fields
#. Click **Save**

Deleting a Custom Spam Setting
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

From the Rule List
''''''''''''''''''

#. Log into SiteWorx from the browser (https://ip.ad.dr.ess:2443/siteworx)
#. In SiteWorx, navigate to **Administration > Mail Options > Spam Settings**, either from the side menu or SiteWorx home

   .. image:: /images/sw-spam.png
      :alt: spamassassin page 
    
#. Under Advanced SpamAssassin Custom Options, click the **Trashcan** next to the rule. This opens the Delete Confirmation
   form

   .. image:: /images/sw-spam-advanced.png
      :alt: spamassassin advanced

   .. image:: /images/siteworx-delete-spam-rule.png
      :alt: siteworx delete spam rules 

#. Click **Delete**

From the With Selected Dropdown 
'''''''''''''''''''''''''''''''

#. Log into SiteWorx from the browser (https://ip.ad.dr.ess:2443/siteworx)
#. In SiteWorx, navigate to **Administration > Mail Options > Spam Settings**, either from the side menu or SiteWorx home

   .. image:: /images/sw-spam.png
      :alt: spamassassin page 
    
#. Select the **checkbox** next to the rule(s) 

   .. image:: /images/sw-spam-advanced.png
      :alt: spamassassin advanced

   - Selecting the **checkbox** next to the With Selected dropdown will automatically select all rules

#. Select **Delete** from the With Selected dropdown
#. Click **Go**. This opens the Confirm Deletion form 

   .. image:: /images/siteworx-delete-spam-rule.png
      :alt: siteworx delete spam rules 

#. Click **Delete**