OS Manuals

/usr/bin/rspamc

Rapid spam filtering system

From rspamd 4.2.3-r1 (os), captured 2026-11-05 by running rspamc --help (exit 0). permalink

Usage:
  rspamc [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)
OptionDescriptionSource
-?, --helpShow help optionshelp
-h, --connectSpecify host and porthelp
-P, --password passwordSpecify control password.help + man
-c, --classifier nameClassifier to learn spam or ham (bayes is used by default)help + man
-w, --weight weightWeight for fuzzy operationshelp + man
-f, --flag numberFlag for fuzzy operationshelp + man
-p, --pass-all, --passPass all filtershelp + man
-v, --verboseMore verbose outputhelp + man
-i, --ip ipEmulate that message was received from specified ip addresshelp + man
-u, --user usernameEmulate that message was received from specified authenticated userhelp + man
-d, --deliver user@domainEmulate that message was delivered to specified user (for LDA/statistics)help + man
-F, --from user@domainEmulate that message has specified SMTP FROM addresshelp + man
-r, --rcpt user@domainEmulate that message has specified SMTP RCPT addresshelp + man
--helo helo_stringImitate SMTP HELO passing from MTAhelp + man
--hostname hostnameImitate hostname passing from MTA (rspamd assumes that it is verified by MTA)help + man
-t, --timeout secondsTimeout for waiting for a reply (can be floating point number, e.g. 0.1)help + man
-b, --bind host:portBind to specified ip addresshelp + man
--commandsList available commandshelp + man
-R, --humanOutput human readable report.help + man
-j, --jsonOutput formatted JSONhelp + man
--compactOutput compact json replyhelp
--headersOutput HTTP headers from a replyhelp + man
--rawOutput raw data received from rspamd (compacted JSON)help + man
--uclOutput ucl reply from rspamdhelp + man
-n, --max-requests parallel_countMaximum number of requests to rspamd executed in parallel (8 by default)help + man
--extended-urlsOutput URLs in an extended format, showing full URL, host and the part of host that was used by surbl module (if enabled).help + man
--keyUse specified pubkey to encrypt requesthelp
-e, --exec, --execute commandExecute the specified command with either mime output (if mime option is also specified) or formatted rspamd outputhelp + man
-m, --mimeWrite mime body of message with headers instead of just a scan's resulthelp + man
--header headerAdd custom HTTP header to query (can be repeated)help + man
--metadata-headerAdd custom field to v3 metadata headers as KEY=VALUE or KEY:VALUE (can be repeated)help
--excludeExclude specific glob patterns in file names (can be repeated)help
--sort typeSort output in a specific order (name, weight, frequency, hits)help + man
-E, --emptyAllow empty input instead of reading from stdinhelp
-S, --fuzzy-symbolLearn the specified fuzzy symbolhelp
-z, --compressedEnable zstd compressionhelp
--profileProfile symbols execution timehelp
-D, --dictionaryUse dictionary to compress datahelp
--skip-imagesSkip images when learning/unlearning fuzzyhelp
--skip-attachmentsSkip attachments when learning/unlearning fuzzyhelp
--protocol-v3Use v3 multipart protocol (structured metadata, multipart response)help
--msgpackUse msgpack for v3 metadata and response (requires --protocol-v3)help
-U, --user-agentUse specific User-Agent instead of "rspamc"help
--files-listRead one or more newline separated filenames to scan from filehelp
--queue-idSet Queue-ID header for the requesthelp
--log-tagSet Log-Tag header for the requesthelp
--output-bodySave rewritten message body to filehelp
--settingsSet Settings header as JSON/UCL for the requesthelp
Exit status (1) from the manual page
0operation was successful and an error code otherwise
Examples (9) from the manual page, untested

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.