This documentation is for Dovecot v2.x, see wiki1 for v1.x documentation.

Replacing antispam plugin with IMAPSieve

You will need at least pigeonhole v0.4.14 for this. If you have already configured sieve, please adjust the following to match your setup.

Caveats and possible pitfalls

Changes:

Dovecot configuration

protocol imap {
  mail_plugins = $mail_plugins imap_sieve
}

plugin {
  sieve_plugins = sieve_imapsieve sieve_extprograms

  # From elsewhere to Spam folder
  imapsieve_mailbox1_name = Spam
  imapsieve_mailbox1_causes = COPY
  imapsieve_mailbox1_before = file:/usr/lib/dovecot/sieve/report-spam.sieve

  # From Spam folder to elsewhere
  imapsieve_mailbox2_name = *
  imapsieve_mailbox2_from = Spam
  imapsieve_mailbox2_causes = COPY
  imapsieve_mailbox2_before = file:/usr/lib/dovecot/sieve/report-ham.sieve

  sieve_pipe_bin_dir = /usr/lib/dovecot/sieve

  sieve_global_extensions = +vnd.dovecot.pipe +vnd.dovecot.environment
}

Sieve scripts

Create directory /usr/lib/dovecot/sieve and put following files to that:

report-spam.sieve

require ["vnd.dovecot.pipe", "copy", "imapsieve", "environment", "variables"];

if environment :matches "imap.user" "*" {
  set "username" "${1}";
}

pipe :copy "sa-learn-spam.sh" [ "${username}" ];

report-ham.sieve

require ["vnd.dovecot.pipe", "copy", "imapsieve", "environment", "variables"];

if environment :matches "imap.mailbox" "*" {
  set "mailbox" "${1}";
}

if string "${mailbox}" "Trash" {
  stop;
}

if environment :matches "imap.user" "*" {
  set "username" "${1}";
}

pipe :copy "sa-learn-ham.sh" [ "${username}" ];

Shell scripts

For spamassassin

Note that using sa-learn often incurs significant start-up time for every message. This can cause "lockout" of the user until all the processes sequentially complete, potentially tens of seconds or minutes. If spamd is being used and the administrator is willing to accept the potential security issues of allowing unauthenticated learning of spam/ham, spamd can be envoked with the --allow-tell option and spamc with the --learntype= option. Please consult the man pages of spamd and spamc for further details.

sa-learn-spam.sh

   1 #!/bin/sh
   2 exec /usr/bin/sa-learn -u ${1} --spam

sa-learn-ham.sh

   1 #!/bin/sh
   2 exec /usr/bin/sa-learn -u ${1} --ham

For dspam

sa-learn-spam.sh

   1 #!/bin/sh
   2 exec /usr/bin/dspam --client --user ${1} --class=spam --source=error

sa-learn-ham.sh

   1 #!/bin/sh
   2 exec /usr/bin/dspam --client --user ${1} --class=innocent --source=error

CRLF handling

dspam may fail to read the mail if it contains CRLF line endings, add the Broken lineStripping option in dspam.conf if needed.

For rspamd

By default, rspamd does global learning. If you want per-user classification, or something more complex, see https://rspamd.com/doc/configuration/statistic.html

sa-learn-spam.sh

   1 #!/bin/sh
   2 exec /usr/bin/rspamc -h /run/rspamd/worker-controller.socket -P <secret> learn_spam

sa-learn-ham.sh

   1 #!/bin/sh
   2 exec /usr/bin/rspamc -h /run/rspamd/worker-controller.socket -P <secret> learn_ham

Before running following commands, make sure dovecot.conf has all the sieve configuration you want. Then run following commands:

sievec /usr/lib/dovecot/sieve/report-spam.sieve
sievec /usr/lib/dovecot/sieve/report-ham.sieve
chmod +x /usr/lib/dovecot/sieve/sa-learn-ham.sh /usr/lib/dovecot/sieve/sa-learn-spam.sh

Now your learn scripts should be invoked when you move mails between folders.

Debugging

To debug, you need to import "vnd.dovecot.debug" extension. Then you can put, when required

debug_log "something"

variables are supported in this.

RoundCube

Recent versions of RoundCube include a plugin (located in plugins/markasjunk) for allowing users to mark Spam/Ham in a convenient way. Please make sure the Junk/Spam folder matches your configuration.

HowTo/AntispamWithSieve (last edited 2017-11-20 18:03:43 by JeffKletsky)