MIGRATED TO http://wavelet.asia/customer-portal/2011/03/01/pop-message-processing-filter/

Related to : AGUSTA-75

Overview of POP Mail Processing Filter

I am sure you have used before or at least heard of the Email Filter feature on GMail, where you can configure GMail to perform certain tasks, for example forward the Email to someone, if the Email contains certain keywords.

If you have not used the Email Filter on GMail before, I would suggest that you do so now, as it will help you to understand this manual much better. To test out the EMail Filter on GMail, simply follow the steps below :

1. Sign on to your GMail
2. On top right corner, click Settings
3. Click Filter tab
4. Click Create New Filter
5. Start customize your filter then click next
   
6. Choose to Forward it to an email account of your choice
7. Click Create Filter
8. Now, try sending an email with keywords specified in your filter earlier on from another email account to your GMail.
   
9. You will notice that GMail when detected that the email that is receives matches the filter, it will forward the email to the specific email account.
   

Now, you have seen GMail in action. Well, this Plugin is to do precisely what Gmail's Email Filter can do. Basically, you just need to provide details on the POP Mail to connect to, customize your Filters, specify when or how often you want this plugin to be executed, it will handle the Filtering and Forwarding for you. For more detailed guide, please read on.

How it works?

1. Configure POP Server settings
   
• 
• For this plugin to work, you need to let it know which POP Server and Email Account to look into
  
• You can do so from EMP -> System Admin -> EMP Configurations -> System -> SMTP / POP Notifcation Config
  
• Recipient POP Address : this will let the plugin know which POP Server to connect to
  
• Recipient Email : this will let the plugin know which Email Account to look into
• Recipient Password : this is the password to the Recipient Email account
• Recipient Port : default Port for POP is 110, however, each POP Server might be different, for example, GMail is using 995
• Recipient Allow Use of Starttls Command, Recipient Socket Class, Recipient Allow Fallback : these 3 settings also vary from server to server, on most cases you can just use the default values.
2. Customize your Filter
• 
• Here is where you can specify which email forward to who.
• You can do so from EMP -> System Admin -> EMP Configurations -> POP Message Processing Filter -> Add Message Processing Filter
• Type : Currently, there is only 1 Type, which is notification. It can be report, etc.
• Filter Name : You can give any name to your filter. You will be using this name to identify your filter in the listing later on.
  
• Filter From :
  
• Do note that the value that you key in here have to comply to Regular Expression.
  
• If you want to filter the incoming emails base on Sender Email Address, then you will need to specify the email address to look out for here. For example, I want to filter all emails coming from wavelet.biz, my value here will be .*wavelet.biz.*
  
• If you do not want to filter the incoming emails base on Sender Email Address, DO NOT just leave this field BLANK, instead, you have to fill it up with .*, which means any address.
  
• Filter To :
• Do note that the value that you key in here have to comply to Regular Expression.
  
• If you want to filter the incoming emails base on Recipient Email Address, then you will need to specify the email address to look out for here. For example, I want to filter all emails that is also sent to wavelet.biz besides myselft, my value here will be .*wavelet.biz.*
  
• If you do not want to filter the incoming emails base on Recipient Email Address, DO NOT just leave this field BLANK, instead, you have to fill it up with .*, which means any address.
• Filter Subject :
• Do note that the value that you key in here have to comply to Regular Expression.
  
• If you want to filter the incoming emails base on Email Subject / Title, then you will need to specify the Email Subject / Title to look out for here. For example, I want to filter all emails with subject as "NOTIFICATION : ............", my value here will be .*NOTIFICATION.*
  
• If you do not want to filter base on Sender Email Subject / Title, DO NOT just leave this field BLANK, instead, you have to fill it up with .*, which means any subject.
• Filter Content :
• Do note that the value that you key in here have to comply to Regular Expression.
  
• If you want to filter the incoming emails base on Email Content, then you will need to specify the keyword to look out for in the Email Content here. For example, I want to filter all emails which has "Tag : inv_exit_credit_term" in the content, my value here will be .*Tag : inv_exceeded_credit_term.*
  
• If you do not want to filter base on Email Content, DO NOT just leave this field BLANK, instead, you have to fill it up with .*, which means any email content.
• Action Forward : Here is where you specify which email address you want to forward the emails to should the email matches all the Filter requirements (From, To, Subject, Content).
• Once a filter is created, you can Edit / Delete it from EMP -> System Admin -> EMP Configurations -> POP Message Processing Filter : List Message Processing Filters. Do note that the Delete action will be recorded in Audit Trail.
  
3. Download Plugin JAR File
   
• Now, you need to download the plugin's JAR file from here.
4. Create a Scheduler Task for this plugin JAR
• You can do so from EMP -> Plugin -> Task Scheduler -> Create Task. For more detailed guide, refer to Plugin -> Task Scheduler
5. Once you are done, this plugin will automatically connect to designated POP Server at the specific time that you specify in the trigger, retrieve email from designated Email Account, run the email through all the pre-configured filters and forward matching email to pre-specified email addresses. It will then bcc the email to the email address specified in System Admin -> EMP Configurations -> System -> SMTP / POP Notification Email -> Sender SMTP Username before deleting it from the POP Server.