README

Roundcube Webmail MarkAsJunk2
=============================
This plugin adds "mark as spam" or "mark as not spam" button to the message
menu.
Inspiration for this plugin was taken from:
Thomas Bruederli <roundcube@gmail.com> - original Roundcube Mark As Junk plugin

When not in the Junk mailbox:
  Messages are moved into the Junk mailbox and marked as read

When in the Junk mailbox:
  The buttons are changed to "mark as not spam" or "this message is not spam"
  and the message is moved to the Inbox

This plugin also integrates with the ContextMenu plugin

License
=======
This plugin is released under the GNU General Public License Version 3+
(http://www.gnu.org/licenses/gpl.html).

Even if skins might contain some programming work, they are not considered
as a linked part of the plugin and therefore skins DO NOT fall under the
provisions of the GPL license. See the README file located in the core skins
folder for details on the skin license.

Install
=======
* Place this plugin folder into plugins directory of Roundcube
* Add markasjunk2 to $rcmail_config['plugins'] in your Roundcube config
NB: When downloading the plugin from GitHub you will need to create a directory
called markasjunk2 and place the files in there, ignoring the root directory in
the downloaded archive.

Config
======
The default config file is plugins/markasjunk2/config.inc.php.dist
Rename this to plugins/markasjunk2/config.inc.php
All config parameters are optional

The Learning Driver
===================
The learning driver allows you to perform additional processing on each message
marked as spam/ham. A driver must contain a class named markasjunk2_{driver
file name}. The class must contain 2 functions:

spam: This function should take 1 argument, the UID of message being
            marked as spam

ham: This function should take 1 argument, the UID of message being
           marked as ham

Five drivers are provided by default they are:

cmd_learn: This driver calls an external command (for example salearn) to
           process the message

dir_learn: This driver places a copy of the message in a predefined folder, for
           example to allow for processing later

email_learn: This driver emails the message either as an attachment or directly
             to a set address

sa_blacklist: This driver adds the sender address of a spam message to the
              users blacklist (or whitelist of ham messages)
              Requires SAUserPrefs plugin

sa_detach: If the message is a Spamassassin spam report with the original email
           attached then this is detached and saved in the Inbox, the spam
           report is deleted

edit_headers: Edit the message headers. Headers are edited using preg_replace.
              WARNING: Be sure to match the entire header line, including the
              name of the header, and include the ^ and $ and test carefully
              before use on real messages. This driver alters the message
              source

Spam learning commands
======================
Spamassassin:
  'sa-learn --spam --username=%u %f' or
  'sa-learn --spam --prefs-file=/var/mail/%d/%l/.spamassassin/user_prefs %f'

Ham learning commands
=====================
Spamassassin:
  'sa-learn --ham --username=%u %f' or
  'sa-learn --ham --prefs-file=/var/mail/%d/%l/.spamassassin/user_prefs %f'


edit_headers example config
===========================
WARNING: These are simple examples of how to configure the driver options, use
at your own risk

$rcmail_config['markasjunk2_spam_patterns'] = array(
  'patterns' => array('/^(Subject:\s*)(.*)$/m'),
  'replacements' => array('$1[SPAM] $2')
);

$rcmail_config['markasjunk2_ham_patterns'] = array(
  'patterns' => array('/^(Subject:\s*)\[SPAM\](.*)$/m'),
  'replacements' => array('$1$2')
);