In SpamAssassin version 4.0.0 all configuration directives, rulenames, eval-functions, command line options and modules that contain "whitelist" or "blacklist" have been renamed to contain "welcomelist" and "blocklist" terms. This allows acronyms like WL and BL to remain the same. Previous names will continue work at least until version 4.1.0 is released.
Examples:
- Rule USER_IN_WHITELIST is now named USER_IN_WELCOMELIST
- Configuration directive auto_whitelist_path is now auto_welcomelist_path
- Spamassassin command line option --add-to-blacklist is now --add-to-blocklist
If you are installing a fresh 4.0 version without any existing local installation/rules, no further actions are needed. Simply use the new naming. Reference list of new names is found later in this page.
If you upgrade from older version to 4.0, by default the stock sa-update ruleset will use both old and new rulenames for backwards compatibility, for example:
-0.0 USER_IN_WELCOMELIST User is listed in 'welcomelist_from' -100 USER_IN_WHITELIST DEPRECATED: See USER_IN_WELCOMELIST
First you should verify if you are using any of the old naming in your local rules, you can use grep to find them:
egrep -i '(whitelist|blacklist)' /etc/mail/spamassassin/*.cf
At the bottom of this page, you can find a reference list of all changed names.
If there are any meta-rules referring to rulenames like USER_IN_WHITELIST or you have set local scores for rules like USER_IN_WHITELIST or use directives like "auto_whitelist_path", rename all by replacing white→welcome and black→block.
After all naming in your local configuration is fixed, you can activate version compatibility by adding this in your local.pre or init.pre file (any *.pre file will do, they are not overwritten by any installer):
enable_compat welcomelist_blocklist
In a fresh 4.0 installation, this same declaration is added by default in init.pre.
With the compatibility activated, stock sa-update ruleset will now only use the new rulenames:
-100 USER_IN_WELCOMELIST User is listed in 'welcomelist_from'
List of changed rulenames in official sa-update ruleset:
| Old rulename | New rulename |
|---|---|
| SUBJECT_IN_BLACKLIST | SUBJECT_IN_BLOCKLIST |
| SUBJECT_IN_WHITELIST | SUBJECT_IN_WELCOMELIST |
| URI_HOST_IN_BLACKLIST | URI_HOST_IN_BLOCKLIST |
| URI_HOST_IN_WHITELIST | URI_HOST_IN_WELCOMELIST |
| USER_IN_BLACKLIST | USER_IN_BLOCKLIST |
| USER_IN_BLACKLIST_TO | USER_IN_BLOCKLIST_TO |
| USER_IN_DEF_WHITELIST | USER_IN_DEF_WELCOMELIST |
| USER_IN_DKIM_WHITELIST | USER_IN_DKIM_WELCOMELIST |
| USER_IN_SPF_WHITELIST | USER_IN_SPF_WELCOMELIST |
| USER_IN_WHITELIST | USER_IN_WELCOMELIST |
| USER_IN_WHITELIST_TO | USER_IN_WELCOMELIST_TO |
List of changed rule eval-function names:
| Old function | New function |
|---|---|
| check_for_def_dkim_whitelist_from | check_for_def_dkim_welcomelist_from |
| check_for_dkim_whitelist_from | check_for_dkim_welcomelist_from |
| check_forged_in_default_whitelist | check_forged_in_default_welcomelist |
| check_forged_in_whitelist | check_forged_in_welcomelist |
| check_from_in_auto_whitelist | check_from_in_auto_welcomelist |
| check_from_in_blacklist | check_from_in_blocklist |
| check_from_in_default_whitelist | check_from_in_default_welcomelist |
| check_from_in_whitelist | check_from_in_welcomelist |
| check_to_in_blacklist | check_to_in_blocklist |
| check_to_in_whitelist | check_to_in_welcomelist |
| check_uri_host_in_blacklist | check_uri_host_in_blocklist |
| check_uri_host_in_whitelist | check_uri_host_in_welcomelist |
| check_whitelist_bounce_relays | check_welcomelist_bounce_relays |
List of changed configuration directives in core:
| Old directive | New directive |
|---|---|
| blacklist_from | blocklist_from |
| blacklist_to | blocklist_to |
| blacklist_uri_host | blocklist_uri_host |
| def_whitelist_auth | def_welcomelist_auth |
| def_whitelist_from_rcvd | def_welcomelist_from_rcvd |
| unblacklist_from | unblocklist_from |
| unwhitelist_auth | unwelcomelist_auth |
| unwhitelist_from | unwelcomelist_from |
| unwhitelist_from_rcvd | unwelcomelist_from_rcvd |
| whitelist_allows_relays | welcomelist_allows_relays |
| whitelist_auth | welcomelist_auth |
| whitelist_from | welcomelist_from |
| whitelist_from_rcvd | welcomelist_from_rcvd |
| whitelist_to | welcomelist_to |
| whitelist_uri_host | welcomelist_uri_host |
List of changed configuration directives in all plugins:
| Old directive | New directive |
|---|---|
| auto_whitelist_db_modules | auto_welcomelist_db_modules |
| auto_whitelist_distinguish_signed | auto_welcomelist_distinguish_signed |
| auto_whitelist_factor | auto_welcomelist_factor |
| auto_whitelist_factory | auto_welcomelist_factory |
| auto_whitelist_file_mode | auto_welcomelist_file_mode |
| auto_whitelist_ipv4_mask_len | auto_welcomelist_ipv4_mask_len |
| auto_whitelist_ipv6_mask_len | auto_welcomelist_ipv6_mask_len |
| auto_whitelist_path | auto_welcomelist_path |
| blacklist_subject | blocklist_subject |
| def_whitelist_from_dkim | def_welcomelist_from_dkim |
| def_whitelist_from_spf | def_welcomelist_from_spf |
| freemail_import_def_whitelist_auth | freemail_import_def_welcomelist_auth |
| freemail_import_whitelist_auth | freemail_import_welcomelist_auth |
| hashbl_email_whitelist | hashbl_email_welcomelist |
| pyzor_whitelist_factor | pyzor_welcomelist_factor |
| pyzor_whitelist_min | pyzor_welcomelist_min |
| txrep_whitelist_out | txrep_welcomelist_out |
| unwhitelist_from_dkim | unwelcomelist_from_dkim |
| unwhitelist_from_spf | unwelcomelist_from_spf |
| use_auto_whitelist | use_auto_welcomelist |
| whitelist_bounce_relays | welcomelist_bounce_relays |
| whitelist_from_dkim | welcomelist_from_dkim |
| whitelist_from_spf | welcomelist_from_spf |
| whitelist_subject | welcomelist_subject |
List of changed spamassassin command line options:
| Old option | New option |
|---|---|
| add-addr-to-whitelist | add-addr-to-welcomelist |
| add-to-whitelist | add-to-welcomelist |
| remove-addr-from-whitelist | remove-addr-from-welcomelist |
| remove-from-whitelist | remove-from-welcomelist |
| add-addr-to-blacklist | add-addr-to-blocklist |
| add-to-blacklist | add-to-blocklist |
List of changed module names:
| Old name | New name |
|---|---|
| Mail::SpamAssassin::Plugin::WhiteListSubject | Mail::SpamAssassin::Plugin::WelcomeListSubject |
| Mail::SpamAssassin::AutoWhitelist | Mail::SpamAssassin::AutoWelcomelist |