Table of Contents

Modules

Modules are add-ons that allow POPFile to handle additional things than just POP mail. Since the majority of users won't need them, most modules require you to activate them. To this end, start POPFile, go to the Advanced Page, set the module's “_enabled” variable to 1, then click the “Update” button, shutdown POPFile, and start it up again and they will be active. You may need to configure them and adjust their security settings. After making any configuration changes in the UI, you may need to restart POPFile for the changes to take effect. On Windows they are not installed by default so you may need to rerun the installer and select the option to install the modules you wish to use if you did not already.

Here's an example: To enable the XMLRPC module, go to the Advanced Page. Scroll down until you find the xmlrpc section in the list of variables on the right. In that section, find the “xmlrpc_enabled” variable and change it to 1. Now click the “Update” button and shutdown POPFile. When you next start up POPFile again, the POPFile core should load the module and it should be functional and configurable from the Configuration Page.

SMTP and NNTP

For a long time we've had experimental support for two new protocols: SMTP (often used for incoming email) and NNTP (most commonly used for Usenet-style news). They are no longer experimental and are now distributed with POPFile. The SMTP and NNTP modules are disabled by default but can be enabled on the Advanced page.

The SMTP module is designed to act as a front-end for a real SMTP server accepting messages and proxying them into a single SMTP server after performing classification. This is for SMTP servers, not for sending outgoing mail. Once enabled you may need to visit the Advanced page of the UI to set the chain port and chain server.

More information on how to setup SMTP can be found at SMTP Proxy.

The NNTP module acts as a proxy between your News client and News server performing classification on articles. Currently it uses the same database as your mail which may be significantly different. You may want to setup a seperate POPFile install to handle NNTP.

To setup NNTP:

  1. enable the module on the UI's Advanced Page. Restart POPFile.
  2. Configure your nntp client in the same manner that you would an email client, e.g., your new nntp server would be localhost, your user name would be real.nntp.host:realusername
    1. if the nntp server does not require a username then use real.nntp.host: for the user name and a dummy (i.e. non-blank) password (the proxy will not send the dummy password to the nntp server and will report “authentication accepted” to the nntp client)
  3. Check for articles, they should pull thru POPFile.
  4. Use your nntp client's filter capability to detect either the modified header or the XPC header that POPFile adds.

XML-RPC

 
popfilemodules.txt · Last modified: 2012/05/06 17:22 by xuesheng

Should you find anything in the documentation that is incomplete, unclear, outdated or just plain wrong, please let us know and leave a note in the Documentation Forum.

Recent changes RSS feed Donate Driven by DokuWiki
The content of this wiki is protected by the GNU Fee Documentation License