Mailing List Archive

[Spamassassin Wiki] Update of "BetterDocumentation/ReadmeTxt" by LorenWilton
Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Spamassassin Wiki" for change notification.

The following page has been changed by LorenWilton:
http://wiki.apache.org/spamassassin/BetterDocumentation/ReadmeTxt

------------------------------------------------------------------------------
Welcome to SpamAssassin!
------------------------

+ What SpamAssassin Is
+ --------------------
+
SpamAssassin is a mail filter which attempts to identify spam using
a variety of mechanisms including text analysis, Bayesian filtering,
DNS blocklists, and collaborative filtering databases.

- Using its rule base, it uses a wide range of heuristic tests on mail
- headers and body text to identify "spam", also known as unsolicited
- commercial email.
+ What SpamAssassin Is Not
+ ------------------------
+
+ SpamAssassin is not a program to delete spam, route spam and ham to separate mailboxes or folders, or send bounces when you receive spam. Those are mail routing functions, and SpamAssassin is not a mail router. SpamAssassin is a mail filter or classifier. It will examine each message presented to it, and assign a score indicating the liklyhood that the mail is spam. An external program must then examine this score and do any routing the user wants done. There are many programs that will easily perform these functions after examining the score assigned by SpamAssassin.
+
+ How SpamAssassin Works
+ ----------------------
+
+ Using its rule base, SpamAssassin uses a wide range of heuristic tests on mail headers and body text to identify "spam", also known as unsolicited commercial email.

Once identified, the mail can then be optionally tagged as spam for
later filtering using the user's own mail user-agent application.

SpamAssassin typically differentiates successfully between spam and
non-spam in between 95% and 100% of cases, depending on what kind of
+ mail you get and your training of its Bayesian filter. Specifically, SpamAssassin has been shown to produce around 0.9% false negatives (spam that was missed) and around 0.1% false positives (ham incorrectly marked as spam). See the rules/STATISTICS*.txt files for more information.
- mail you get and your training of its Bayesian filter. Specifically,
- SpamAssassin has been shown to produce around 0.9% false negatives (spam
- that was missed) and around 0.1% false positives (ham incorrectly marked
- as spam). See the rules/STATISTICS*.txt files for more information.

+ SpamAssassin also includes plugins to support reporting spam messages automatically or manually to collaborative filtering databases such as Pyzor, DCC, and Vipul's Razor.
- SpamAssassin also includes plugins to support reporting spam messages
- automatically or manually to collaborative filtering databases such as
- Pyzor, DCC, and Vipul's Razor.

The distribution provides "spamassassin", a command line tool to
perform filtering, along with the "Mail::SpamAssassin" module set
+ which allows SpamAssassin to be used in spam-protection proxy SMTP or POP/IMAP server, or a variety of different spam-blocking scenarios.
- which allows SpamAssassin to be used in spam-protection proxy SMTP or
- POP/IMAP server, or a variety of different spam-blocking scenarios.

+ The distribution also provides "spamd", a daemonized version of SpamAssassin which runs persistently. Using its counterpart, "spamc", a lightweight client written in C, an MTA can process large volumes of mail through SpamAssassin without having to fork/exec a perl interpreter for each message.
- In addition, "spamd", a daemonized version of SpamAssassin which
- runs persistently, is available. Using its counterpart, "spamc",
- a lightweight client written in C, an MTA can process large volumes of
- mail through SpamAssassin without having to fork/exec a perl interpreter
- for each message.

+ If you have questions about SpamAssassin, please check the Wiki[2] to see if someone has already posted an answer to your question. (The Wiki doubles as a FAQ.) Failing that, post a message to the
+ spamassassin-users mailing list[3]. If you've found a bug (and you're sure it's a bug after checking the Wiki), please file a report in our Bugzilla[4].
- If you have questions about SpamAssassin, please check the Wiki[2] to
- see if someone has already posted an answer to your question. (The
- Wiki doubles as a FAQ.) Failing that, post a message to the
- spamassassin-users mailing list[3]. If you've found a bug (and you're
- sure it's a bug after checking the Wiki), please file a report in our
- Bugzilla[4].

