Reactor provides a flexible approach for mail filtering and preparation. It can be (and for SynCom is) used as a tool to prepare messages for NNTP integration.
The following features are implemented:
removal of mailman or ‘complex’ signature lines:
If enabled this feature will detect and remove mailman signatures (inline and MIME-parts).In ‘complex’ mode possible signature parts will be matched against a setof regular expressions which enables arbitrary (multi-multi-line) signatures to be removed.removal of list-tags in Subject-header:
If the Subject-header contains a matching list-tag then this tag will be removed.fix for broken (aka. outlook style) forward and reply tags in Subject-header:
If enabled subjects containing localized versions of ‘RE’ and ‘FWD’ will be replacedwith RFC compliant versions.fix missing / incorrect Referencing- and In-Reply headers
If the message lacks a Referencing-header but provides In-Reply-To,then the missing header will be set accordingly.
--- !<tag:news.piratenpartei.de,2009:synfu/reactor>
settings:
outlook_hacks : yes
complex_footer : yes
strip_notes : no
verbose : yes
verbosity : 2
| parameter | supported values | description |
|---|---|---|
| outlook_hacks | yes / no | Filter outlook tags for RE:, FWD: etc. and replace them with RFC tags. |
| complex_footer | yes / no | Switch between simple mailman and generic mailing list signature filter. |
| strip_notes | yes / no | Remove additional “This is a XY signed message” notes. |
| verbose | yes / no | Enable logging to syslog. |
| verbosity | 0 - 999 | Set log verbosity (0 = no logging) |
Mail2News provides a drop-in replacement for mail2news.pl provided by the default INN installation. Since the final command (in the example: mailpost) is configurable a theoretical setup could feed messages to virtually any NNTP system.
Mail2News was designed to filter it’s output through SynFU.Reactor. While this step is optional Mail2News will provide special List-Tag hints and other useful information to ease the filtering process.
News2mail provides a drop-in replacement for news2mail.pl provided by the default INN installation.
By design messages are expected on STDIN and are assumed to have the following format:
@sm-message-token@ listid[, listid[, listid]]
STDIN is processes line by line with an arbitrary number of messages sent per processed line. @sm-message-token@ will be used to query inn_sm for the message body, which in turn will be processed.
Processing involves scanning for List-Tags / List-Ids and replacement / expansion of the Sender-header with the default- or list specific sender.
--- !<tag:news.piratenpartei.de,2009:synfu/postfilter>
settings:
inn_sm : /usr/lib/news/bin/sm
inn_host : news.piratenpartei.de
verbose : yes
verbosity : 2
default_sender : mail2news@piratenpartei.de
mail2news_cmd : |
/usr/local/bin/synfu-reactor |
/usr/lib/news/bin/mailpost -b /tmp -x In-Reply-To:User-Agent -d pirates {0[NNTP_ID]}
news2mail_cmd : |
/usr/sbin/sendmail -oi -oem -ee -odq -f "{0[FROM]}" -p "NNTP:{0[HOST]}" {1}
use_path_marker : yes
path_marker : host.domain.tld
filters:
- nntp : pirates.de.region.hh.test
smtp : .*test.lists.piratenpartei-hamburg.de
from : test@piratenpartei-hamburg.de
sender: mail2news@nordpiraten.de
- nntp : pirates.de.test
smtp : .*test.lists.piratenpartei.de
from : test@lists.piratenpartei.de
- nntp : pirates.de.talk.politik.etc.pflege
smtp : .*ag-pflege.lists.piratenpartei.de
from : ag-pflege@lists.piratenpartei.de
| parameter | supported values | description |
|---|---|---|
| inn_sm | filesystem path | Path to INN sm binary used by news2mail to fetch messages. |
| inn_host | string | Hostname provided as a replacement pattern in news2mail_cmd. |
| verbose | yes / no | Enable logging to syslog. |
| verbosity | 0 - 999 | Set log verbosity (0 = no logging) |
| default_sender | mail address | The default Sender: used by mail2news. |
| mail2news_cmd | shell command | Command used by mail2news to deploy messages to NNTP. |
| news2mail_cmd | shell command | Command used by news2mail to deploy messages to mailing lists. |
| use_path_marker | yes /no | Enable Path-based message filtering in mail2news |
| path_marker | fqdn | Hostname used to mark the Path:-Header |
| filters | list of filters | See the following table for details. |
The config parameter filters contains a list of filter entries with each entry defining the mapping for one mailing list. The following parameters are recognized in a filter definition:
| parameter | supported values | description |
|---|---|---|
| nntp | NNTP group id | Used to map NNTP groups to mailing lists and vice versa. |
| smtp | regular expression | Used to map mailing lists to NNTP groups and vice versa. |
| from | mail address | Used in From:-header and supplied as replacement {0[FROM]} in news2mail_cmd |
| sender | mail address | [optional] Overwrite default_sender on a per-list basis |
| force_tag | string | [optional] Force List-Tag for SynFU.Reactor. |
| broken_auth | yes / no | [optional] Some lists expect From: and Sender: tags to match.. |
Imp provides a flexible, plugin based framework for task scheduling and background processing. Jobs are implemented as python classes deriving from ImpJob and are spool directory which will be scanned on launch.
Jobs are loaded and processed in alphabetical order following these steps:
- load job plugins
- initialize job objects
- check the jobs run status
- execute the job (if needed)
- report results
If the --jobs parameter is provided only the listed will be executed.
synfu-imp
Specify path to synfu.conf
Attempt to run only tho comma seperated list of jobs
List help for installed plugins
Terminate the parameter list and start the list for possible plugin parameters.
--- !<tag:news.piratenpartei.de,2010:synfu/imp>
settings:
verbose : yes
verbosity : 3
jobs:
groom_newsgroups:
newsgroups : tests/data/misc/newsgroups
http_proxy : http://host:port
https_proxy: http://host:port
listinfo:
- host: lists.piratenpartei.de
info: https://service.piratenpartei.de/mailman/listinfo
| parameter | supported values | description |
|---|---|---|
| verbose | yes / no | Enable logging to syslog. |
| verbosity | 0 - 999 | Set log verbosity (0 = no logging) |
| jobs | dictionary | A dictionary with one group for each plugin |
The config parameter jobs contains a dictionary with options usable by installed plugins. A fresh installation contains the group groom_newsgroups which represents the default settings for the built-in GroomNewsgroups plugin.