Usage:
rspamc-4.2.3 [OPTION…] - run rspamc client
Summary:
Rspamd client version 4.2.3
Release id: release
Help Options:
-?, --help Show help options
Application Options:
-h, --connect Specify host and port
-P, --password Specify control password
-c, --classifier Classifier to learn spam or ham
-w, --weight Weight for fuzzy operations
-f, --flag Flag for fuzzy operations
-p, --pass-all Pass all filters
-v, --verbose More verbose output
-i, --ip Emulate that message was received from specified ip address
-u, --user Emulate that message was received from specified authenticated user
-d, --deliver Emulate that message is delivered to specified user (for LDA/statistics)
-F, --from Emulate that message has specified SMTP FROM address
-r, --rcpt Emulate that message has specified SMTP RCPT address
--helo Imitate SMTP HELO passing from MTA
--hostname Imitate hostname passing from MTA
-t, --timeout Time in seconds to wait for a reply
-b, --bind Bind to specified ip address
--commands List available commands
-R, --human Output human readable report
-j, --json Output json reply
--compact Output compact json reply
--headers Output HTTP headers
--raw Input is a raw file, not an email file
--ucl Output ucl reply from rspamd
-n, --max-requests Maximum count of parallel requests to rspamd
--extended-urls Output urls in extended format
--key Use specified pubkey to encrypt request
-e, --exec Execute the specified command and pass output to it
-m, --mime Write mime body of message with headers instead of just a scan's result
--header Add custom HTTP header to query (can be repeated)
--metadata-header Add custom field to v3 metadata headers as KEY=VALUE or KEY:VALUE (can be repeated)
--exclude Exclude specific glob patterns in file names (can be repeated)
--sort Sort output in a specific order (name, weight, frequency, hits)
-E, --empty Allow empty input instead of reading from stdin
-S, --fuzzy-symbol Learn the specified fuzzy symbol
-z, --compressed Enable zstd compression
--profile Profile symbols execution time
-D, --dictionary Use dictionary to compress data
--skip-images Skip images when learning/unlearning fuzzy
--skip-attachments Skip attachments when learning/unlearning fuzzy
--protocol-v3 Use v3 multipart protocol (structured metadata, multipart response)
--msgpack Use msgpack for v3 metadata and response (requires --protocol-v3)
-U, --user-agent Use specific User-Agent instead of "rspamc"
--files-list Read one or more newline separated filenames to scan from file
--queue-id Set Queue-ID header for the request
--log-tag Set Log-Tag header for the request
--output-body Save rewritten message body to file
--settings Set Settings header as JSON/UCL for the request
Options (48)
| Option | Description | Source |
|---|
-?, --help | Show help options | help |
-h, --connect | Specify host and port | help |
-P, --password | Specify control password | help |
-c, --classifier | Classifier to learn spam or ham | help |
-w, --weight | Weight for fuzzy operations | help |
-f, --flag | Flag for fuzzy operations | help |
-p, --pass-all | Pass all filters | help |
-v, --verbose | More verbose output | help |
-i, --ip | Emulate that message was received from specified ip address | help |
-u, --user | Emulate that message was received from specified authenticated user | help |
-d, --deliver | Emulate that message is delivered to specified user (for LDA/statistics) | help |
-F, --from | Emulate that message has specified SMTP FROM address | help |
-r, --rcpt | Emulate that message has specified SMTP RCPT address | help |
--helo | Imitate SMTP HELO passing from MTA | help |
--hostname | Imitate hostname passing from MTA | help |
-t, --timeout | Time in seconds to wait for a reply | help |
-b, --bind | Bind to specified ip address | help |
--commands | List available commands | help |
-R, --human | Output human readable report | help |
-j, --json | Output json reply | help |
--compact | Output compact json reply | help |
--headers | Output HTTP headers | help |
--raw | Input is a raw file, not an email file | help |
--ucl | Output ucl reply from rspamd | help |
-n, --max-requests | Maximum count of parallel requests to rspamd | help |
--extended-urls | Output urls in extended format | help |
--key | Use specified pubkey to encrypt request | help |
-e, --exec | Execute the specified command and pass output to it | help |
-m, --mime | Write mime body of message with headers instead of just a scan's result | help |
--header | Add custom HTTP header to query (can be repeated) | help |
--metadata-header | Add custom field to v3 metadata headers as KEY=VALUE or KEY:VALUE (can be repeated) | help |
--exclude | Exclude specific glob patterns in file names (can be repeated) | help |
--sort | Sort output in a specific order (name, weight, frequency, hits) | help |
-E, --empty | Allow empty input instead of reading from stdin | help |
-S, --fuzzy-symbol | Learn the specified fuzzy symbol | help |
-z, --compressed | Enable zstd compression | help |
--profile | Profile symbols execution time | help |
-D, --dictionary | Use dictionary to compress data | help |
--skip-images | Skip images when learning/unlearning fuzzy | help |
--skip-attachments | Skip attachments when learning/unlearning fuzzy | help |
--protocol-v3 | Use v3 multipart protocol (structured metadata, multipart response) | help |
--msgpack | Use msgpack for v3 metadata and response (requires --protocol-v3) | help |
-U, --user-agent | Use specific User-Agent instead of "rspamc" | help |
--files-list | Read one or more newline separated filenames to scan from file | help |
--queue-id | Set Queue-ID header for the request | help |
--log-tag | Set Log-Tag header for the request | help |
--output-body | Save rewritten message body to file | help |
--settings | Set Settings header as JSON/UCL for the request | help |
Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.