---
title: 'antispam:plugin:pyzor'
url: 'https://docs.danami.com/warden/command-line-interface/antispam/antispam-plugin-pyzor'
markdown: 'https://docs.danami.com/warden/command-line-interface/antispam/antispam-plugin-pyzor.md'
date: '2026-10-07'
description: 'A collaborative, networked system to detect and block spam using identifying digests of messages. warden --task=antispam:plugin:pyzor Option Value Default Description --use_pyzor <1|0> 1 Whether to use Pyzor, if it is available. --pyzor_fork <1|0> 0 Instead of running…'
taxonomy:
  category:
    - docs
  tag:
    - pyzor
---

[](#)  [ Basics ](https://docs.danami.com/warden/)     [ Command Line Interface ](https://docs.danami.com/warden/command-line-interface)      Antispam       antispam:plugin:pyzor    

# antispam:plugin:pyzor

A collaborative, networked system to detect and block spam using identifying digests of messages.

```
warden --task=antispam:plugin:pyzor
```

| Option | Value | Default | Description |
|---|---|---|---|
| `--use_pyzor` | <1\|0> | 1 | Whether to use Pyzor, if it is available. |
| `--pyzor_fork` | <1\|0> | 0 | Instead of running Pyzor synchronously, fork separate process for it and read the results in later (similar to async DNS lookups). Increases throughput. (SA 4.0+) |
| `--pyzor_count_min` | <digit> | 5 | How often a messages body checksum must have been reported to the Pyzor server before SpamAssassin will consider the Pyzor check as matched. |
| `--pyzor_welcomelist_min` | <digit> | 10 | How often a messages body checksum must have been whitelisted to the Pyzor server for SpamAssassin to consider ignoring the result. Final decision is made by pyzor\_welcomelist\_factor. (SA 4.0+) |
| `--pyzor_welcomelist_factor` | <int> | 0.2 | Ignore Pyzor result if REPORTCOUNT x NUMBER >= pyzor\_welcomelist\_min. For default setting this means: 50 reports requires 10 whitelistings. (SA 4.0+) |
| `--pyzor_timeout` | <digit> | 10 | How many seconds you wait for Pyzor to complete, before scanning continues without the Pyzor results. A numeric value is optionally suffixed by a time unit (s, m, h, d, w, indicating seconds (default), minutes, hours, days, weeks). |
| `--pyzor_max` | <digit> | 5 | How often a messages body checksum must have been reported to the Pyzor server before SpamAssassin will consider the Pyzor check as matched. As most clients should not be auto-reporting these checksums, you should set this to a relatively low value, e.g. 5. (SA 3.4) |
| `--pyzor_path` | <string> | /usr/bin/pyzor | The full path to the pyzor binary. |
| `--pyzor_options` | <string> | --homedir /etc/mail/spamassassin/.pyzor | Specify additional options to the pyzor command. Please note that only characters in the range \[0-9A-Za-z ,.\_/-\] are allowed for security reasons. |
| `--default` | <yes> |  | Reset all settings to their default values. |
| `--default_option` | <option> |  | Reset a specific setting to its default value. |
| `--reload` | <yes> |  | Reload the service after saving settings. |

## Examples

```
// set the pyzor_timeout
warden --task=antispam:plugin:pyzor --pyzor_timeout=5 --reload=yes

// reset pyzor_timeout to its default value
warden --task=antispam:plugin:pyzor --default_option=pyzor_timeout --reload=yes

// reset all settings to their default values
warden --task=antispam:plugin:pyzor --default=yes --reload=yes

// increase throughput by running Pyzor in a forked process and require 10 reports before a match
warden --task=antispam:plugin:pyzor --pyzor_fork=1 --pyzor_count_min=10 --reload=yes
```

## Related Pages

- [Pyzor Settings](https://docs.danami.com/warden/settings/antispam/plugin-settings/pyzor "Pyzor Settings")
- [Pyzor](https://docs.danami.com/warden/user-guide/antispam-plugins/pyzor "Pyzor")

 [ ](https://docs.danami.com/warden/user-guide/antispam-plugins/pyzor) [](https://docs.danami.com/warden/settings/antispam/plugin-settings/pyzor)

---

## Navigation

- Previous: [antispam:plugin:phishing](https://docs.danami.com/warden/command-line-interface/antispam/antispam-plugin-phishing.md)
- Next: [antispam:plugin:razor2](https://docs.danami.com/warden/command-line-interface/antispam/antispam-plugin-razor2.md)
