%META:TOPICPARENT{name="OdsMail"}%
%ODSNAV%

---++ODS <nowiki>WebMail</nowiki> Spam Filter Guide

---+++What is it?
ODS <nowiki>WebMail</nowiki> offers the feature for Spam Filtering so to control which mails you can receive in our <nowiki>WebMail</nowiki> inbox and which mails to go to your <nowiki>WebMail</nowiki> Spam folder.

---+++Requirements

In order the Spam Filter option in ODS <nowiki>WebMail</nowiki>  to work properly you need to:

   1. Install the ODS Framework <nowiki>ods_framework_dav</nowiki>.vad package
   1. Install the ODS <nowiki>AddressBook</nowiki> <nowiki>ods_addressbook_dav</nowiki>.vad package
   1. Install the ODS <nowiki>WebMail</nowiki> <nowiki>ods_webmail_dav</nowiki>.vad package version 1.3.93 or higher.
      1. Make sure you have executed all steps from the [[OdsMailInstallGuide][Mail Installation Guide]] in order to be configured correctly the settings for receiving mail messages in your ODS dataspace.  
         * For example. let's say it is configured for domain with name "example.com".

---+++Properties

The Spam properties are set in Preferences page. The properties are:
   1. General Options (What is treated for Spam)
      * *Trust junk mail headers set by* will automatically recognize mail that is marked by a separate junk mail filtering program. Very often ISP or mail server will install such a filtering program, which adds special headers to your email before it is retrieved by ODS WebMail. Currently supported are: SpamAssassin and SpamPal.
      * *Do not mark messages as junk mail if the sender is in my address book* prevents messages from being automatically marked as junk mail if the sender is listed in the user's AddressBook instances. The user can also set the scope of allowed mails to be the contacts of his contacts. This respectively goes with depth 1, 2, etc.
   1. Handling (Determines what to do with junk mail when it is received)
      * When messages are determined to be Spam
         * Move them to the Spam folder (move incoming messages determined to be junk mail to will automatically place junk mail into the specified folder upon arrival);
         * Delete them.
      * Mark messages determined to be Spam as read;
      * Automatically delete spam messages older then N	days (0 - no delete);
	
---+++Simple example

   1. Go to http://[host]:[port]/ods and register an user, for ex. test1.    
      1. Create a <nowiki>WebMail</nowiki> instance for user test1, so to have for example mail value: test1@example.com. 
      1. Go to the <nowiki>WebMail</nowiki> instance UI and then click the "References" link.
      1. For the drop-down list with label "Spam Filter" change the value from "Disabled" to "My contacts only".
      1. Click the button "Save".
%BR%%BR%<img src="%ATTACHURLPATH%/ab0.png" style="wikiautogen"/>%BR%%BR%
   1. Logout as user test1 and create user test2.
      1. Create a <nowiki>WebMail</nowiki> instance for user test2, so to have for example mail value: test2@example.com. 
   1. Logout as user test2 and create user test3
      1. Create a <nowiki>WebMail</nowiki> instance for user test3, so to have for example mail value: test3@example.com. 
   1. Logout as user test3 and login as user test1.
      1. Create an <nowiki>AddressBook</nowiki> instance for user test1.
      1. From the <nowiki>AddressBook</nowiki> instance UI click the button "New Contact"
         1. Now leave the type to be with value "Person" and enter in the "Home" tab for name the value: John
         1. Go to tab "Contact" tab,
         1. Enter in the field "Mail" the value: test2@example.com
            * Note: this is a valid e-mail address of the ODS user test2.
         1. Click "Save"
      1. From the <nowiki>AddressBook</nowiki> instance UI click the button "New Contact"
         1. Now change the type value to "Organization" and enter in the "Home" tab for name the value: Kate&Co.
         1. Go to tab "Business" tab,
         1. Enter in the field "Mail" the value: test3@example.com
            * Note: this is a valid e-mail address of the ODS user test3.
         1. Click "Save"
%BR%%BR%<img src="%ATTACHURLPATH%/ab1.png" style="wikiautogen"/>%BR%%BR%
   1. Now logout and login as user test2 (or user test3).
      1. Go to user test2's <nowiki>WebMail</nowiki> instance
         1. Click the button "Write message".
         1. In the shown form enter:
            1. for field "To": test1@example.com
            1. for field "Subject": simple test
            1. for field "Comma separated tags": test
            1. for field "message": This is simple test.
%BR%%BR%<img src="%ATTACHURLPATH%/ab2.png" style="wikiautogen"/>%BR%%BR%
         1. Click the "send message" button
         1. As result should be shown the message: 
<verbatim>
The message has been sent successfully to: test1@example.com   
</verbatim>
   1. Now logout and login as user test1.
      1. Go to user test1 <nowiki>WebMail</nowiki> instance.
      1. As result in the Inbox there will be received one 1 mail message from test@example.com.
%BR%%BR%<img src="%ATTACHURLPATH%/ab3.png" style="wikiautogen"/>%BR%%BR%
   1. Now let's see what will happen where user test1 receives mail from a sender, which is not in his contact list. Logout as test1 and register in ODS user test4.
      1. Create a <nowiki>WebMail</nowiki> instance for user test4, so to have for example mail value: test4@example.com. 
      1. Go to user test4's <nowiki>WebMail</nowiki> instance.
         1. Click the button "Write message".
         1. In the shown form enter:
            1. for field "To": test2@example.com
            1. for field "Subject": new test
            1. for field "Comma separated tags": test
            1. for field "message": This is new test.      
%BR%%BR%<img src="%ATTACHURLPATH%/ab4.png" style="wikiautogen"/>%BR%%BR%
         1. Click the "send message" button
      1. As result should be shown the message: 
<verbatim>
The message has been sent successfully to: test1@example.com   
</verbatim>
   1. Now logout and login as user test1.
      1. Go to user test1 <nowiki>WebMail</nowiki> instance.
      1. As result in the Spam folder there will be one message received from sender with mail test4@example.com:
%BR%%BR%<img src="%ATTACHURLPATH%/ab5.png" style="wikiautogen"/>%BR%%BR%
      
CategoryMail CategoryODS CategoryOpenSource CategoryHowTo CategoryOdsMail CategoryWebSite

%ODSCOPY%