[2]: http://wiki.apache.org/spamassassin/
[3]: http://wiki.apache.org/spamassassin/MailingLists
@@ -68, +63 @@

----------------------

IMPORTANT: If you are upgrading from a previous major version of
+ SpamAssassin, please be sure to read the notes in UPGRADE to find out what has changed in a non-backwards compatible way.
- SpamAssassin, please be sure to read the notes in UPGRADE to find out
- what has changed in a non-backwards compatible way.


Installing SpamAssassin
@@ -81, +75 @@

Customising SpamAssassin
------------------------

+ These are the configuration files installed by SpamAssassin. The commands that can be used therein are listed in the POD documentation for the Mail::SpamAssassin::Conf class (run the following command to read it: "perldoc Mail::SpamAssassin::Conf"). Note: The following directories are the standard defaults that people use. There is an explanation of all the default locations that SpamAssassin will look at the end.
- These are the configuration files installed by SpamAssassin. The commands
- that can be used therein are listed in the POD documentation for the
- Mail::SpamAssassin::Conf class (run the following command to read it:
- "perldoc Mail::SpamAssassin::Conf"). Note: The following directories are
- the standard defaults that people use. There is an explanation of all the
- default locations that SpamAssassin will look at the end.

- /usr/share/spamassassin/*.cf:

@@ -255, +244 @@

means that you can translate messages, test descriptions, and templates
into other languages.

+ If you do so, we would *really* appreciate if you could send a copy back of the updated messages; mail them to
+ <spamassassin-users@incubator.apache.org> . Hopefully if it takes off, I can add them to the distribution as "official" translations and build in support for this. You will, of course, get credited for this work ;)
- If you do so, I would *really* appreciate if you could
- send a copy back of the updated messages; mail them to
- <spamassassin-users@incubator.apache.org> . Hopefully if it takes off,
- I can add them to the distribution as "official" translations and build
- in support for this. You will, of course, get credited for this work ;)


Help With SpamAssassin
[Spamassassin Wiki] Update of "BetterDocumentation/ReadmeTxt" by LorenWilton [ In reply to ]
Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Spamassassin Wiki" for change notification.

The following page has been changed by LorenWilton:
http://wiki.apache.org/spamassassin/BetterDocumentation/ReadmeTxt

------------------------------------------------------------------------------
Locali[sz]ation
---------------

+ All text displayed to users is taken from the configuration files. This means that you can translate messages, test descriptions, and templates into other languages.
- All text displayed to users is taken from the configuration files. This
- means that you can translate messages, test descriptions, and templates
- into other languages.

If you do so, we would *really* appreciate if you could send a copy back of the updated messages; mail them to
- <spamassassin-users@incubator.apache.org> . Hopefully if it takes off, I can add them to the distribution as "official" translations and build in support for this. You will, of course, get credited for this work ;)
+ <users /at/ spamassassin.apache.org> . Hopefully if it takes off, I can add them to the distribution as "official" translations and build in support for this. You will, of course, get credited for this work ;)


Help With SpamAssassin
----------------------

+ There's a mailing list for support or discussion of SpamAssassin. It lives at <users /at/ spamassassin.apache.org>. See
- There's a mailing list for support or discussion of SpamAssassin. It
- lives at <spamassassin-users /at/ incubator.apache.org>. See
- http://wiki.apache.org/spamassassin/MailingLists for the sign-up address
+ http://wiki.apache.org/spamassassin/MailingLists for the sign-up address and a link to the archive of past messages.
- and a link to the archive of past messages.

Much more info is at http://wiki.apache.org/spamassassin/

@@ -263, +259 @@


There are some tests and code in SpamAssassin that are turned off by
default: experimental code, slow code, or code that depends on
- non-open-source software or services that are not always free. These
+ non-open-source software or services that are not always free. These disabled tests include:
- disabled tests include:

- DCC: depends on non-open-source software (disabled in init.pre)
- DomainKeys: experimental (disabled in init.pre)
@@ -273, +268 @@

- Razor2: depends on service that is not always free (disabled in init.pre)
- TextCat: slow (disabled in init.pre)

+ To turn on tests disabled in 50_scores.cf, simply assign them a non-zero score, e.g. by adding score lines to your ~/.spamassassin/user_prefs file.
- To turn on tests disabled in 50_scores.cf, simply assign them a non-zero
- score, e.g. by adding score lines to your ~/.spamassassin/user_prefs file.

To turn on tests disabled by commenting out the required plugin in
+ init.pre, you need to uncomment the loadplugin line and make sure the prerequisites for proper operation of the plugin are present.
- init.pre, you need to uncomment the loadplugin line and make sure the
- prerequisites for proper operation of the plugin are present.


Automatic Whitelist System
--------------------------

+ SpamAssassin includes automatic whitelisting; The current iteration is considerably more complex than the original version. The way it works is by tracking for each sender address the average score of messages so far seen from there. Then, it combines this long-term average score for the sender with the score for the particular message being evaluated, after all other rules have been applied.
- SpamAssassin includes automatic whitelisting; The current iteration is
- considerably more complex than the original version. The way it works is
- by tracking for each sender address the average score of messages so far
- seen from there. Then, it combines this long-term average score for the
- sender with the score for the particular message being evaluated, after
- all other rules have been applied.

- This functionality is on by default, and is enabled or disabled with the
+ This functionality is on by default, and is enabled or disabled with the "use_auto_whitelist" option.
- "use_auto_whitelist" option.

A system-wide auto-whitelist can be used, by setting the
- auto_whitelist_path and auto_whitelist_file_mode configuration commands
+ auto_whitelist_path and auto_whitelist_file_mode configuration commands appropriately, e.g.
- appropriately, e.g.

auto_whitelist_path /var/spool/spamassassin/auto-whitelist
auto_whitelist_file_mode 0666

+ The spamassassin -W and -R command line flags provide an API to add and remove entries 'manually', if you so desire. They operate based on an input mail message, to allow them to be set up as aliases which users can simply forward their mails to. See the spamassassin manual page for more details.
- The spamassassin -W and -R command line flags provide an API to add and
- remove entries 'manually', if you so desire. They operate based on an
- input mail message, to allow them to be set up as aliases which users can
- simply forward their mails to. See the spamassassin manual page for more
- details.

The default address-list implementation,
Mail::SpamAssassin::DBBasedAddrList, uses Berkeley DB files to store
[Spamassassin Wiki] Update of "BetterDocumentation/ReadmeTxt" by LorenWilton [ In reply to ]
Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Spamassassin Wiki" for change notification.

The following page has been changed by LorenWilton:
http://wiki.apache.org/spamassassin/BetterDocumentation/ReadmeTxt

------------------------------------------------------------------------------
What SpamAssassin Is Not
------------------------

- SpamAssassin is not a program to delete spam, route spam and ham to separate mailboxes or folders, or send bounces when you receive spam. Those are mail routing functions, and SpamAssassin is not a mail router. SpamAssassin is a mail filter or classifier. It will examine each message presented to it, and assign a score indicating the liklyhood that the mail is spam. An external program must then examine this score and do any routing the user wants done. There are many programs that will easily perform these functions after examining the score assigned by SpamAssassin.
+ SpamAssassin is not a program to delete spam, route spam and ham to
+ separate mailboxes or folders, or send bounces when you receive spam.
+ Those are mail routing functions, and SpamAssassin is not a mail router.
+ SpamAssassin is a mail filter or classifier. It will examine each
+ message presented to it, and assign a score indicating the liklyhood
+ that the mail is spam. An external program must then examine this score
+ and do any routing the user wants done. There are many programs that
+ will easily perform these functions after examining the score assigned
+ by SpamAssassin.

How SpamAssassin Works
----------------------

- Using its rule base, SpamAssassin uses a wide range of heuristic tests on mail headers and body text to identify "spam", also known as unsolicited commercial email.
+ Using its rule base, SpamAssassin uses a wide range of heuristic tests
+ on mail headers and body text to identify "spam", also known as
+ unsolicited commercial email.

Once identified, the mail can then be optionally tagged as spam for
later filtering using the user's own mail user-agent application.

SpamAssassin typically differentiates successfully between spam and
non-spam in between 95% and 100% of cases, depending on what kind of
- mail you get and your training of its Bayesian filter. Specifically, SpamAssassin has been shown to produce around 0.9% false negatives (spam that was missed) and around 0.1% false positives (ham incorrectly marked as spam). See the rules/STATISTICS*.txt files for more information.
+ mail you get and your training of its Bayesian filter. Specifically,
+ SpamAssassin has been shown to produce around 0.9% false negatives
+ (spam that was missed) and around 0.1% false positives (ham
+ incorrectly marked as spam). See the rules/STATISTICS*.txt files for
+ more information.

- SpamAssassin also includes plugins to support reporting spam messages automatically or manually to collaborative filtering databases such as Pyzor, DCC, and Vipul's Razor.
+ SpamAssassin also includes plugins to support reporting spam messages
+ automatically or manually to collaborative filtering databases such as
+ Pyzor, DCC, and Vipul's Razor.

The distribution provides "spamassassin", a command line tool to
perform filtering, along with the "Mail::SpamAssassin" module set
- which allows SpamAssassin to be used in spam-protection proxy SMTP or POP/IMAP server, or a variety of different spam-blocking scenarios.
+ which allows SpamAssassin to be used in spam-protection proxy SMTP or
+ POP/IMAP server, or a variety of different spam-blocking scenarios.

- The distribution also provides "spamd", a daemonized version of SpamAssassin which runs persistently. Using its counterpart, "spamc", a lightweight client written in C, an MTA can process large volumes of mail through SpamAssassin without having to fork/exec a perl interpreter for each message.
+ The distribution also provides "spamd", a daemonized version of
+ SpamAssassin which runs persistently. Using its counterpart, "spamc",
+ a lightweight client written in C, an MTA can process large volumes of
+ mail through SpamAssassin without having to fork/exec a perl interpreter
+ for each message.

- If you have questions about SpamAssassin, please check the Wiki[2] to see if someone has already posted an answer to your question. (The Wiki doubles as a FAQ.) Failing that, post a message to the
- spamassassin-users mailing list[3]. If you've found a bug (and you're sure it's a bug after checking the Wiki), please file a report in our Bugzilla[4].
+ If you have questions about SpamAssassin, please check the Wiki[2] to
+ see if someone has already posted an answer to your question. (The Wiki
+ doubles as a FAQ.) Failing that, post a message to the spamassassin-users
+ mailing list[3]. If you've found a bug (and you're sure it's a bug after
+ checking the Wiki), please file a report in our Bugzilla[4].

[2]: http://wiki.apache.org/spamassassin/
[3]: http://wiki.apache.org/spamassassin/MailingLists
@@ -63, +87 @@

----------------------

IMPORTANT: If you are upgrading from a previous major version of
- SpamAssassin, please be sure to read the notes in UPGRADE to find out what has changed in a non-backwards compatible way.
+ SpamAssassin, please be sure to read the notes in UPGRADE to find out
+ what has changed in a non-backwards compatible way.


Installing SpamAssassin
@@ -75, +100 @@

Customising SpamAssassin
------------------------

- These are the configuration files installed by SpamAssassin. The commands that can be used therein are listed in the POD documentation for the Mail::SpamAssassin::Conf class (run the following command to read it: "perldoc Mail::SpamAssassin::Conf"). Note: The following directories are the standard defaults that people use. There is an explanation of all the default locations that SpamAssassin will look at the end.
+ These are the configuration files installed by SpamAssassin. The
+ commands that can be used therein are listed in the POD documentation
+ for the Mail::SpamAssassin::Conf class (run the following command to
+ read it: "perldoc Mail::SpamAssassin::Conf"). Note: The following
+ directories are the standard defaults that people use. There is an
+ explanation of all the default locations that SpamAssassin will look
+ at the end.

- /usr/share/spamassassin/*.cf:

@@ -240, +271 @@

Locali[sz]ation
---------------

- All text displayed to users is taken from the configuration files. This means that you can translate messages, test descriptions, and templates into other languages.
+ All text displayed to users is taken from the configuration files. This
+ means that you can translate messages, test descriptions, and templates
+ into other languages.

- If you do so, we would *really* appreciate if you could send a copy back of the updated messages; mail them to
+ If you do so, we would *really* appreciate if you could send a copy back
- <users /at/ spamassassin.apache.org> . Hopefully if it takes off, I can add them to the distribution as "official" translations and build in support for this. You will, of course, get credited for this work ;)
+ of the updated messages; mail them to <users /at/ spamassassin.apache.org> .
+ Hopefully if it takes off, I can add them to the distribution as "official"
+ translations and build in support for this. You will, of course, get
+ credited for this work ;)


Help With SpamAssassin
----------------------

- There's a mailing list for support or discussion of SpamAssassin. It lives at <users /at/ spamassassin.apache.org>. See
+ There's a mailing list for support or discussion of SpamAssassin.
+ It lives at <users /at/ spamassassin.apache.org>. See
- http://wiki.apache.org/spamassassin/MailingLists for the sign-up address and a link to the archive of past messages.
+ http://wiki.apache.org/spamassassin/MailingLists for the sign-up address
+ and a link to the archive of past messages.

Much more info is at http://wiki.apache.org/spamassassin/

@@ -259, +297 @@


There are some tests and code in SpamAssassin that are turned off by
default: experimental code, slow code, or code that depends on
- non-open-source software or services that are not always free. These disabled tests include:
+ non-open-source software or services that are not always free. These
+ disabled tests include:

- DCC: depends on non-open-source software (disabled in init.pre)
- DomainKeys: experimental (disabled in init.pre)
@@ -268, +307 @@

- Razor2: depends on service that is not always free (disabled in init.pre)
- TextCat: slow (disabled in init.pre)

- To turn on tests disabled in 50_scores.cf, simply assign them a non-zero score, e.g. by adding score lines to your ~/.spamassassin/user_prefs file.
+ To turn on tests disabled in 50_scores.cf, simply assign them a non-zero
+ score, e.g. by adding score lines to your ~/.spamassassin/user_prefs file.

To turn on tests disabled by commenting out the required plugin in
- init.pre, you need to uncomment the loadplugin line and make sure the prerequisites for proper operation of the plugin are present.
+ init.pre, you need to uncomment the loadplugin line and make sure the
+ prerequisites for proper operation of the plugin are present.


Automatic Whitelist System
--------------------------

- SpamAssassin includes automatic whitelisting; The current iteration is considerably more complex than the original version. The way it works is by tracking for each sender address the average score of messages so far seen from there. Then, it combines this long-term average score for the sender with the score for the particular message being evaluated, after all other rules have been applied.
+ SpamAssassin includes automatic whitelisting; The current iteration is
+ considerably more complex than the original version. The way it works
+ is by tracking for each sender address the average score of messages so
+ far seen from there. Then, it combines this long-term average score for
+ the sender with the score for the particular message being evaluated,
+ after all other rules have been applied.

- This functionality is on by default, and is enabled or disabled with the "use_auto_whitelist" option.
+ This functionality is on by default, and is enabled or disabled with
+ the "use_auto_whitelist" option.

A system-wide auto-whitelist can be used, by setting the
- auto_whitelist_path and auto_whitelist_file_mode configuration commands appropriately, e.g.
+ auto_whitelist_path and auto_whitelist_file_mode configuration commands
+ appropriately, e.g.

auto_whitelist_path /var/spool/spamassassin/auto-whitelist
auto_whitelist_file_mode 0666

- The spamassassin -W and -R command line flags provide an API to add and remove entries 'manually', if you so desire. They operate based on an input mail message, to allow them to be set up as aliases which users can simply forward their mails to. See the spamassassin manual page for more details.
+ The spamassassin -W and -R command line flags provide an API to add and
+ remove entries 'manually', if you so desire. They operate based on an
+ input mail message, to allow them to be set up as aliases which users can
+ simply forward their mails to. See the spamassassin manual page for more
+ details.

The default address-list implementation,
Mail::SpamAssassin::DBBasedAddrList, uses Berkeley DB files to store