Popis syntaxe konfiguračního souboru

Soubor obsahuje záznamy typu klíč=hodnota, přičemž znakem # nebo řetězcem // začíná řádkový komentář (do konce řádky).
KlíčPopis
pop3_portPort pro POP3 proxy (Default 110, specifikováno v config.h)
smtp_portPort pro SMTP proxy (Default 25, specifikováno v config.h)
blacklistNázev souboru s blacklistem - tento soubor obsahuje emailové adresy, po jedné položce na řádek. Pro zařazení všech emailů z jedné domény vložte do souboru před název domény řetězec @ (např. pro zablokování hotmail.com tam napište @hotmail.com)
Dále speciálně samotný znak @ na řádce matchuje se všemi emailovými adresami bez domény (ty, co neobsahují zavináč) - což se v blacklistu hodí.
Soubor může obsahovat komentáře - znakem # nebo řetězcem // začíná řádkový komentář (do konce řádky).
Soubor může obsahovat i prázdné řádky - ty jsou ignorovány.
Emailům, s adresou odesílatele obsaženou v blacklistu bude přidělena hodnota daná položkou v konfiguraci blacklist-level (typicky taková, která je zařadí mezi spam) a nebude na ně pouštěn klasifikátor.
Sem typicky dáváme emaily lidí či společností, co nás obtěžují a nedají si domluvit aby přestali.
whitelistNázev souboru s whitelistem - formát je zcela stejný jako u souboru s blacklistem (jeden email na řádek)
Emailům, s adresou odesílatele obsaženou ve whitelistu bude přidělena hodnota daná položkou v konfiguraci whitelist-level (typicky taková, která je zařadí mezi emaily, které určitě spam nejsou) a nebude na ně pouštěn klasifikátor.
Sem typicky dáváme emaily přátel, u kterých nechceme, aby je některý z filtrů omylem vyhodnotil jako spam.
Whitelisty má větší prioritu než blacklist.
whitelist-levelHodnota pro emaily ve whitelistu (Default je 0)
blacklist-levelHodnota pro emaily ve whitelistu (Default je 100)
classify-filter Před klasifikací emailu (classification) se spouští programy definované v konfiguračním souboru tímto klíčem. Tento klíč se může opakovat vícekrát, v tom případě budou programy spouštěny postupně dle pořadí v jakém jsou v konfiguračním souboru napsány.
Program dostane na standardní vstup celý email včetně hlaviček a očekává se, že tento email vrátí na standardní výstup, přičemž ho může libovolně pozměnit (např nahradit řetězec typu "slovo" za "slovo" v HTML mailu, dekódovat emaily kódované pomocí base64, převést HTML na text, atd ...)
Tyto programy mají za úkol usnadnit práci klasifikátoru, který se pak může soustředit na vlastní obsah mailu a nemusí se zabývat jeho kódováním, atd ....
Tyto programy mohou emaily libovolně "zkazit", neboť po klasifikaci je tento pozměněný email zahozen a pro další zpracování je použit opět ten originální.
classification Tato položka definuje klasifikační program.
Program dostane na standardní vstup celý email včetně hlaviček (zpracovaný programy definovanými v classify-filter) a očekává se, že na standardní výstup vypíše kladné celé číslo zakončené \n (newline), které bude hodnotou emailu.
Takto se email ohodnotí, doporučený rozsah je od 0 (email určitě není spam) do 100 (email určitě je spam), ale lze použít prakticky libovolné hodnoty (pokud jsou kladné a vejdou se do rozsahu signed int).
post-filter Po klasifikaci emailu (classification) se spouští programy definované v konfiguračním souboru tímto klíčem. Tento klíč se může opakovat víckrát, v tom případě budou programy spouštěny postupně dle pořadí v jakém jsou v konfiguračním souboru napsány.
Program dostane na standardní vstup celý email včetně hlaviček a očekává se, že tento email vrátí na standardní výstup, přičemž ho může libovolně pozměnit (např. odstranit reklamu vkládanou do některých newsletterů, odstranit signatury, atd ...) Záznam je ve tvaru "[rozsah] [program]".
[rozsah] je buď jedno kladné celé číslo, nebo dvě kladná celá čísla oddělená pomlčkou. Určuje, pro jaké hodnoty se program spustí.
[program] je jméno programu
post-action Po filtraci emailu (post=filter) se spouští programy definované v konfiguračním souboru tímto klíčem. Tento klíč se může opakovat víckrát, v tom případě budou programy spouštěny postupně dle pořadí v jakém jsou v konfiguračním souboru napsány.
Program dostane na standardní vstup celý email včetně hlaviček, na standardní výstup by neměl nic zapisovat.
Program může provést libovolné akce v závislosti na obsahu emailu (poslat ho na mobil, poslat spammerovi podvržený email "odesílatel neexistuje", přidat email do blacklistu nebo whitelistu, atd ....) Záznam je ve tvaru "[rozsah] [program]".
[rozsah] je buď jedno kladné celé číslo, nebo dvě kladná celá čísla oddělená pomlčkou. Určuje, pro jaké hodnoty se program spustí.
[program] je jméno programu
mark-subject Značkování emailů v závislosti na hodnotě
Těchto záznamů může být více (pro různé hodnoty). Pokud hodnotě odpovídá více záznamů, bude email označkován postupně více značkami. Záznam je ve tvaru "[rozsah] [značka]".
[rozsah] je buď jedno kladné celé číslo, nebo dvě kladná celá čísla oddělená pomlčkou. Určuje, pro jaké hodnoty se email označí.
[značka] je řetězec, který bude přidán před Subject (předmět) emailu
smtp_serveradresa smtp serveru, kam se budou přeposílat emaily, které přišly do SMTP proxy